ncc: add descriptions for preset_topology and policy_mode

Author: paulwilljones

examples/network_connectivity_center/main.tf

@@ -18,6 +18,7 @@ module "network_connectivity_center" {
   source  = "terraform-google-modules/network/google//modules/network-connectivity-center"
   version = "~> 13.0"
 
+
   project_id   = var.project_id
   ncc_hub_name = var.ncc_hub_name
   ncc_hub_labels = {

examples/network_connectivity_center/versions.tf

@@ -28,8 +28,8 @@ An extensive example that also contains the creation and attachment of multiple
 | ncc\_hub\_description | The description of the NCC Hub | `string` | `null` | no |
 | ncc\_hub\_labels | These labels will be added the NCC hub | `map(string)` | `{}` | no |
 | ncc\_hub\_name | The Name of the NCC Hub | `string` | n/a | yes |
-| ncc\_hub\_policy\_mode | The policy mode of the hub | `string` | `"PRESET"` | no |
-| ncc\_hub\_preset\_topology | The topology implemented in the hub | `string` | `null` | no |
+| ncc\_hub\_policy\_mode | The policy mode of the hub. Type must be one of `PRESET` or `CUSTOM`. | `string` | `"PRESET"` | no |
+| ncc\_hub\_preset\_topology | The topology implemented in the hub. Type must be one of `STAR` or `MESH`. | `string` | `null` | no |
 | project\_id | Project ID of the project that holds the network. | `string` | n/a | yes |
 | router\_appliance\_spokes | Router appliance instances that are associated with the spoke. | <pre>map(object({<br>    instances = set(object({<br>      virtual_machine = string<br>      ip_address      = string<br>    }))<br>    location                   = string<br>    site_to_site_data_transfer = optional(bool, false)<br>    description                = optional(string)<br>    labels                     = optional(map(string))<br>    include_import_ranges      = optional(list(string), [])<br>    group                      = optional(string)<br>  }))</pre> | `{}` | no |
 | spoke\_labels | These labels will be added to all NCC spokes | `map(string)` | `{}` | no |

modules/network-connectivity-center/README.md

@@ -106,10 +106,10 @@ spec:
         varType: map(string)
         defaultValue: {}
       - name: ncc_hub_preset_topology
-        description: The topology implemented in the hub
+        description: The topology implemented in the hub. Type must be one of `STAR` or `MESH`.
         varType: string
       - name: ncc_hub_policy_mode
-        description: The policy mode of the hub
+        description: The policy mode of the hub. Type must be one of `PRESET` or `CUSTOM`.
         varType: string
         defaultValue: PRESET
       - name: ncc_groups

modules/network-connectivity-center/metadata.yaml

@@ -36,13 +36,13 @@ variable "ncc_hub_labels" {
 }
 
 variable "ncc_hub_preset_topology" {
-  description = "The topology implemented in the hub"
+  description = "The topology implemented in the hub. Type must be one of `STAR` or `MESH`."
   type        = string
   default     = null
 }
 
 variable "ncc_hub_policy_mode" {
-  description = "The policy mode of the hub"
+  description = "The policy mode of the hub. Type must be one of `PRESET` or `CUSTOM`."
   type        = string
   default     = "PRESET"
 }