diff --git a/docs/data-sources/env_aws.md b/docs/data-sources/env_aws.md index 8fcb683..a26f261 100644 --- a/docs/data-sources/env_aws.md +++ b/docs/data-sources/env_aws.md @@ -17,7 +17,10 @@ Bring Your Own Cloud (BYOC) AWS environment data source. ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/data-sources/env_aws_status.md b/docs/data-sources/env_aws_status.md index 0cbd97d..cf57b8f 100644 --- a/docs/data-sources/env_aws_status.md +++ b/docs/data-sources/env_aws_status.md @@ -53,7 +53,10 @@ data "altinitycloud_env_aws_status" "current" { ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/data-sources/env_azure.md b/docs/data-sources/env_azure.md index 679d3fb..462ad56 100644 --- a/docs/data-sources/env_azure.md +++ b/docs/data-sources/env_azure.md @@ -17,7 +17,10 @@ Bring Your Own Cloud (BYOC) Azure environment data source. ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/data-sources/env_azure_status.md b/docs/data-sources/env_azure_status.md index 253d29b..3ceaea6 100644 --- a/docs/data-sources/env_azure_status.md +++ b/docs/data-sources/env_azure_status.md @@ -53,7 +53,10 @@ data "altinitycloud_env_aws_status" "current" { ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/data-sources/env_gcp.md b/docs/data-sources/env_gcp.md index aede470..37ad4e0 100644 --- a/docs/data-sources/env_gcp.md +++ b/docs/data-sources/env_gcp.md @@ -17,7 +17,10 @@ Bring Your Own Cloud (BYOC) GCP environment data source. ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/data-sources/env_gcp_status.md b/docs/data-sources/env_gcp_status.md index c775f1c..23801cc 100644 --- a/docs/data-sources/env_gcp_status.md +++ b/docs/data-sources/env_gcp_status.md @@ -53,7 +53,10 @@ data "altinitycloud_env_aws_status" "current" { ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/data-sources/env_k8s.md b/docs/data-sources/env_k8s.md index 016f186..cf0b6e4 100644 --- a/docs/data-sources/env_k8s.md +++ b/docs/data-sources/env_k8s.md @@ -17,7 +17,10 @@ Bring Your Own Kubernetes (BYOK) environment data source. ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/data-sources/env_k8s_status.md b/docs/data-sources/env_k8s_status.md index 6e5935d..1c6da41 100644 --- a/docs/data-sources/env_k8s_status.md +++ b/docs/data-sources/env_k8s_status.md @@ -49,7 +49,10 @@ data "altinitycloud_env_k8s_status" "current" { ### Required -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/resources/env_aws.md b/docs/resources/env_aws.md index 71ebfc2..f56b26f 100644 --- a/docs/resources/env_aws.md +++ b/docs/resources/env_aws.md @@ -214,7 +214,10 @@ resource "aws_vpc_peering_connection_accepter" "peer" { Examples: - "10.136.0.0/21" - "172.20.0.0/21" -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/resources/env_azure.md b/docs/resources/env_azure.md index 8e4aab0..3658d98 100644 --- a/docs/resources/env_azure.md +++ b/docs/resources/env_azure.md @@ -81,7 +81,10 @@ data "altinitycloud_env_azure_status" "this" { Examples: - "10.136.0.0/21" - "172.20.0.0/21" -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/resources/env_gcp.md b/docs/resources/env_gcp.md index e1a9a3e..1ae3ea3 100644 --- a/docs/resources/env_gcp.md +++ b/docs/resources/env_gcp.md @@ -90,7 +90,10 @@ data "altinitycloud_env_gcp_status" "this" { - "10.136.0.0/21" - "172.20.0.0/21" - `gcp_project_id` (String) ID of the GCP project ([docs](https://support.google.com/googleapi/answer/7014113?hl=en#:~:text=The%20project%20ID%20is%20a,ID%20or%20create%20your%20own.)) in which to provision GCP resources. **[IMMUTABLE]** -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/docs/resources/env_k8s.md b/docs/resources/env_k8s.md index 666be4a..7772b36 100644 --- a/docs/resources/env_k8s.md +++ b/docs/resources/env_k8s.md @@ -155,7 +155,10 @@ data "altinitycloud_env_k8s_status" "this" { - "EKS" - "GKE" - "CUSTOM" -- `name` (String) A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +- `name` (String) A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name) diff --git a/internal/provider/common/docs.go b/internal/provider/common/docs.go index 04e092a..57add56 100644 --- a/internal/provider/common/docs.go +++ b/internal/provider/common/docs.go @@ -2,7 +2,10 @@ package common // Shared descriptions. const ID_DESCRIPTION = "ID of the environment (automatically generated based on the name)" -const NAME_DESCRIPTION = `A globally-unique environment identifier. All environment names must start with your account name as prefix. **[IMMUTABLE]** +const NAME_DESCRIPTION = `A globally-unique environment identifier. **[IMMUTABLE]** + + - All environment names must start with your account name as prefix. + - ⚠️ Changing environment name after creation will force a resource replacement. Examples: - "acme-staging" (where "acme" is your account name)