Revert ncc example, add star module invocation

paulwilljones · paulwilljones · commit 2f7ef6eea67f · 2025-10-20T11:52:36.000+01:00
add integration test for ncc star groups
add upgrading docs
bump ncc module provider version
diff --git a/docs/upgrading_to_v13.0.0.md b/docs/upgrading_to_v13.0.0.md
@@ -0,0 +1,6 @@
+# Upgrading to v13.0.0
+
+The v13.0 release contains backwards-incompatible changes.
+
+This update requires upgrading:
+- minimum provider version of `hashicorp/google` to `6.9` for network-connectivity-center sub-module.
diff --git a/examples/network_connectivity_center/main.tf b/examples/network_connectivity_center/main.tf
@@ -16,39 +16,19 @@
 
 module "network_connectivity_center" {
   source  = "terraform-google-modules/network/google//modules/network-connectivity-center"
-  version = "~> 12.0"
+  version = "~> 13.0"
 
   project_id   = var.project_id
   ncc_hub_name = var.ncc_hub_name
   ncc_hub_labels = {
     "module" = "ncc"
   }
-  ncc_hub_preset_topology = "STAR"
-  ncc_groups = {
-    "center" = {
-      name = "center"
-      labels = {
-        "module" = "ncc"
-      }
-    }
-    "edge" = {
-      name = "edge"
-      auto_accept_projects = [
-        "foo",
-        "bar"
-      ]
-    }
-  }
-  spoke_labels = {
-    "created-by" = "terraform-google-ncc-example"
-  }
   vpc_spokes = {
     "vpc-1" = {
       uri = module.vpc_spoke_vpc.network_id
       labels = {
         "spoke-type" = "vpc"
       }
-      group = "edge"
     }
     "producer-conn" = {
       uri = google_compute_network.producer_connected_network.id
@@ -65,7 +45,6 @@ module "network_connectivity_center" {
           "198.51.100.0/24",
           "10.10.0.0/16"
         ]
-        group = "center"
       }
     }
   }
@@ -76,7 +55,6 @@ module "network_connectivity_center" {
       uris                       = [for k, v in module.local_to_remote_vpn.tunnel_self_links : v]
       site_to_site_data_transfer = true
       location                   = var.vpn_region
-      group = "center"
     }
   }
   router_appliance_spokes = {
@@ -90,11 +68,40 @@ module "network_connectivity_center" {
       ]
       location                   = var.instance_region
       site_to_site_data_transfer = false
-      group = "center"
     }
   }
 }
 
+module "network_connectivity_center_star" {
+  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}_star"
+  ncc_hub_labels = {
+    "module" = "ncc"
+  }
+  ncc_hub_preset_topology = "STAR"
+  ncc_groups = {
+    "center" = {
+      name = "center"
+      labels = {
+        "module" = "ncc"
+      }
+    }
+    "edge" = {
+      name = "edge"
+      auto_accept_projects = [
+        "foo",
+        "bar"
+      ]
+    }
+  }
+  spoke_labels = {
+    "created-by" = "terraform-google-ncc-example"
+  }
+}
+
 ################################
 #          VPC Spoke           #
 ################################
diff --git a/examples/network_connectivity_center/outputs.tf b/examples/network_connectivity_center/outputs.tf
@@ -29,7 +29,6 @@ output "vpc_spokes" {
   value       = module.network_connectivity_center.vpc_spokes
 }
 
