Browse Source

Merge pull request #7613 from SaravanaStorageNetwork/uninstall_doc

Update glusterfs README about uninstall playbook
Vadim Rutkovsky 6 years ago
parent
commit
f895041217
1 changed files with 9 additions and 0 deletions
  1. 9 0
      playbooks/openshift-glusterfs/README.md

+ 9 - 0
playbooks/openshift-glusterfs/README.md

@@ -85,6 +85,15 @@ This playbook is intended for admins who want to deploy a hosted Docker
 registry with GlusterFS backend storage on an existing OpenShift cluster. It
 has all the same requirements and behaviors as `config.yml`.
 
+## Playbook: uninstall.yml
+
+This playbook is intended to uninstall all GlusterFS related resources
+on an existing OpenShift cluster.
+It has all the same requirements and behaviors as `config.yml`.
+
+If the variable `openshift_storage_glusterfs_wipe` is set as True,
+it clears the backend data as well.
+
 ## Role: openshift_storage_glusterfs
 
 The bulk of the work is done by the `openshift_storage_glusterfs` role. This