Our CLI is the main way you manage your Datacoral stack. You can use it to find out more information about the slices we offer, to deploy a new slice, update an existing slice, or remove a slice. You can also use it to manage, create, and delete materialized views.
Install the Datacoral CLI on your computer by downloading and running the Datacoral installer. You should have received an email with the values for the
USER-KEY parameters in the command. Please contact firstname.lastname@example.org if you have not.
|TEAM-KEY||String that uniquely identifies your team|
|USER-KEY||String that uniquely identifies you in the team|
|AWS-REGION||AWS Region where your Datacoral Installation has been created|
|AWS-AVAILABILITY-ZONE||AWS Availability Zone where you Datacoral Installation has been created|
|INSTALLATION-NAME||Name of your Datacoral Installation|
|AWS-ACCOUNT-NAME||Name of your AWS Account|
The installer performs the following operations:
- sets up the right version of Node
- verifies that computer has AWS credentials already setup
- sets up local configuration that is used for creating Datacoral services in your AWS account
- installs the CLI
- authenticates the CLI with your team key and user key
curl -Lo installer.sh https://datacoral.com/datacoral-installer.sh; chmod a+x installer.sh
In the command below replace
USER-KEY with the corresponding values in the email you received.
./installer.sh --team-key TEAM-KEY --user-key USER-KEY
When you run the installer, it will ask you for the AWS Region and Availability Zone where you want your installation. In addition, you can specify a name for your AWS account and your Datacoral Installation. See below for details about each.
Supported AWS Regions and Zones
You'll be asked to input your region and availability zone. We support the following regions and zones because they contain all of the resources your installation will need. Pick the ones that are closest to you:
|us-west-2||us-west-2a, us-west-2b, us-west-2c|
|us-east-1||us-east-1a, us-east-1b, us-east-1c, us-east-1d, us-east-1e, us-east-1f|
|eu-west-1||eu-west-1a, eu-west-1b, eu-west-1c|
Account name and installation name
You can specify these if you'd like, or leave them be. If you do change either one, keep to lowercase alphanumeric characters, starting with a letter.
Once you have installed the CLI, continue to creating your Datacoral Installation.
If you already have an active installation, you can confirm that your CLI is working properly by running the following command:
datacoral collect list-slice-types