summaryrefslogtreecommitdiffstats
path: root/roles/openshift_logging_eventrouter/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_eventrouter/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_eventrouter/README.md')
-rw-r--r--roles/openshift_logging_eventrouter/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/roles/openshift_logging_eventrouter/README.md b/roles/openshift_logging_eventrouter/README.md
new file mode 100644
index 000000000..da313d68b
--- /dev/null
+++ b/roles/openshift_logging_eventrouter/README.md
@@ -0,0 +1,20 @@
+Event router
+------------
+
+A pod forwarding kubernetes events to EFK aggregated logging stack.
+
+- **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 sink, currently only various formatting to STDOUT
+- **fluentd** picks them up and inserts to elasticsearch *.operations* index
+
+- `openshift_logging_install_eventrouter`: When 'True', eventrouter will be installed. When 'False', eventrouter will be uninstalled.
+
+Configuration variables:
+
+- `openshift_logging_eventrouter_image_prefix`: The prefix for the eventrouter logging image. Defaults to `openshift_logging_image_prefix`.
+- `openshift_logging_eventrouter_image_version`: The image version for the logging eventrouter. Defaults to 'latest'.
+- `openshift_logging_eventrouter_sink`: Select a sink for eventrouter, supported 'stdout' and 'glog'. Defaults to 'stdout'.
+- `openshift_logging_eventrouter_nodeselector`: A map of labels (e.g. {"node":"infra","region":"west"} to select the nodes where the pod will land.
+- `openshift_logging_eventrouter_cpu_limit`: The amount of CPU to allocate to eventrouter. Defaults to '100m'.
+- `openshift_logging_eventrouter_memory_limit`: The memory limit for eventrouter pods. Defaults to '128Mi'.
+- `openshift_logging_eventrouter_namespace`: The namespace where eventrouter is deployed. Defaults to 'default'.