-
 output "hybrid_spokes" {
   description = "All hybrid spoke objects"
   value       = module.network_connectivity_center.hybrid_spokes
@@ -44,3 +43,13 @@ output "spokes" {
   description = "All spoke objects prefixed with the type of spoke (vpc, hybrid, appliance)"
   value       = module.network_connectivity_center.spokes
 }
+
+output "ncc_hub_name_star" {
+  description = "Name of the NCC Hub (required for testing)"
+  value       = element(reverse(split("/", module.network_connectivity_center_star.ncc_hub.name)), 0)
+}
+
+output "groups" {
+  description = "All spoke objects prefixed with the type of spoke (vpc, hybrid, appliance)"
+  value       = module.network_connectivity_center_star.groups
+}
diff --git a/examples/network_connectivity_center/versions.tf b/examples/network_connectivity_center/versions.tf
@@ -20,7 +20,7 @@ terraform {
   required_providers {
     google = {
       source  = "hashicorp/google"
-      version = ">= 6.49"
+      version = ">= 6.9"
 
     }
   }
diff --git a/modules/network-connectivity-center/README.md b/modules/network-connectivity-center/README.md
@@ -23,19 +23,23 @@ An extensive example that also contains the creation and attachment of multiple
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | export\_psc | Whether Private Service Connect transitivity is enabled for the hub | `bool` | `false` | no |
-| hybrid\_spokes | VLAN attachments and VPN Tunnels that are associated with the spoke. Type must be one of `interconnect` and `vpn`. | <pre>map(object({<br>    location                   = string<br>    uris                       = set(string)<br>    site_to_site_data_transfer = optional(bool, false)<br>    type                       = string<br>    description                = optional(string)<br>    labels                     = optional(map(string))<br>    include_import_ranges      = optional(list(string), [])<br>  }))</pre> | `{}` | no |
+| hybrid\_spokes | VLAN attachments and VPN Tunnels that are associated with the spoke. Type must be one of `interconnect` and `vpn`. | <pre>map(object({<br>    location                   = string<br>    uris                       = set(string)<br>    site_to_site_data_transfer = optional(bool, false)<br>    type                       = string<br>    description                = optional(string)<br>    labels                     = optional(map(string))<br>    include_import_ranges      = optional(list(string), [])<br>    group                      = optional(string)<br>  }))</pre> | `{}` | no |
+| ncc\_groups | Groups for Hubs using the star topolgy | <pre>map(object({<br>    name                 = string<br>    labels               = optional(map(string))<br>    description          = optional(string)<br>    auto_accept_projects = optional(list(string), [])<br>  }))</pre> | `{}` | no |
 | 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 |
 | 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>  }))</pre> | `{}` | no |
+| 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 |
-| vpc\_spokes | VPC network that is associated with the spoke. link\_producer\_vpc\_network: Producer VPC network that is peered with vpc network | <pre>map(object({<br>    uri                   = string<br>    exclude_export_ranges = optional(set(string), [])<br>    include_export_ranges = optional(set(string), [])<br>    description           = optional(string)<br>    labels                = optional(map(string))<br><br>    link_producer_vpc_network = optional(object({<br>      network_name          = string<br>      peering               = string<br>      include_export_ranges = optional(list(string))<br>      exclude_export_ranges = optional(list(string))<br>      description           = optional(string)<br>      labels                = optional(map(string))<br>    }))<br>  }))</pre> | `{}` | no |
+| vpc\_spokes | VPC network that is associated with the spoke. link\_producer\_vpc\_network: Producer VPC network that is peered with vpc network | <pre>map(object({<br>    uri                   = string<br>    exclude_export_ranges = optional(set(string), [])<br>    include_export_ranges = optional(set(string), [])<br>    description           = optional(string)<br>    labels                = optional(map(string))<br>    group                 = optional(string)<br><br>    link_producer_vpc_network = optional(object({<br>      network_name          = string<br>      peering               = string<br>      include_export_ranges = optional(list(string))<br>      exclude_export_ranges = optional(list(string))<br>      description           = optional(string)<br>      labels                = optional(map(string))<br>      group                 = optional(string)<br>    }))<br>  }))</pre> | `{}` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
+| groups | All group objects |
 | hybrid\_spokes | All hybrid spoke objects |
 | ncc\_hub | The NCC Hub object |
 | producer\_vpc\_network\_spoke | All producer network vpc spoke objects |
diff --git a/modules/network-connectivity-center/metadata.yaml b/modules/network-connectivity-center/metadata.yaml
@@ -105,6 +105,23 @@ spec:
         description: These labels will be added the NCC hub
         varType: map(string)
         defaultValue: {}
+      - name: ncc_hub_preset_topology
+        description: The topology implemented in the hub
+        varType: string
+      - name: ncc_hub_policy_mode
+        description: The policy mode of the hub
+        varType: string
+        defaultValue: PRESET
+      - name: ncc_groups
+        description: Groups for Hubs using the star topolgy
+        varType: |-
+          map(object({
+              name                 = string
+              labels               = optional(map(string))
+              description          = optional(string)
+              auto_accept_projects = optional(list(string), [])
+            }))
+        defaultValue: {}
       - name: export_psc
         description: Whether Private Service Connect transitivity is enabled for the hub
         varType: bool
@@ -118,6 +135,7 @@ spec:
               include_export_ranges = optional(set(string), [])
               description           = optional(string)
               labels                = optional(map(string))
