summaryrefslogtreecommitdiffstats
path: root/roles/openshift_logging/README.md
diff options
context:
space:
mode:
authorRich Megginson <rmeggins@redhat.com>2017-07-27 09:50:03 -0600
committerRich Megginson <rmeggins@redhat.com>2017-08-01 11:12:06 -0600
commitace4a6cf7c5f9e3abea46a1811d04f4d5a03505f (patch)
tree1adeea93f394cca7d1d3e625b66c8af146993743 /roles/openshift_logging/README.md
parent1990a975c3101389631eaee925760607600a0629 (diff)
downloadopenshift-ace4a6cf7c5f9e3abea46a1811d04f4d5a03505f.tar.gz
openshift-ace4a6cf7c5f9e3abea46a1811d04f4d5a03505f.tar.bz2
openshift-ace4a6cf7c5f9e3abea46a1811d04f4d5a03505f.tar.xz
openshift-ace4a6cf7c5f9e3abea46a1811d04f4d5a03505f.zip
use mux_client_mode instead of use_mux_client
Instead of the `openshift_logging_use_mux_client` boolean parameter, use `openshift_logging_mux_client_mode` which will allow us to support different mux client use cases: The value `maximal` will cause Fluentd to perform as much of the processing as possible at the local node. This currently means all of the processing *except* for the Kubernetes metadata processing, which will be done by mux. This is the currently recommended mode to use due to current scaling issues. The value `minimal` means that Fluentd will do *no* processing at all, and send the raw logs to mux for processing. This is currently not recommended to use due to current scaling issues. Ansible will warn you if you try to use this mode. `MUX_ALLOW_EXTERNAL` is no longer needed in the mux dc. mux now always operates to process external logs. The ansible setting `openshift_logging_mux_allow_external` is still required in order to set up the mux service to accept connections from outside of the cluster.
Diffstat (limited to 'roles/openshift_logging/README.md')
-rw-r--r--roles/openshift_logging/README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/roles/openshift_logging/README.md b/roles/openshift_logging/README.md
index 97650e2ce..84ead3548 100644
--- a/roles/openshift_logging/README.md
+++ b/roles/openshift_logging/README.md
@@ -135,16 +135,23 @@ Elasticsearch OPS too, if using an OPS cluster:
secure_forward forwarder for the node agent Fluentd daemonsets running in the
cluster. This can be used to reduce the number of connections to the
OpenShift API server, by using `mux` and configuring each node Fluentd to
- send raw logs to mux and turn off the k8s metadata plugin.
+ send raw logs to mux and turn off the k8s metadata plugin. This requires the
+ use of `openshift_logging_mux_client_mode` (see below).
- `openshift_logging_mux_allow_external`: Default `False`. If this is `True`,
the `mux` service will be deployed, and it will be configured to allow
Fluentd clients running outside of the cluster to send logs using
secure_forward. This allows OpenShift logging to be used as a central
logging service for clients other than OpenShift, or other OpenShift
clusters.
-- `openshift_logging_use_mux_client`: Default `False`. If this is `True`, the
- node agent Fluentd services will be configured to send logs to the mux
- service rather than directly to Elasticsearch.
+- `openshift_logging_mux_client_mode`: Values - `minimal`, `maximal`.
+ Default is unset. Setting this value will cause the Fluentd node agent to
+ send logs to mux rather than directly to Elasticsearch. The value
+ `maximal` means that Fluentd will do as much processing as possible at the
+ node before sending the records to mux. This is the current recommended
+ way to use mux due to current scaling issues.
+ The value `minimal` means that Fluentd will do *no* processing at all, and
+ send the raw logs to mux for processing. We do not currently recommend using
+ this mode, and ansible will warn you about this.
- `openshift_logging_mux_hostname`: Default is "mux." +
`openshift_master_default_subdomain`. This is the hostname *external*_
clients will use to connect to mux, and will be used in the TLS server cert