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=aws.us-east-2.us-east-2a,vpc=aws-us-east-2 \
  --region-info region=aws.us-east-2.us-east-2b,vpc=aws-us-east-2 \
  --region-info region=aws.us-east-2.us-east-2c,vpc=aws-us-east-2 \
  --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
--cluster-name	Required. Name for the cluster.
--credentials	Required. Database credentials for the default user, provided as key-value pairs. Arguments: username password
--cloud-provider	Cloud provider. `AWS` (default) or `GCP`.
--cluster-type	Deployment type. `SYNCHRONOUS` or `GEO_PARTITIONED`.
--node-config	Number of vCPUs and disk size per node for the cluster, provided as key-value pairs. Arguments: num-cores - number of vCPUs per node disk-size-gb - disk size in GB per node If specified, num-cores is required, disk-size-gb is optional.
--region-info	Region details for multi-region cluster, provided as key-value pairs. Arguments: region-name - name of the region specified as cloud.region num-nodes - number of nodes for the region vpc - name of the VPC Specify one `--region-info` flag for each region in the cluster. If specified, region and num-nodes is required, vpc is optional.
--cluster-tier	Type of cluster. `Sandbox` or `Dedicated`.
--fault-tolerance	Fault tolerance for the cluster. `NONE`, `ZONE`, or `REGION`.
--database-version	Database version to use for the cluster. `Stable` or `Preview`.
--encryption-spec	customer managed key (CMK) credentials for encryption at rest, provided as key-value pairs. Arguments: cloud-provider - cloud provider (`AWS`); required aws-access-key - access key ID (AWS only); required for AWS aws-secret-key - secret access key (AWS only) If not provided, you are prompted for the secret access key. Secret access key can also be configured using the YBM_AWS_SECRET_KEY environment variable.

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, provided as key-value pairs. Arguments: cloud-provider - cloud provider (`AWS`); required aws-access-key - access key ID (AWS only); required for AWS aws-secret-key - secret access key (AWS only) If not provided, you are prompted for the secret access key. Secret access key can also be configured using the YBM_AWS_SECRET_KEY environment variable.

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-type	Deployment type. `SYNCHRONOUS` or `GEO_PARTITIONED`.
--node-config	Number of vCPUs and disk size per node for the cluster, provided as key-value pairs. Arguments: num-cores - number of vCPUs per node disk-size-gb - disk size in GB per node If specified, num-cores is required, disk-size-gb is optional.
--region-info	Region details for multi-region cluster, provided as key-value pairs. Arguments: region-name - name of the region specified as cloud.region num-nodes - number of nodes for the region vpc - name of the VPC Specify one `--region-info` flag for each region in the cluster. If specified, region and num-nodes is required, vpc is optional.
--cluster-tier	Type of cluster. `Sandbox` or `Dedicated`.
--fault-tolerance	Fault tolerance for the cluster. `NONE`, `ZONE`, or `REGION`.
--database-version	Database version to use for the cluster. `Stable` or `Preview`.