ybm cluster
Manage clusters
Use the cluster
resource to perform operations on a YugabyteDB Managed cluster, including the following:
- create, update, and delete clusters
- pause and resume clusters
- get information about clusters
- download the cluster certificate
- encrypt clusters and manage encryption
Syntax
Usage: ybm cluster [command] [flags]
Examples
Create a local single-node cluster:
ybm cluster create \
--cluster-name test-cluster \
--credentials username=admin,password=password123
Create a multi-node cluster:
ybm cluster create \
--cluster-name test-cluster \
--credentials username=admin,password=password123 \
--cloud-provider AWS \
--node-config num-cores=2,disk-size-gb=500 \
--region-info region=ap-northeast-1,num-nodes=1 \
--region-info region=us-west-1,num-nodes=1 \
--region-info region=us-west-2,num-nodes=1 \
--fault-tolerance=ZONE
Commands
cert download
Download the cluster certificate to a specified location.
Flag | Description |
---|---|
--force | Overwrite the output file if it exists. |
--out | Full path with file name of the location to which to download the cluster certificate file. Default is stdout . |
create
Create a cluster.
Flag | Description |
---|---|
--cloud-provider | Cloud provider. AWS (default) or GCP . |
--cluster-name | Required. Name for the cluster. |
--cluster-tier | Type of cluster. Sandbox or Dedicated . |
--cluster-type | Deployment type. SYNCHRONOUS or GEO_PARTITIONED . |
--credentials | Required. Database credentials for the default user, provided as key-value pairs. Arguments:
|
‑‑database‑version | Database version to use for the cluster. Innovation , Production , or Preview . |
--default-region | The primary region in a partition-by-region cluster. The primary region is where all the tables not created in a tablespace reside. |
--encryption-spec | CMK credentials for encryption at rest, provided as key-value pairs. Arguments:
Required for GCP only:
|
--fault-tolerance | Fault tolerance for the cluster. NONE , NODE , ZONE , or REGION . |
--node-config | Number of vCPUs, disk size, and IOPS per node for the cluster, provided as key-value pairs. Arguments:
|
--num-faults-to-tolerate | The number of faults to tolerate. 0 for NONE; 1 for ZONE; 1, 2, or 3 for NODE and REGION. Default is 1 (or 0 for NONE). |
--preferred-region | The preferred region in a multi-region cluster. Specify the name of the region. |
--region-info | Region details for multi-region cluster, provided as key-value pairs. Arguments:
--region-info flag for each region in the cluster.If specified, region and num-nodes is required, vpc is optional. |
delete
Delete the specified cluster.
Flag | Description |
---|---|
--cluster-name | Name of the cluster. |
describe
Fetch detailed information about the specified cluster.
Flag | Description |
---|---|
--cluster-name | Name of the cluster. |
encryption list
List the encryption at rest configuration for the specified cluster.
Flag | Description |
---|---|
--cluster-name | Required. The name of the cluster. |
encryption update
Update the credentials to use for the customer managed key (CMK) used to encrypt the specified cluster.
Flag | Description |
---|---|
--cluster-name | Required. Name of the cluster. |
‑‑encryption‑spec | CMK credentials for encryption at rest, provided as key-value pairs. Arguments:
Required for GCP only:
|
list
List all the clusters to which you have access.
Flag | Description |
---|---|
--cluster-name | The name of the cluster to filter. |
network
Refer to cluster network.
node list
List all the nodes in the specified cluster.
Flag | Description |
---|---|
--cluster-name | Required. The name of the cluster to list nodes for. |
pause
Pause the specified cluster.
Flag | Description |
---|---|
--cluster-name | Required. Name of the cluster to pause. |
read-replica
Refer to cluster read-replica.
resume
Resume the specified cluster.
Flag | Description |
---|---|
--cluster-name | Required. Name of the cluster to resume. |
update
Update the specified cluster.
Flag | Description |
---|---|
--cluster-name | Required. Name of the cluster to update. |
--cloud-provider | Cloud provider. AWS or GCP . |
--cluster-tier | Type of cluster. Sandbox or Dedicated . |
--cluster-type | Deployment type. SYNCHRONOUS or GEO_PARTITIONED . |
--database-version | Database version to use for the cluster. Stable or Preview . |
--fault-tolerance | Fault tolerance for the cluster. NONE , NODE , ZONE , or REGION . |
--new-name | The new name for the cluster. |
--node-config | Number of vCPUs and disk size per node for the cluster, provided as key-value pairs. Arguments:
|
--region-info | Region details for multi-region cluster, provided as key-value pairs. Arguments:
--region-info flag for each region in the cluster.If specified, region and num-nodes is required, vpc is optional. |