Skip to content

Commit

Permalink
Merge pull request #5479 from EnterpriseDB/content/docs/biganimal/CLI…
Browse files Browse the repository at this point in the history
…_3.7.0

BigAnimal - Add CLI 3.7.0
  • Loading branch information
nidhibhammar authored Apr 17, 2024
2 parents e204177 + 00275ef commit 26a5848
Show file tree
Hide file tree
Showing 2 changed files with 120 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -297,6 +298,92 @@ 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.

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

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.

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

Expand Down Expand Up @@ -495,3 +582,34 @@ 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.

Example:

```
biganimal pgd pause --id p-c5fh47nf
```

### 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.

Example:

```
biganimal pgd resume --id p-c5fh47nf
```

1 comment on commit 26a5848

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.