regions¶
regions list¶
Print the available regions to the user:
Usage: croud regions list [-h] [--region REGION]
[--output-fmt {table,wide,json,yaml}] [--sudo]
Optional Arguments¶
| --region, -r | Temporarily use the specified region that command will be run in. |
| --output-fmt, --format, -o | |
Possible choices: table, wide, json, yaml Change the formatting of the output. | |
| --sudo | Run the given command as superuser. Default: False |
Note
The region is specified for each profile in the Configuration file.
The region for specific actions can be overridden using the --region argument to list or deploy resources in that region.
Example¶
sh$ croud regions list
+--------------------------------+-----------------------+
| description | name |
|--------------------------------+-----------------------|
| Azure East US 2 | aks1.eastus2.azure |
| Azure West Europe | aks1.westeurope.azure |
| AWS West Europe (Ireland) | eks1.eu-west-1.aws |
+--------------------------------+-----------------------+
regions create¶
Creates a new Edge or Cloud region:
Usage: croud regions create [-h] [--aws-bucket AWS_BUCKET]
[--aws-region AWS_REGION] [--name NAME]
--description DESCRIPTION --provider PROVIDER
[--org-id ORG_ID] [-y] [--region REGION]
[--output-fmt {table,wide,json,yaml}] [--sudo]
Required Arguments¶
| --description | The description of the new region. |
| --provider | Either AWS, EKS or EDGE |
Optional Arguments¶
| --aws-bucket | The AWS S3 bucket where cluster backups will be stored. |
| --aws-region | The AWS region where the S3 bucket for cluster backups is expected to be. |
| --name | The domain name prefix that will be used to reach the region. A Crate domain will be added as a suffix. |
| --org-id | The organization ID to use. |
| -y, --yes | Default: False |
| --region, -r | Temporarily use the specified region that command will be run in. |
| --output-fmt, --format, -o | |
Possible choices: table, wide, json, yaml Change the formatting of the output. | |
| --sudo | Run the given command as superuser. Default: False |
Note
Only superusers can create Cloud regions. Organization admins can create Edge regions that belong to an organization.
Example¶
sh$ croud regions create --org-id 11111111-1111-1111-1111-111111111111 --description "Edge region" --provider EDGE
+---------------+---------------------------------------------------+
| description | name |
|---------------+---------------------------------------------------|
| Edge region | 2c0d0e22b0e846b2a7acdcbf092e54a3.edge.cratedb.net |
+---------------+---------------------------------------------------+
==> Success: You have successfully created a region.
To install the edge region run the following command:
$ bash <( wget -qO- https://console.cratedb-dev.cloud/edge/cratedb-cloud-edge.sh) <install-token>
regions delete¶
Deletes an existing Edge region:
Usage: croud regions delete [-h] --name NAME [-y] [--region REGION]
[--output-fmt {table,wide,json,yaml}] [--sudo]
Required Arguments¶
| --name | The name of the region that will be deleted. |
Optional Arguments¶
| -y, --yes | Default: False |
| --region, -r | Temporarily use the specified region that command will be run in. |
| --output-fmt, --format, -o | |
Possible choices: table, wide, json, yaml Change the formatting of the output. | |
| --sudo | Run the given command as superuser. Default: False |
Note
Only organization admins can delete Edge regions that belong to their organizations. Deleting a region does not imply that all the Kubernetes resources will be automatically deleted. This command only unregisters the region from Crate Cloud, in order to clean the region Kubernetes cluster the following script can be be used:
Example¶
sh$ croud regions create --name 2c0d0e22b0e846b2a7acdcbf092e54a3.edge.cratedb.net
==> Success: You have successfully deleted a region.