From 19332ab65b5655b506211294fb8d715e29d38dc0 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 18 Apr 2024 13:51:14 -0400 Subject: [PATCH 1/8] Edits to BigAnimal PR5479 --- .../getting_started/managing_cluster.mdx | 4 +- .../reference/cli/managing_clusters.mdx | 52 ++++++++++--------- 2 files changed, 29 insertions(+), 27 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx b/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx index 4c4b4dd568f..8afdf613c5b 100644 --- a/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx +++ b/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx @@ -16,7 +16,7 @@ While paused, clusters aren't upgraded or patched, but upgrades are applied when After seven days, single-node and high-availability clusters automatically resume. Resuming a cluster applies any pending maintenance upgrades. Monitoring begins again. -With CLI 3.7.0 and later, you can [pause and resume cluster using CLI](../../getting_started/managing_cluster/#pausing-a-cluster). +With CLI 3.7.0 and later, you can [pause and resume a cluster using the CLI](../../reference/cli/managing_clusters/#pausing-a-cluster). You can enable in-app inbox or email notifications to get alerted when the paused cluster is or will be reactivated. For more information, see [managing notifications](../administering_cluster/notifications/#manage-notifications). @@ -37,5 +37,5 @@ You can enable in-app inbox or email notifications to get alerted when the pause 3. Confirm that you want to resume the cluster. The process might take a few minutes. When it finishes, the cluster status appears as Healthy. !!!note -A TDE enabled cluster, resumes only if the TDE key status is ready or available. Clusters are automatically paused if there is any issue with the TDE key. You need to resolve/give permissions to the key in your respective cloud region. Resume the cluster manually after resolving the issues. +A TDE-enabled cluster resumes only if the TDE key status is ready or available. Clusters are automatically paused if there is any issue with the TDE key. You need to resolve/give permissions to the key in your respective cloud region. Resume the cluster manually after resolving the issues. !!! diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index 42c6ba48740..2ed283f55c2 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -298,7 +298,7 @@ To restore a deleted cluster, use the `--from-deleted` flag in the command. You can restore a cluster in a single cluster to a primary/standby high-availability cluster and vice versa. You can restore a distributed high-availability cluster only to a cluster using the same architecture. !!! -### Pausing a cluster +### Pause a cluster To pause a cluster, use the `cluster pause` command. The `cluster pause` command supports `flag` or `interactive` mode. The syntax for the command is: @@ -306,22 +306,23 @@ To pause a cluster, use the `cluster pause` command. The `cluster pause` command biganimal cluster pause {--id | --provider --region --name} ``` -Where `id` is a valid cluster ID. The `id` is mandatory. - `provider` is a cloud provider of the cluster. - `region` is the region of the cluster. - `name` is the name of the cluster. +Where: +- `id` is a valid cluster ID. The `id` is mandatory. +- `provider` is a cloud provider of the cluster. +- `region` is the cluster region. +- `name` is the name of the cluster. -If `id` of the cluster isn't known then use `--provider --region --name` to identify the cluster. +If you don't know the `id` of the cluster, use `--provider --region --name` to identify the cluster. -Examples: +The following examples show common uses of the `cluster pause` command. -Pausing a cluster using ID: +To pausing a cluster using the ID: ``` biganimal cluster pause --id p-c5fh47nf ``` -Pausing a cluster using name, provider, and region: +To pause a cluster using name, provider, and region: ``` biganimal cluster pause @@ -330,7 +331,7 @@ biganimal cluster pause --region eastus2 ``` -Pausing a cluster in interactive mode: +To pause a cluster in interactive mode: ``` ./biganimal cluster pause @@ -341,7 +342,7 @@ __OUTPUT__ Pause Cluster operation succeeded, "p-94pjd2w0ty" ``` -### Resuming a cluster +### Resume a cluster To resume a cluster, use the `cluster resume` command. The `cluster resume` command supports `flag` and `interactive` mode. The syntax for the command is: @@ -349,22 +350,23 @@ To resume a cluster, use the `cluster resume` command. The `cluster resume` comm biganimal cluster resume {--id | --provider --region --name} ``` -Where `id` is a valid cluster ID. The `id` is mandatory. - `provider` is a cloud provider of the cluster. - `region` is the region of the cluster. - `name` is the name of the cluster. +Where: +- `id` is a valid cluster ID. The `id` is mandatory. +- `provider` is a cloud provider of the cluster. +- `region` is the cluster region. +- `name` is the name of the cluster. -If `id` of the cluster isn't known then use `--provider --region --name` to identify the cluster. +You don't know the `id` of the cluster, use `--provider --region --name` to identify the cluster. -Examples: +The following examples show common uses of the `cluster pause` command. -Resuming a cluster using ID: +To resume a cluster using the ID: ``` biganimal cluster resume --id p-c5fh47nf ``` -Resuming a cluster using name, provider, and region: +To resuming a cluster using the name, provider, and region: ``` biganimal cluster resume @@ -373,7 +375,7 @@ biganimal cluster resume --region eastus2 ``` -Resuming a cluster using interactive mode: +To resume a cluster using interactive mode: ``` ./biganimal cluster resume @@ -582,9 +584,9 @@ The `--id` and `--group-id` flags are mandatory. For example: biganimal pgd delete-group --id clusterID --group-id clusterDataGroupID ``` -### Pausing a distributed high-availability cluster +### Pause a distributed high-availability cluster -To pause a distributed high-availability cluster, use `pgd pause` command. The `pgd pause` command supports the `flag` mode only. The syntax for the command is: +To pause a distributed high-availability cluster, use the `pgd pause` command. The `pgd pause` command supports `flag` mode only. The syntax for the command is: ``` biganimal pgd pause {--id} @@ -592,7 +594,7 @@ biganimal pgd pause {--id} Where `id` is a valid cluster ID. The `id` flag is mandatory. -Example: +For example: ``` biganimal pgd pause --id p-c5fh47nf @@ -606,9 +608,9 @@ To resume a distributed high-availability cluster, use the `pgd resume` command. biganimal pgd resume {--id} ``` -Where, `id` is a valid cluster ID. The `id` flag is mandatory. +Where `id` is a valid cluster ID. The `id` flag is mandatory. -Example: +For example: ``` biganimal pgd resume --id p-c5fh47nf From ef4e21deffb4cd663528d2e1a4780eeee854d04b Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 18 Apr 2024 13:53:59 -0400 Subject: [PATCH 2/8] Update product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index 2ed283f55c2..a26371973c9 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -322,7 +322,7 @@ To pausing a cluster using the ID: biganimal cluster pause --id p-c5fh47nf ``` -To pause a cluster using name, provider, and region: +To pause a cluster using the name, provider, and region: ``` biganimal cluster pause From 296bf55c4ca4051f5942ba2dd31b2a15cdb90a97 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 18 Apr 2024 13:55:15 -0400 Subject: [PATCH 3/8] Update product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index a26371973c9..dc38327ffa0 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -356,7 +356,7 @@ Where: - `region` is the cluster region. - `name` is the name of the cluster. -You don't know the `id` of the cluster, use `--provider --region --name` to identify the cluster. +If you don't know the `id` of the cluster, use `--provider --region --name` to identify the cluster. The following examples show common uses of the `cluster pause` command. From b44d1e097cf863a23be64b548f68c9b1a7d297c7 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 18 Apr 2024 13:55:52 -0400 Subject: [PATCH 4/8] Update product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index dc38327ffa0..161bfa434f4 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -358,7 +358,7 @@ Where: If you don't know the `id` of the cluster, use `--provider --region --name` to identify the cluster. -The following examples show common uses of the `cluster pause` command. +The following examples show common uses of the `cluster resume` command. To resume a cluster using the ID: From 15e8f9375e820c069904573c907aff37ab72ac9e Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 18 Apr 2024 13:57:02 -0400 Subject: [PATCH 5/8] Update product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index 161bfa434f4..5bf59a35dc1 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -592,7 +592,7 @@ To pause a distributed high-availability cluster, use the `pgd pause` command. T biganimal pgd pause {--id} ``` -Where `id` is a valid cluster ID. The `id` flag is mandatory. +Where `id` is a valid cluster ID. The `id` is mandatory. For example: From 3ef8c72f0ed6efc6abf68d60498b705a9cc9b486 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 18 Apr 2024 13:57:33 -0400 Subject: [PATCH 6/8] Update product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index 5bf59a35dc1..0a179dd2665 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -608,7 +608,7 @@ To resume a distributed high-availability cluster, use the `pgd resume` command. biganimal pgd resume {--id} ``` -Where `id` is a valid cluster ID. The `id` flag is mandatory. +Where `id` is a valid cluster ID. The `id` is mandatory. For example: From 2d13c807e75ca106c453dd116dcf17b0a2ec8310 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 4 Jun 2024 10:21:20 +0530 Subject: [PATCH 7/8] Update product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index 0a179dd2665..15cf3952d58 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -307,7 +307,7 @@ biganimal cluster pause {--id | --provider --region --name} ``` Where: -- `id` is a valid cluster ID. The `id` is mandatory. +- `id` is a valid cluster ID. - `provider` is a cloud provider of the cluster. - `region` is the cluster region. - `name` is the name of the cluster. From 98a0839273fac25f7b5e6da146ab50da41eb1a94 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 4 Jun 2024 10:21:48 +0530 Subject: [PATCH 8/8] Update product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx index 15cf3952d58..169e7a5d852 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -351,7 +351,7 @@ biganimal cluster resume {--id | --provider --region --name} ``` Where: -- `id` is a valid cluster ID. The `id` is mandatory. +- `id` is a valid cluster ID. - `provider` is a cloud provider of the cluster. - `region` is the cluster region. - `name` is the name of the cluster.