Skip to content

Commit d6e1485

Browse files
Khuzaima05Khuzaima-Shakeel
andauthored
docs: updated prefix variable description - added note for prefix change limitation (#1147)
* updated description note for prefix behavior and upgrade limitations * updated PR * updated vsi-extension prefix des --------- Co-authored-by: Khuzaima-Shakeel <Khuzaima.Shakeel@ibm.com>
1 parent 33e6387 commit d6e1485

File tree

11 files changed

+11
-11
lines changed

11 files changed

+11
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -919,7 +919,7 @@ module "cluster_pattern" {
919919
| <a name="input_f5_vsi"></a> [f5\_vsi](#input\_f5\_vsi) | A list describing F5 VSI workloads to create | <pre>list(<br/> object({<br/> name = string<br/> vpc_name = string<br/> primary_subnet_name = string<br/> secondary_subnet_names = list(string)<br/> secondary_subnet_security_group_names = list(<br/> object({<br/> group_name = string<br/> interface_name = string<br/> })<br/> )<br/> ssh_keys = list(string)<br/> f5_image_name = string<br/> machine_type = string<br/> resource_group = optional(string)<br/> enable_management_floating_ip = optional(bool)<br/> enable_external_floating_ip = optional(bool)<br/> security_groups = optional(list(string))<br/> boot_volume_encryption_key_name = optional(string)<br/> hostname = string<br/> domain = string<br/> access_tags = optional(list(string), [])<br/> security_group = optional(<br/> object({<br/> name = string<br/> rules = list(<br/> object({<br/> name = string<br/> direction = string<br/> source = string<br/> local = optional(string)<br/> ip_version = optional(string)<br/> tcp = optional(<br/> object({<br/> port_max = number<br/> port_min = number<br/> })<br/> )<br/> udp = optional(<br/> object({<br/> port_max = number<br/> port_min = number<br/> })<br/> )<br/> icmp = optional(<br/> object({<br/> type = number<br/> code = number<br/> })<br/> )<br/> })<br/> )<br/> })<br/> )<br/> block_storage_volumes = optional(list(<br/> object({<br/> name = string<br/> profile = string<br/> capacity = optional(number)<br/> iops = optional(number)<br/> encryption_key = optional(string)<br/> })<br/> ))<br/> load_balancers = optional(list(<br/> object({<br/> name = string<br/> type = string<br/> listener_port = number<br/> listener_protocol = string<br/> connection_limit = number<br/> algorithm = string<br/> protocol = string<br/> health_delay = number<br/> health_retries = number<br/> health_timeout = number<br/> health_type = string<br/> pool_member_port = string<br/> idle_connection_timeout = optional(number)<br/> security_group = optional(<br/> object({<br/> name = string<br/> rules = list(<br/> object({<br/> name = string<br/> direction = string<br/> source = string<br/> local = optional(string)<br/> ip_version = optional(string)<br/> tcp = optional(<br/> object({<br/> port_max = number<br/> port_min = number<br/> })<br/> )<br/> udp = optional(<br/> object({<br/> port_max = number<br/> port_min = number<br/> })<br/> )<br/> icmp = optional(<br/> object({<br/> type = number<br/> code = number<br/> })<br/> )<br/> })<br/> )<br/> })<br/> )<br/> })<br/> ))<br/> })<br/> )</pre> | `[]` | no |
920920
| <a name="input_key_management"></a> [key\_management](#input\_key\_management) | Key Protect instance variables | <pre>object({<br/> name = optional(string)<br/> resource_group = optional(string)<br/> use_data = optional(bool)<br/> use_hs_crypto = optional(bool)<br/> access_tags = optional(list(string), [])<br/> service_endpoints = optional(string, "public-and-private")<br/> keys = optional(<br/> list(<br/> object({<br/> name = string<br/> root_key = optional(bool)<br/> payload = optional(string)<br/> key_ring = optional(string) # Any key_ring added will be created<br/> force_delete = optional(bool)<br/> existing_key_crn = optional(string) # CRN of an existing key in the same or different account.<br/> endpoint = optional(string) # can be public or private<br/> iv_value = optional(string) # (Optional, Forces new resource, String) Used with import tokens. The initialization vector (IV) that is generated when you encrypt a nonce. The IV value is required to decrypt the encrypted nonce value that you provide when you make a key import request to the service. To generate an IV, encrypt the nonce by running ibmcloud kp import-token encrypt-nonce. Only for imported root key.<br/> encrypted_nonce = optional(string) # The encrypted nonce value that verifies your request to import a key to Key Protect. This value must be encrypted by using the key that you want to import to the service. To retrieve a nonce, use the ibmcloud kp import-token get command. Then, encrypt the value by running ibmcloud kp import-token encrypt-nonce. Only for imported root key.<br/> policies = optional(<br/> object({<br/> rotation = optional(<br/> object({<br/> interval_month = number<br/> })<br/> )<br/> dual_auth_delete = optional(<br/> object({<br/> enabled = bool<br/> })<br/> )<br/> })<br/> )<br/> })<br/> )<br/> )<br/> })</pre> | n/a | yes |
921921
| <a name="input_network_cidr"></a> [network\_cidr](#input\_network\_cidr) | Network CIDR for the VPC. This is used to manage network ACL rules for cluster provisioning. | `string` | `"10.0.0.0/8"` | no |
922-
| <a name="input_prefix"></a> [prefix](#input\_prefix) | A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. | `string` | n/a | yes |
922+
| <a name="input_prefix"></a> [prefix](#input\_prefix) | A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. **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). | `string` | n/a | yes |
923923
| <a name="input_region"></a> [region](#input\_region) | Region where VPC will be created. To find your VPC region, use `ibmcloud is regions` command to find available regions. | `string` | n/a | yes |
924924
| <a name="input_resource_groups"></a> [resource\_groups](#input\_resource\_groups) | Object describing resource groups to create or reference | <pre>list(<br/> object({<br/> name = string<br/> create = optional(bool)<br/> use_prefix = optional(bool)<br/> })<br/> )</pre> | n/a | yes |
925925
| <a name="input_security_groups"></a> [security\_groups](#input\_security\_groups) | Security groups for VPC | <pre>list(<br/> object({<br/> name = string<br/> vpc_name = string<br/> resource_group = optional(string)<br/> access_tags = optional(list(string), [])<br/> rules = list(<br/> object({<br/> name = string<br/> direction = string<br/> source = string<br/> local = optional(string)<br/> ip_version = optional(string)<br/> tcp = optional(<br/> object({<br/> port_max = number<br/> port_min = number<br/> })<br/> )<br/> udp = optional(<br/> object({<br/> port_max = number<br/> port_min = number<br/> })<br/> )<br/> icmp = optional(<br/> object({<br/> type = number<br/> code = number<br/> })<br/> )<br/> })<br/> )<br/> })<br/> )</pre> | `[]` | no |

patterns/mixed/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ variable "ibmcloud_api_key" {
99
}
1010

1111
variable "prefix" {
12-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters."
12+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. **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)."
1313
type = string
1414

1515
validation {

patterns/roks-quickstart/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ variable "ibmcloud_api_key" {
99
}
1010

1111
variable "prefix" {
12-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters."
12+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters. **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)."
1313
type = string
1414

1515
validation {

patterns/roks/module/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##############################################################################
44

55
variable "prefix" {
6-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters."
6+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters. **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)."
77
type = string
88

99
validation {

patterns/roks/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ variable "ibmcloud_api_key" {
99
}
1010

1111
variable "prefix" {
12-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters."
12+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters. **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)."
1313
type = string
1414

1515
validation {

patterns/vpc/module/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##############################################################################
44

55
variable "prefix" {
6-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters."
6+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. **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)."
77
type = string
88

99
validation {

patterns/vpc/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ variable "ibmcloud_api_key" {
99
}
1010

1111
variable "prefix" {
12-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters."
12+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. **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)."
1313
type = string
1414

1515
validation {

patterns/vsi-quickstart/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ variable "ibmcloud_api_key" {
99
}
1010

1111
variable "prefix" {
12-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters."
12+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. **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)."
1313
type = string
1414
default = "land-zone-vsi-qs"
1515

patterns/vsi/module/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##############################################################################
44

55
variable "prefix" {
6-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters."
6+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. **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)."
77
type = string
88
validation {
99
error_message = "Prefix must begin with a lowercase letter and contain only lowercase letters, numbers, and - characters. Prefixes must end with a lowercase letter or number and be 16 or fewer characters."

patterns/vsi/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ variable "ibmcloud_api_key" {
99
}
1010

1111
variable "prefix" {
12-
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters."
12+
description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. **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)."
1313
type = string
1414
validation {
1515
error_message = "Prefix must begin with a lowercase letter and contain only lowercase letters, numbers, and - characters. Prefixes must end with a lowercase letter or number and be 16 or fewer characters."

0 commit comments

Comments
 (0)