summaryrefslogtreecommitdiffstats
path: root/roles/openshift_logging/README.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2017-09-27 05:36:09 -0700
committerGitHub <noreply@github.com>2017-09-27 05:36:09 -0700
commit5afef2e7b29813760aa7b4f42013aebe16d08ec8 (patch)
treef43c5e71604493724d7a049000faec40c230b4e7 /roles/openshift_logging/README.md
parent1ab97938845c00119c3e88d58b33ae6cbd8f97fd (diff)
parent4e30a4243a6c9692c24a574ecfd83c2bcd1e2785 (diff)
downloadopenshift-5afef2e7b29813760aa7b4f42013aebe16d08ec8.tar.gz
openshift-5afef2e7b29813760aa7b4f42013aebe16d08ec8.tar.bz2
openshift-5afef2e7b29813760aa7b4f42013aebe16d08ec8.tar.xz
openshift-5afef2e7b29813760aa7b4f42013aebe16d08ec8.zip
Merge pull request #4973 from wozniakjan/logging_eventrouter
Automatic merge from submit-queue logging: introducing event router Initial concept integrating kubernetes events to EFK stack using [eventrouter](https://github.com/heptio/eventrouter) - **eventrouter** is deployed to logging project, has a service account and its own role to read events - **eventrouter** watches kubernetes events, marshalls them to JSON and outputs to its STDOUT - **fluentd** picks them up and inserts to elastic search logging project index Kubernetes events could be easily stored into different index. Among other ways, it could be achieved either by a fluentd filter plugin or custom eventrouter sink. Pending actions: - [x] - get our downstream and upstream images for eventrouter, don't use heptio's cc: @josefkarasek , @jcantrill , @richm
Diffstat (limited to 'roles/openshift_logging/README.md')
-rw-r--r--roles/openshift_logging/README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/roles/openshift_logging/README.md b/roles/openshift_logging/README.md
index de3d19858..9386da8c2 100644
--- a/roles/openshift_logging/README.md
+++ b/roles/openshift_logging/README.md
@@ -12,13 +12,13 @@ generation for Elasticsearch (it uses JKS) as well as openssl to sign certificat
As part of the installation, it is recommended that you add the Fluentd node selector label
to the list of persisted [node labels](https://docs.openshift.org/latest/install_config/install/advanced_install.html#configuring-node-host-labels).
-###Required vars:
+### Required vars:
- `openshift_logging_install_logging`: When `True` the `openshift_logging` role will install Aggregated Logging.
When `openshift_logging_install_logging` is set to `False` the `openshift_logging` role will uninstall Aggregated Logging.
-###Optional vars:
+### Optional vars:
- `openshift_logging_purge_logging`: When `openshift_logging_install_logging` is set to 'False' to trigger uninstalation and `openshift_logging_purge_logging` is set to 'True', it will completely and irreversibly remove all logging persistent data including PVC. Defaults to 'False'.
- `openshift_logging_image_prefix`: The prefix for the logging images to use. Defaults to 'docker.io/openshift/origin-'.
- `openshift_logging_curator_image_prefix`: Setting the image prefix for Curator image. Defaults to `openshift_logging_image_prefix`.
@@ -90,6 +90,12 @@ When `openshift_logging_install_logging` is set to `False` the `openshift_loggin
- `openshift_logging_es_number_of_shards`: The number of primary shards for every new index created in ES. Defaults to '1'.
- `openshift_logging_es_number_of_replicas`: The number of replica shards per primary shard for every new index. Defaults to '0'.
+- `openshift_logging_install_eventrouter`: Coupled with `openshift_logging_install_logging`. When both are 'True', eventrouter will be installed. When both are 'False', eventrouter will be uninstalled.
+Other combinations will keep the eventrouter untouched.
+
+Detailed eventrouter configuration can be found in
+- `roles/openshift_logging_eventrouter/README.md`
+
When `openshift_logging_use_ops` is `True`, there are some additional vars. These work the
same as above for their non-ops counterparts, but apply to the OPS cluster instance:
- `openshift_logging_es_ops_host`: logging-es-ops