fluentd-elasticsearch add-on: Improve README

This commit is contained in:
Arve Knudsen 2017-09-04 23:39:49 +02:00
parent 9182422b15
commit cd4fb16e16

View File

@ -8,7 +8,7 @@ is a graphical interface for viewing and querying the logs stored in
Elasticsearch. Elasticsearch.
**Note:** this addon should **not** be used as-is in production. This is **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 [Security](#security) and the [Storage](#storage) sections for more
information. information.
@ -19,9 +19,9 @@ a Deployment, but allows for maintaining state on storage volumes.
### Security ### 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` [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, `XPACK_SECURITY_ENABLED` env variable. After enabling the feature,
follow [official documentation][setupCreds] to set up credentials in follow [official documentation][setupCreds] to set up credentials in
Elasticsearch and Kibana. Don't forget to propagate those credentials also to 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 ### 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 [init container][initContainer] executing before Elasticsearch containers
themselves, in order to ensure that the kernel state variable themselves, in order to ensure that the kernel state variable
`vm.max_map_count` is at least 262144, since this is a requirement of `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 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 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. avoid Fluentd pods scheduling there.
[fluentd]: http://www.fluentd.org/ [fluentd]: http://www.fluentd.org/