SingleStore Managed Service

create-cluster
Description

Creates a Managed Service cluster in an organization.

Usage
singlestore create-cluster --cluster-name --cluster-password --ip-ranges --region-id [FLAGS] [GLOBAL_FLAGS]
Flags

--cluster-name string - A helpful name to identify the cluster.

--cluster-password string - A password to connect to the cluster. It must contain at least 8 characters including uppercase, lowercase, and special characters.

--expires-at time - (Optional) Expiration time of the cluster in the ISO 8601 format or a duration relative to the current time. For example, "2006-01-02T15:04:05-0700", "2006-01-02", and "+3h30m". The value must be a future time. Specifying a time zone is optional but recommended. If no time zone is specified, the local time zone of the computer on which the command is run will be used. Default=“Never Expire”

-h, --help - Help information for the singlestore create-cluster command.

--ip-ranges string - A list/range of IP addresses in CIDR notation that can connect to the cluster. An empty setting "" allows all traffic, whereas range specifications such as "192.168.0.1/32" and "8.8.8.8/24,192.168.0.1/32" allow multiple IP address ranges.

--region-id UUID - regionID of the region where the cluster will be deployed. Note: To find the list of regions available, run singlestore list-regions.

--size - (Optional) Size of the cluster in decimals. For example, 0.25, 0.5, 1.0, 2.0. Note: The cluster sizes in decimals map to the sizes available on the portal as follows: S-00 represents 0.25, S-0=0.5, S-1=1.0, S-2=2.0, and so on. For more information, see Managed Service Pricing.

For information on global flags, see Global Flags.

Remarks
  • This command creates a cluster in the organization that is mapped to the API key used. If you are a member of multiple organizations, make sure to set up the API key that corresponds to the right organization, and then run this command.

  • The cluster may take some time to get up and running. To verify the cluster state, run singlestore list-clusters --cluster-id <clusterID>, where <clusterID> is output by the singlestore create-cluster command.

Output

The command outputs the following fields in JSON format.

status string - Indicates the status of the command execution, such as “success”, “fail”, or “error”. The command typically fails when the preconditions are not met. The “error” status usually indicates an API error.

data struct - If the command executes successfully, the clusterID of the new cluster created is returned. Upon failure, the reason for the command failure is returned. No data is returned if the status is “error”.

message string - This field is returned if the command status is “error”. A description of the API error is returned.

Examples

Create an S00 cluster without IP restrictions

singlestore create-cluster \
--cluster-name "demo_cluster" \
--cluster-password Passw0rd \
--region-id c74bb6a6-0f14-4d56-bc80-1d874fa277b7 \
--ip-ranges ""
****
{
"status": "success",
"data": {
"clusterID": "7ed40b5b-7fe4-4718-bbc1-2d328e8e82b7"
  }
}

Create an S1 cluster with expiration date and IP restrictions

singlestore create-cluster \
--cluster-name "sample_cluster" \
--cluster-password Passw0rd \
--region-id c74bb6a6-0f14-4d56-bc80-1d874fa277b7 \
--ip-ranges "192.168.0.1/32" \
--size 1.0 \
--expires-at 2100-01-02T15:04:05-0700

****
{
"status": "success",
"data": {
"clusterID": "9456ba80-f7ab-4397-b495-d52593bc8dbe"
  }
}