documentation-refactoring, two factor delete fix

instaclustr · Nov 28, 2023 · 64d2342 · 64d2342
1 parent 5c87d8c
commit 64d2342
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 85 deletions.
diff --git a/doc/clusters/cadence.md b/doc/clusters/cadence.md
@@ -265,18 +265,15 @@ To delete cluster run:
 kubectl delete cadences.clusters.instaclustr.com cadence-sample
 ```
 
+### Cluster deletion with twoFactorDelete option enabled
+To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion).
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`.
+When deletion is confirmed via email, Instaclustr support will delete the cluster.
 It can take some time to delete the resource.
 
-### Cluster deletion with twoFactorDelete option enabled
-To delete cluster with twoFactorDelete option enabled you need to set the confirmation annotation to true:
-```yaml
-Annotations:  
-  "instaclustr.com/deletionConfirmed": true
-```
+If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:
 
-And then simply run:
-```console
-kubectl delete cadences.clusters.instaclustr.com cadence-sample
+```yaml
+Annotations:
+  "instaclustr.com/clusterDeletion": ""
 ```
-
-After that, deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `TwoFactorDelete`. When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resources inside K8s will be also removed.
diff --git a/doc/clusters/cassandra.md b/doc/clusters/cassandra.md
@@ -154,22 +154,19 @@ To delete cluster run:
 kubectl delete cassandras.clusters.instaclustr.com cassandra-sample
 ```
 
+### Cluster deletion with twoFactorDelete option enabled
+To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion).
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`.
+When deletion is confirmed via email, Instaclustr support will delete the cluster.
 It can take some time to delete the resource.
 
-### Cluster deletion with twoFactorDelete option enabled
-To delete cluster with twoFactorDelete option enabled you need to set the confirmation annotation to true:
-```yaml
-Annotations:  
-  "instaclustr.com/deletionConfirmed": true
-```
+If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:
 
-And then simply run:
-```console
-kubectl delete cassandras.clusters.instaclustr.com cassandra-sample
+```yaml
+Annotations:
+  "instaclustr.com/clusterDeletion": ""
 ```
 
-After that, deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `TwoFactorDelete`. When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resources inside K8s will be also removed.
-
 ## Cluster restore flow
 To restore a Cassandra cluster instance from an existing one you need to prepare the yaml manifest. Here is an example:
 ```yaml

diff --git a/doc/clusters/kafka-connect.md b/doc/clusters/kafka-connect.md
@@ -174,8 +174,8 @@ kubectl delete kafkaconnects.clusters.instaclustr.com kafkaconnect-sample
 
 ### Cluster deletion with twoFactorDelete option enabled
 To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion). 
-After that, a deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`. 
-When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resources inside K8s will be also removed. 
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`. 
+When deletion is confirmed via email, Instaclustr support will delete the cluster. 
 It can take some time to delete the resource.
 
 If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:

diff --git a/doc/clusters/kafka.md b/doc/clusters/kafka.md
@@ -210,18 +210,15 @@ To delete cluster run:
 kubectl delete kafkas.clusters.instaclustr.com kafka-sample
 ```
 
+### Cluster deletion with twoFactorDelete option enabled
+To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion).
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`.
+When deletion is confirmed via email, Instaclustr support will delete the cluster.
 It can take some time to delete the resource.
 
-### Cluster deletion with twoFactorDelete option enabled
-To delete cluster with twoFactorDelete option enabled you need to set the confirmation annotation to true:
-```yaml
-Annotations:  
-  "instaclustr.com/deletionConfirmed": true
-```
+If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:
 
-And then simply run:
-```console
-kubectl delete kafkas.clusters.instaclustr.com kafka-sample
+```yaml
+Annotations:
+  "instaclustr.com/clusterDeletion": ""
 ```
-
-After that, deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `TwoFactorDelete`. When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resources inside K8s will be also removed.
diff --git a/doc/clusters/opensearch.md b/doc/clusters/opensearch.md
@@ -191,32 +191,27 @@ To update a cluster you can apply an updated cluster manifest or edit the custom
     ```
 You can only update fields that are **mutable**
 
-## Cluster deletion example
+## Cluster delete flow
 
 ### Cluster deletion
-
 To delete cluster run:
 ```console
 kubectl delete opensearches.clusters.instaclustr.com opensearch-sample
 ```
 
-It can take some time to delete all related resources and cluster itself.
-
 ### Cluster deletion with twoFactorDelete option enabled
+To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion).
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`.
+When deletion is confirmed via email, Instaclustr support will delete the cluster.
+It can take some time to delete the resource.
 
-To delete cluster with twoFactorDelete option enabled you need to set the confirmation annotation to true:
-```yaml
-Annotations:  
-  "instaclustr.com/deletionConfirmed": true
-```
+If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:
 
