diff --git a/cluster/addons/fluentd-elasticsearch/README.md b/cluster/addons/fluentd-elasticsearch/README.md index 59cc5ddfe99..ed012ac1fef 100644 --- a/cluster/addons/fluentd-elasticsearch/README.md +++ b/cluster/addons/fluentd-elasticsearch/README.md @@ -8,7 +8,7 @@ is a graphical interface for viewing and querying the logs stored in Elasticsearch. **Note:** this addon should **not** be used as-is in production. This is -an example and you should treat is as such. Please see at least the +an example and you should treat it as such. Please see at least the [Security](#security) and the [Storage](#storage) sections for more information. @@ -19,9 +19,9 @@ a Deployment, but allows for maintaining state on storage volumes. ### Security -Elasticsearch has capabilities to enable authorization using +Elasticsearch has capabilities to enable authorization using the [X-Pack plugin][xPack]. See configuration parameter `xpack.security.enabled` -in Elasticsearch and Kibana configurations. It can also be set via +in Elasticsearch and Kibana configurations. It can also be set via the `XPACK_SECURITY_ENABLED` env variable. After enabling the feature, follow [official documentation][setupCreds] to set up credentials in Elasticsearch and Kibana. Don't forget to propagate those credentials also to @@ -31,7 +31,7 @@ and [Secrets][secret] to store credentials in the Kubernetes apiserver. ### Initialization -The Elasticsearch Statefulset manifest specifies that there shall be an +The Elasticsearch StatefulSet manifest specifies that there shall be an [init container][initContainer] executing before Elasticsearch containers themselves, in order to ensure that the kernel state variable `vm.max_map_count` is at least 262144, since this is a requirement of @@ -61,7 +61,7 @@ Learn more in the [official Kubernetes documentation][k8sElasticsearchDocs]. Since Fluentd talks to the Elasticsearch service inside the cluster, instances on masters won't work, because masters have no kube-proxy. Don't mark masters -with a label mentioned in the previous paragraph or add a taint on them to +with the label mentioned in the previous paragraph or add a taint on them to avoid Fluentd pods scheduling there. [fluentd]: http://www.fluentd.org/