+              group                 = optional(string)
 
               link_producer_vpc_network = optional(object({
                 network_name          = string
@@ -126,6 +144,7 @@ spec:
                 exclude_export_ranges = optional(list(string))
                 description           = optional(string)
                 labels                = optional(map(string))
+                group                 = optional(string)
               }))
             }))
         defaultValue: {}
@@ -140,6 +159,7 @@ spec:
               description                = optional(string)
               labels                     = optional(map(string))
               include_import_ranges      = optional(list(string), [])
+              group                      = optional(string)
             }))
         defaultValue: {}
       - name: router_appliance_spokes
@@ -155,13 +175,16 @@ spec:
               description                = optional(string)
               labels                     = optional(map(string))
               include_import_ranges      = optional(list(string), [])
+              group                      = optional(string)
             }))
         defaultValue: {}
       - name: spoke_labels
         description: These labels will be added to all NCC spokes
         varType: map(string)
         defaultValue: {}
     outputs:
+      - name: groups
+        description: All group objects
       - name: hybrid_spokes
         description: All hybrid spoke objects
       - name: ncc_hub
@@ -204,4 +227,4 @@ spec:
       - servicenetworking.googleapis.com
     providerVersions:
       - source: hashicorp/google
-        version: ">= 6.49, < 8"
+        version: ">= 6.9, < 8"
diff --git a/modules/network-connectivity-center/outputs.tf b/modules/network-connectivity-center/outputs.tf
@@ -62,5 +62,6 @@ output "spokes" {
 }
 
 output "groups" {
-  value = local.groups
+  description = "All group objects"
+  value       = local.groups
 }
diff --git a/modules/network-connectivity-center/variables.tf b/modules/network-connectivity-center/variables.tf
@@ -37,14 +37,14 @@ variable "ncc_hub_labels" {
 
 variable "ncc_hub_preset_topology" {
   description = "The topology implemented in the hub"
-  type    = string
-  default = ""
+  type        = string
+  default     = null
 }
 
 variable "ncc_hub_policy_mode" {
   description = "The policy mode of the hub"
-  type    = string
-  default = "PRESET"
+  type        = string
+  default     = "PRESET"
 }
 
 variable "ncc_groups" {
diff --git a/modules/network-connectivity-center/versions.tf b/modules/network-connectivity-center/versions.tf
@@ -20,7 +20,7 @@ terraform {
   required_providers {
     google = {
       source  = "hashicorp/google"
-      version = ">= 6.49, < 8"
+      version = ">= 6.9, < 8"
 
     }
   }
diff --git a/test/integration/network_connectivity_center/network_connectivity_center_test.go b/test/integration/network_connectivity_center/network_connectivity_center_test.go
@@ -31,11 +31,18 @@ func TestNetworkConnectivityCenter(t *testing.T) {
 			// net.DefaultVerify(assert) Disable due to bug in provider. Reenable it after the bug is fixed
 			projectID := net.GetStringOutput("project_id")
 			nccHubName := net.GetStringOutput("ncc_hub_name")
+			nccHubStarName := net.GetStringOutput("ncc_hub_name_star")
 
 			op := gcloud.Run(t, "network-connectivity hubs describe ", gcloud.WithCommonArgs([]string{nccHubName, "--project", projectID, "--format", "json"}))
 			nccSpokeStateCount := op.Get("spokeSummary.spokeStateCounts").Array()
 			assert.Equal(1, len(nccSpokeStateCount), "should have spokes in one State")
 			assert.Equal("ACTIVE", nccSpokeStateCount[0].Get("state").String(), "should have only active spokes")
+
+			groups := gcloud.Run(t, "network-connectivity hubs groups list ", gcloud.WithCommonArgs([]string{"--hub", nccHubStarName, "--project", projectID, "--format", "json"})).Get("groups").Array()
+			assert.Equal(2, len(groups), "should have two groups")
+			for _, group := range groups {
+				assert.Equal("ACTIVE", group.Get("state").String(), "should have active group")
+			}
 		})
 	net.Test()
 }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ terraform {`
`20`	`20`	`required_providers {`
`21`	`21`	`google = {`
`22`	`22`	`source = "hashicorp/google"`
`23`		`- version = ">= 6.49"`
	`23`	`+ version = ">= 6.9"`
`24`	`24`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,5 +62,6 @@ output "spokes" {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`output "groups" {`
`65`		`- value = local.groups`
	`65`	`+ description = "All group objects"`
	`66`	`+ value = local.groups`
`66`	`67`	`}`