From 0e86a5a0c42d16948f2ae77e639b5fb49b7bdc0d Mon Sep 17 00:00:00 2001 From: Takashi IIGUNI Date: Fri, 7 Aug 2020 08:14:51 +0000 Subject: [PATCH] docs: fix clean policy confirmation of ceph-cluster-crd Make the document of cleanup policy clearer. Signed-off-by: Takashi IIGUNI --- Documentation/ceph-cluster-crd.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/ceph-cluster-crd.md b/Documentation/ceph-cluster-crd.md index a1339ac2b..665d414f2 100755 --- a/Documentation/ceph-cluster-crd.md +++ b/Documentation/ceph-cluster-crd.md @@ -1075,15 +1075,15 @@ spec: ### Cleanup policy -Rook has the ability to cleanup resources and data that were deployed. +Rook has the ability to cleanup resources and data that were deployed when a `delete cephcluster` command is issued. The policy represents the confirmation that cluster data should be forcibly deleted. The cleanupPolicy should only be added to the cluster when the cluster is about to be deleted. After the `confirmation` field of the cleanup policy is set, Rook will stop configuring the cluster as if the cluster is about to be destroyed in order to prevent these settings from being deployed unintentionally. The `cleanupPolicy` CR settings has different fields: -* `confirmation`: If `yes-really-destroy-data` the operator will automatically delete data on the hostpath of cluster nodes and clean devices with OSDs when a `delete cephcluster` command is issued. Only `yes-really-destroy-data` and an empty string are valid values for this field. +* `confirmation`: Only an empty string and `yes-really-destroy-data` are valid values for this field. If an empty string is set, Rook will only remove Ceph's metadata. A re-installation will not be possible unless the hosts are cleaned first. If `yes-really-destroy-data` the operator will automatically delete data on the hostpath of cluster nodes and clean devices with OSDs. The cluster can then be re-installed if desired with no further steps. * `sanitizeDisks`: sanitizeDisks represents advanced settings that can be used to sanitize drives. -By default if the `confirmation` is set, Rook will only remove Ceph's metadata, which allows a cluster re-installation if desired. +This field only affects if `confirmation` is set to `yes-really-destroy-data`. However, the administrator might want to sanitize the drives in more depth with the following flags: * `method`: indicates if the entire disk should be sanitized or simply ceph's metadata. Possible choices are 'quick' (default) or 'complete' * `dataSource`: indicate where to get random bytes from to write on the disk. Possible choices are 'zero' (default) or 'random'.