-And then run:
-```console
-kubectl delete opensearches.clusters.instaclustr.com opensearch-sample
+```yaml
+Annotations:
+  "instaclustr.com/clusterDeletion": ""
 ```
 
-After that deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `TwoFactorDelete`. When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resource in kubernetes will be removed soon.
-
 ## Cluster restore example
 
 To restore a OpenSearch cluster instance from an existing one you need to prepare the yaml manifest. Here is an example:

diff --git a/doc/clusters/postgresql.md b/doc/clusters/postgresql.md
@@ -160,32 +160,27 @@ To update a cluster you can apply an updated cluster manifest or edit the custom
     ```
 You can only update fields that are **mutable**
 
-## Cluster deletion example
+## Cluster delete flow
 
 ### Cluster deletion
-
 To delete cluster run:
 ```console
 kubectl delete postgresqls.clusters.instaclustr.com postgresql-sample
 ```
 
-It can take some time to delete all related resources and cluster itself.
-
 ### Cluster deletion with twoFactorDelete option enabled
+To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion).
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`.
+When deletion is confirmed via email, Instaclustr support will delete the cluster.
+It can take some time to delete the resource.
 
-To delete cluster with twoFactorDelete option enabled you need to set the confirmation annotation to true: 
-```yaml
-Annotations:  
-  "instaclustr.com/deletionConfirmed": true
-```
+If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:
 
-And then run:
-```console
-kubectl delete postgresqls.clusters.instaclustr.com postgresql-sample
+```yaml
+Annotations:
+  "instaclustr.com/clusterDeletion": ""
 ```
 
-After that deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `TwoFactorDelete`. When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resource in kubernetes will be removed soon.
-
 ## Update Default User Password
 
 Default user password is stored in a kubernetes secret. It is created before cluster creation. It has name template `default-user-password-<resource-name>`<br />

diff --git a/doc/clusters/redis.md b/doc/clusters/redis.md
@@ -152,22 +152,19 @@ To delete cluster run:
 kubectl delete redis.clusters.instaclustr.com redis-sample
 ```
 
+### Cluster deletion with twoFactorDelete option enabled
+To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion).
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`.
+When deletion is confirmed via email, Instaclustr support will delete the cluster.
 It can take some time to delete the resource.
 
-### Cluster deletion with twoFactorDelete option enabled
-To delete cluster with twoFactorDelete option enabled you need to set the confirmation annotation to true:
-```yaml
-Annotations:  
-  "instaclustr.com/deletionConfirmed": true
-```
+If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:
 
-And then simply run:
-```console
-kubectl delete redis.clusters.instaclustr.com redis-sample
+```yaml
+Annotations:
+  "instaclustr.com/clusterDeletion": ""
 ```
 
-After that, deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `TwoFactorDelete`. When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resources inside K8s will be also removed.
-
 ## Cluster restore flow
 To restore a Redis cluster instance from an existing one you need to prepare the yaml manifest. Here is an example:
 ```yaml

diff --git a/doc/clusters/zookeeper.md b/doc/clusters/zookeeper.md
@@ -88,25 +88,24 @@ To do this, the public IP address of your machine must be added to the Firewall
 ![Firewall Rules icon](../images/firewall_rules_screen.png "Firewall Rules icon")
 Then, you can use the service name instead of public addresses and port.
 
+## Cluster delete flow
+
 ### Cluster deletion
 To delete cluster run:
 ```console
 kubectl delete zookeepers.clusters.instaclustr.com zookeeper-sample
 ```
 
+### Cluster deletion with twoFactorDelete option enabled
+To delete a cluster with the `twoFactorDelete` option enabled you need to do the simple [cluster deletion flow ](#cluster-deletion).
+After that, a deletion email will be sent to the email defined in the `confirmationEmail` field of `twoFactorDelete`.
+When deletion is confirmed via email, Instaclustr support will delete the cluster.
 It can take some time to delete the resource.
 
-### Cluster deletion with twoFactorDelete option enabled
-To delete cluster with twoFactorDelete option enabled you need to set the confirmation annotation to true:
-```yaml
-Annotations:  
-  "instaclustr.com/deletionConfirmed": true
-```
+If you cancel cluster deletion and want to put cluster on delete again, remove `triggered` from `clusterDeletionAnnotation` annotation like this:
 
-And then simply run:
-```console
-kubectl delete zookeepers.clusters.instaclustr.com zookeeper-sample
+```yaml
+Annotations:
+  "instaclustr.com/clusterDeletion": ""
 ```
 
-After that, deletion confirmation email will be sent to the email defined in the `confirmationEmail` field of `TwoFactorDelete`. When deletion is confirmed via email, Instaclustr support will delete the cluster and the related cluster resources inside K8s will be also removed.
-