diff --git a/docs/docs/get-started/quickstart.md b/docs/docs/get-started/quickstart.md index 6f9af76d0..2b9346d09 100644 --- a/docs/docs/get-started/quickstart.md +++ b/docs/docs/get-started/quickstart.md @@ -89,6 +89,18 @@ nebari init --guided-init **Or**, if you know the initialization requirements and have set up the environment variables, you can directly run the `nebari init` command with the necessary flags. +:::caution Project naming conventions + +In order to successfully deploy Nebari, there are some project naming conventions which need to be followed. Below we summarize the format requirements for the most common cloud providers: + +- Letters from A to Z (upper and lower case) and numbers are allowed; +- Special characters are **NOT** allowed; +- Maximum accepted length of the name string is 16 characters; +- If using AWS names **SHOULD NOT** start with the string `aws`. + +Each cloud provider has its own naming conventions which in some cases may be more restrictive or less restrictive than the ones listed above. For more information, refer to the `Initializing Nebari` section in the "How to Deploy ..." documentation for your chosen cloud provider. +::: + diff --git a/docs/docs/how-tos/nebari-aws.md b/docs/docs/how-tos/nebari-aws.md index a616d6e22..a573470f0 100644 --- a/docs/docs/how-tos/nebari-aws.md +++ b/docs/docs/how-tos/nebari-aws.md @@ -101,6 +101,18 @@ installation, please visit the "Get started" section of our [troubleshooting pag Great, you’ve gone through the [Nebari installation](get-started/installing-nebari.md) and [authentication setup](#authentication) steps, and have ensured that all the necessary environment variables have been properly set. +:::warning Important + +In the following steps you will be asked to provide a name for your project. This name will be used to generate the name of the infrastructure components that will be created in +your AWS account. This name must comply with the following rules: + +- Must be between 3-47 characters in length; +- Must begin with an alphanumeric character, and must only contain alphanumeric lowercase characters, dashes, and underscores; +- The name cannot start with `AWS` or `aws`. + +Those rules are enforced by the AWS Terraform Provider and are not configurable. +::: + In this step, you'll run `nebari init` to create the `nebari-config.yaml` file. 1. In your terminal, start by creating a new project folder. For this demonstration, we will name the new folder `nebari-aws`: diff --git a/docs/docs/how-tos/nebari-azure.md b/docs/docs/how-tos/nebari-azure.md index 6cbc06fa4..897eb0a8e 100644 --- a/docs/docs/how-tos/nebari-azure.md +++ b/docs/docs/how-tos/nebari-azure.md @@ -84,6 +84,18 @@ installation, please visit the "Get started" section of our [troubleshooting pag Great, you’ve gone through the [Nebari Installation][nebari-install] and [authentication setup](#authentication) steps, and have ensured that all the necessary environment variables have been properly set. +:::warning Important + +In the following steps you will be asked to provide a name for your project. This name will be used to generate the name of the infrastructure components that will be created in +your Azure account. This name must comply with the following rules: + +- Between 3 and 16 characters long; +- Start and end with alphanumeric; +- Must use lowercase alphabets. + +Those rules are enforced by Azure and are not configurable. For more information refer to [Azure's official documentation](https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). +::: + In this step, you'll run `nebari init` to create the `nebari-config.yaml` file. 1. In your terminal, start by creating a new project folder. For this demonstration, we will name the new folder `nebari-azure`: diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index 95548317a..156089db1 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -122,6 +122,18 @@ guidance. Great, you’ve gone through the [Nebari Installation][nebari-install] and [authentication setup](#authentication) steps, and have ensured that all the necessary environment variables have been properly set. +:::warning Important + +In the following steps you will be asked to provide a name for your project. This name will be used to generate the name of the infrastructure components that will be created in +your GCP account. This name must comply with the following rules: + +- Be 1-63 characters in length; +- Comply with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) conventions; +- The first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen. + +Those rules are enforced by GCP terraform provider and are not configurable. +::: + In this step, you'll run `nebari init` to create the `nebari-config.yaml` file. 1. In your terminal, start by creating a new project folder. For this demonstration, we will name the new folder `nebari-gcp`: