Skip to content

Commit

Permalink
Merge pull request #5517 from EnterpriseDB/docs/edits_to_big_animal_p…
Browse files Browse the repository at this point in the history
…r5479

Edits to BigAnimal PR5479
  • Loading branch information
nidhibhammar authored Jun 4, 2024
2 parents a446b6a + 98a0839 commit 73b1344
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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.
!!!
Original file line number Diff line number Diff line change
Expand Up @@ -298,30 +298,31 @@ 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:

```
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.
- `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 the name, provider, and region:

```
biganimal cluster pause
Expand All @@ -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
Expand All @@ -341,30 +342,31 @@ __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:

```
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.
- `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 resume` 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
Expand All @@ -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
Expand Down Expand Up @@ -582,17 +584,17 @@ 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}
```

Where `id` is a valid cluster ID. The `id` flag is mandatory.
Where `id` is a valid cluster ID. The `id` is mandatory.

Example:
For example:

```
biganimal pgd pause --id p-c5fh47nf
Expand All @@ -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` is mandatory.

Example:
For example:

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

0 comments on commit 73b1344

Please sign in to comment.