summaryrefslogtreecommitdiffstats
path: root/roles/openshift_logging/README.md
diff options
context:
space:
mode:
authorJan Wozniak <jwozniak@redhat.com>2017-08-01 15:24:41 +0200
committerJan Wozniak <jwozniak@redhat.com>2017-09-26 10:50:15 +0200
commit4e30a4243a6c9692c24a574ecfd83c2bcd1e2785 (patch)
treecd85ead0fd1390f134ab9b936b8317c634a600e4 /roles/openshift_logging/README.md
parent0b84e0d47b5912afb6db4f1964cbb06defcab09f (diff)
downloadopenshift-4e30a4243a6c9692c24a574ecfd83c2bcd1e2785.tar.gz
openshift-4e30a4243a6c9692c24a574ecfd83c2bcd1e2785.tar.bz2
openshift-4e30a4243a6c9692c24a574ecfd83c2bcd1e2785.tar.xz
openshift-4e30a4243a6c9692c24a574ecfd83c2bcd1e2785.zip
logging: introducing event router
- eventrouter has its own role 'openshift_logging_eventrouter' written as a template - 'openshift_logging_install_eventrouter' controls whether it gets included in the playbook or not - deployed by default to 'default' namespace
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 f283261c4..da5631d1e 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`.
@@ -91,6 +91,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