Skip to content

Commit 6f0ec8c

Browse files
Khuzaima05Khuzaima-Shakeelmaheshwarishikha
authored
docs: updated prefix variable description - add a note for prefix change limitation (#944)
* updated description note for prefix behavior and upgrade limitations * updated prefix description * fix precommit * update prefix description for fully-configurable DA * update prefix description for quickstart DA --------- Co-authored-by: Khuzaima-Shakeel <Khuzaima.Shakeel@ibm.com> Co-authored-by: Shikha Maheshwari <maheshwari.shikha@gmail.com>
1 parent e84aeb6 commit 6f0ec8c

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

solutions/fully-configurable/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ variable "ibmcloud_api_key" {
1414
variable "prefix" {
1515
type = string
1616
nullable = true
17-
description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To skip using a prefix, set this value to null or an empty string. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)."
17+
description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To skip using a prefix, set this value to null or an empty string. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md). **Important:** When deploying VPC using VPC deployable architecture, updating the prefix after the initial deployment may require recreating certain resources. Learn more about this limitation [here](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-known-issues#ki-vpc-prefix-change-recreate)."
1818

1919
validation {
2020
# - null and empty string is allowed

solutions/quickstart/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ variable "provider_visibility" {
2424

2525
variable "prefix" {
2626
type = string
27-
description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To skip using a prefix, set this value to null or an empty string. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)."
27+
description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To skip using a prefix, set this value to null or an empty string. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md). **Important:** Updating the prefix after the initial deployment may require recreating certain resources. Learn more about this limitation [here](https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-known-issues#ki-vpc-prefix-change-recreate). "
2828
nullable = true
2929
validation {
3030
condition = (var.prefix == null || var.prefix == "" ? true :

0 commit comments

Comments
 (0)