Cluster Naming Convention
The cluster name identifies your deployment throughout the installation. Your cloud provider applies it to resources such as IAM roles, security groups, subnets, and Kubernetes objects. Choose a name that follows this convention before you begin the installation.
Changing a cluster name after deployment requires rebuilding the infrastructure. Confirm the name with C3 AI Operations before you provision any resources.
Name format
A cluster name combines three parts in order: an environment prefix, a cloud indicator, and an abbreviation of your organization name.
Use stg as the environment prefix for development and QA clusters, and prd for production clusters. The cloud indicator depends on your cloud provider:
| Cloud provider | Cloud indicator | Development and QA | Production |
|---|---|---|---|
| Amazon Web Services | aws | stgawscust | prdawscust |
| Google Cloud Platform | gke | stggkecust | prdgkecust |
| Microsoft Azure | az | stgazcust | prdazcust |
In each example, cust stands in for your organization abbreviation. Choose an abbreviation short enough to keep the full name within the length limit described in the following section.
Naming rules
Your cluster name must meet all of the following requirements:
- Starts with a letter: the first character cannot be a number.
- Lowercase only: uppercase letters are not permitted.
- Letters and numbers only: use characters
athroughzand0through9. - No hyphens: the
-character is not permitted. - No diacritics: accented characters are not permitted.
- 15 characters or fewer: this limit covers the complete name, including the prefix and cloud indicator.
- Environment prefix first: begin the name with
stgorprd. - Cloud indicator second: place the cloud indicator immediately after the environment prefix.
The Terraform module validates the 15 character limit, but it does not validate the remaining rules. Check your name against every rule in this section before you run the module.
Examples
The following names satisfy every rule:
stgawscustprdawsacmestgawstest01prdawscorp
The following names are rejected, for the reasons given:
| Name | Reason |
|---|---|
stg-aws-cust | Contains hyphens |
stgaws-cust | Contains a hyphen |
StgAwsCust | Contains uppercase letters |
1stgawscust | Starts with a number |
stgazurecust | Uses an incorrect cloud indicator, which must be aws for Amazon Web Services |
awsstgcust | Places the cloud indicator before the environment prefix |
stgawscustomerlongname | Exceeds 15 characters |
To learn how the installation applies the cluster name, see the guide for your cloud provider: