From 9a75b3ef1bf5e40279acdd4368ad13683559801d Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Mon, 8 Apr 2024 16:43:26 +0530 Subject: [PATCH 1/3] Update managing_clusters.mdx --- .../docs/biganimal/release/reference/cli/managing_clusters.mdx | 1 + 1 file changed, 1 insertion(+) 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 2d1b3370376..e7d0f88720b 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -3,6 +3,7 @@ title: Managing clusters using the CLI navTitle: Managing clusters deepToC: true --- +---Add pause/resume cluster and PGD These examples show Azure as the cloud provider unless indicated otherwise. From 6f1d0322abca4e78f57c04b7528d27a7b3b861ab Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 9 Apr 2024 13:31:01 +0530 Subject: [PATCH 2/3] Added syntax and explanation for pausing and resuming a cluster and a pgd cluster --- .../getting_started/managing_cluster.mdx | 2 + .../reference/cli/managing_clusters.mdx | 58 +++++++++++++++++++ 2 files changed, 60 insertions(+) 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 015f1ecbbbd..d92837d9cd1 100644 --- a/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx +++ b/product_docs/docs/biganimal/release/getting_started/managing_cluster.mdx @@ -16,6 +16,8 @@ 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). + ### Pausing a cluster 1. Go to the [Clusters](https://portal.biganimal.com/clusters) page in the [BigAnimal portal](https://portal.biganimal.com). 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 e7d0f88720b..534c55450e8 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -298,6 +298,41 @@ 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 + +To pause a cluster, use the `cluster pause` command. The `cluster pause` command supports `flag` or `interactive` mode. The syntax for the command is: + +``` +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. + +If `id` of the cluster isn't known then use `--provider --region --name` to identify the cluster. + +-- Add example to pause a cluster using flag mode and interactive mode + +### Resuming 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: + +``` +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. + +If `id` of the cluster isn't known then use `--provider --region --name` to identify the cluster. + +-- Add example to resume a cluster using flag mode and interactive mode + + ## Managing distributed high-availability clusters @@ -496,3 +531,26 @@ 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 + +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: + +``` +biganimal pgd pause {--id} +``` + +Where `id` is a valid cluster ID. The `id` flag is mandatory. + +-- Add example to pause a pgd cluster + +### Resume a distributed high-availability cluster + +To resume a distributed high-availability cluster, use the `pgd resume` command. The `pgd resume` command supports `flag` mode only. The syntax for the command is: + +``` +biganimal pgd resume {--id} +``` + +Where, `id` is a valid cluster ID. The `id` flag is mandatory. + +-- Add example of resume pgd cluster \ No newline at end of file From 00275efe25a9fe12bd21929ba9cff242b38d1f1e Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Thu, 11 Apr 2024 17:44:08 +0530 Subject: [PATCH 3/3] Added examples --- .../reference/cli/managing_clusters.mdx | 67 +++++++++++++++++-- 1 file changed, 63 insertions(+), 4 deletions(-) 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 534c55450e8..42c6ba48740 100644 --- a/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx +++ b/product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx @@ -313,7 +313,33 @@ Where `id` is a valid cluster ID. The `id` is mandatory. If `id` of the cluster isn't known then use `--provider --region --name` to identify the cluster. --- Add example to pause a cluster using flag mode and interactive mode +Examples: + +Pausing a cluster using ID: + +``` +biganimal cluster pause --id p-c5fh47nf +``` + +Pausing a cluster using name, provider, and region: + +``` +biganimal cluster pause +--name my-cluster +--provider azure +--region eastus2 +``` + +Pausing a cluster in interactive mode: + +``` +./biganimal cluster pause +? Provider: AWS (Your Cloud Account) +? Region: AP South 1 +? Cluster Name: user1-test-tags-IA +__OUTPUT__ +Pause Cluster operation succeeded, "p-94pjd2w0ty" +``` ### Resuming a cluster @@ -330,8 +356,33 @@ Where `id` is a valid cluster ID. The `id` is mandatory. If `id` of the cluster isn't known then use `--provider --region --name` to identify the cluster. --- Add example to resume a cluster using flag mode and interactive mode +Examples: + +Resuming a cluster using ID: + +``` +biganimal cluster resume --id p-c5fh47nf +``` +Resuming a cluster using name, provider, and region: + +``` +biganimal cluster resume +--name my-cluster +--provider azure +--region eastus2 +``` + +Resuming a cluster using interactive mode: + +``` +./biganimal cluster resume +? Provider: AWS (Your Cloud Account) +? Region: AP South 1 +? Cluster Name: user1-test-tags-IA +__OUTPUT__ +Resume Cluster operation succeeded, "p-94pjd2w0ty" +``` ## Managing distributed high-availability clusters @@ -541,7 +592,11 @@ biganimal pgd pause {--id} Where `id` is a valid cluster ID. The `id` flag is mandatory. --- Add example to pause a pgd cluster +Example: + +``` +biganimal pgd pause --id p-c5fh47nf +``` ### Resume a distributed high-availability cluster @@ -553,4 +608,8 @@ biganimal pgd resume {--id} Where, `id` is a valid cluster ID. The `id` flag is mandatory. --- Add example of resume pgd cluster \ No newline at end of file +Example: + +``` +biganimal pgd resume --id p-c5fh47nf +``` \ No newline at end of file