Skip to content

Commit

Permalink
docs: add env force-replacement warning
Browse files Browse the repository at this point in the history
  • Loading branch information
ianaya89 committed Sep 2, 2024
1 parent af8b32f commit 4a6c731
Show file tree
Hide file tree
Showing 13 changed files with 52 additions and 13 deletions.
5 changes: 4 additions & 1 deletion docs/data-sources/env_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/env_aws_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/env_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/env_azure_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/env_gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/env_gcp_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/env_k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/env_k8s_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/resources/env_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/resources/env_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/resources/env_gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion docs/resources/env_k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 4 additions & 1 deletion internal/provider/common/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 4a6c731

Please sign in to comment.