summaryrefslogtreecommitdiffstats
path: root/roles/openshift_logging/README.md
diff options
context:
space:
mode:
authorJan Wozniak <jwozniak@redhat.com>2017-08-23 15:22:06 +0200
committerJan Wozniak <jwozniak@redhat.com>2017-08-24 15:07:35 +0200
commit51a2d9dbadea02f22168629d44ff339b3c45d6d1 (patch)
treec2d4979d1ee5a0d7ddd29dec9a949f75a2ece786 /roles/openshift_logging/README.md
parent4811a6247a37362e3722a4c18a2053343e7a555b (diff)
downloadopenshift-51a2d9dbadea02f22168629d44ff339b3c45d6d1.tar.gz
openshift-51a2d9dbadea02f22168629d44ff339b3c45d6d1.tar.bz2
openshift-51a2d9dbadea02f22168629d44ff339b3c45d6d1.tar.xz
openshift-51a2d9dbadea02f22168629d44ff339b3c45d6d1.zip
Bug 1467265 - logging: add 'purge' option with uninstall
The common uninstall would keep PVC around to prevent unwanted data loss during reinstalls. There is a scenario where the user may want complete removal of EFK stack including PVC. This change adds an optional `openshift_logging_purge_logging` variable to completely remove the EFK stack. By default, this is set to 'False' and only works if user sets `openshift_logging_install_logging` to 'False' to initiate the uninstallation process.
Diffstat (limited to 'roles/openshift_logging/README.md')
-rw-r--r--roles/openshift_logging/README.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/roles/openshift_logging/README.md b/roles/openshift_logging/README.md
index 84ead3548..6691f5c55 100644
--- a/roles/openshift_logging/README.md
+++ b/roles/openshift_logging/README.md
@@ -15,12 +15,11 @@ to the list of persisted [node labels](https://docs.openshift.org/latest/install
###Required vars:
- `openshift_logging_install_logging`: When `True` the `openshift_logging` role will install Aggregated Logging.
-- `openshift_logging_upgrade_logging`: When `True` the `openshift_logging` role will upgrade Aggregated Logging.
-When both `openshift_logging_install_logging` and `openshift_logging_upgrade_logging` are `False` the `openshift_logging` role will uninstall Aggregated Logging.
+When `openshift_logging_install_logging` is set to `False` the `openshift_logging` role will uninstall Aggregated Logging.
###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_image_version`: The image version for the logging images to use. Defaults to 'latest'.
- `openshift_logging_use_ops`: If 'True', set up a second ES and Kibana cluster for infrastructure logs. Defaults to 'False'.