Allow region data source to lookup by filter and name (#301)

vra_region data source allows filter argument to lookup only by
externalRegionId and cloudAccountId. If there are more than one
results that match the filter criteria, users can use the 'name'
argument to further filter the results to the first one in the
list of results.

Signed-off-by: Deepak Mettem <[email protected]>

Author: dmettem

examples/infrastructure_setup/vmc/main.tf

@@ -50,8 +50,10 @@ resource "null_resource" "delay" {
 data "vra_region" "this" {
   // Important thing to note is the cloud_account_id in the filter criteria is ne (i.e. not equal) to VMC cloud account id
   filter = "externalRegionId eq '${var.external_region_id}' and cloudAccountId ne '${vra_cloud_account_vmc.this.id}'"
+  name = var.region_name // Use 'name' argument in case there are other vCenter regions that have same external region id
 
-  //  filter =  "name eq 'SDDC-Datacenter' and externalRegionId eq '${var.external_region_id}' and cloud_account_id ne vra_cloud_account_vmc.vmc_cloud_account.id" // Important thing to note is the cloud_account_id in the filter criteria is ne (i.e. not equal) to VMC cloud account id.
+  # filter by 'name' is not supported yet. Use the 'name' argument instead until it is supported
+  # filter =  "name eq 'SDDC-Datacenter' and externalRegionId eq '${var.external_region_id}' and cloudAccountId ne vra_cloud_account_vmc.vmc_cloud_account.id"
 }
 
 resource "vra_zone" "this" {

examples/infrastructure_setup/vmc/terraform.tfvars.sample

@@ -8,6 +8,7 @@ sddc_name = ""
 vcenter_hostname = ""
 vcenter_password = ""
 vcenter_username = ""
+region_name = ""
 external_region_id = ""
 user_email = ""
 fabric_network_name = ""

examples/infrastructure_setup/vmc/variables.tf

@@ -28,6 +28,9 @@ variable "vcenter_password" {
 variable "vcenter_username" {
 }
 
+variable "region_name" {
+}
+
 variable "external_region_id" {
 }
 

vra/data_source_region.go

@@ -2,6 +2,7 @@ package vra
 
 import (
 	"fmt"
+	"log"
 	"strings"
 
 	"github.com/vmware/vra-sdk-go/pkg/client/location"
@@ -40,7 +41,7 @@ func dataSourceRegion() *schema.Resource {
 			},
 			"name": {
 				Type:     schema.TypeString,
-				Computed: true,
+				Optional: true,
 			},
 			"org_id": {
 				Type:     schema.TypeString,
@@ -102,15 +103,40 @@ func dataSourceRegionRead(d *schema.ResourceData, meta interface{}) error {
 			return err
 		}
 
+		var region *models.Region
 		regions := getResp.Payload
 		if len(regions.Content) > 1 {
-			return fmt.Errorf("vra_region must filter to a single region")
+			log.Printf("received more than one result with the filter provided")
+			name, nameOk := d.GetOk("name")
+
+			if !nameOk {
+				return fmt.Errorf("vra_region must filter to a single region. Provide the 'name' argument to filter more")
+			}
+
+			for _, reg := range regions.Content {
+				if reg.Name == name.(string) {
+					setFields(reg)
+					return nil
+				}
+			}
+
+			return fmt.Errorf("more than one region found with the filter criteria, but the name provided did not match any regions")
 		}
+
 		if len(regions.Content) == 0 {
 			return fmt.Errorf("vra_region filter did not match any regions")
 		}
 
-		region := regions.Content[0]
+		if len(regions.Content) == 1 {
+			region = regions.Content[0]
+
+			name, nameOk := d.GetOk("name")
+
+			if nameOk && region.Name != name.(string) {
+				return fmt.Errorf("one region found with the filter criteria, but the name provided did not match")
+			}
+		}
+
 		setFields(region)
 		return nil
 	}

website/docs/d/vra_region.html.markdown

@@ -18,12 +18,44 @@ data "vra_region" "this" {
 }
 ```
 
+**Region data source by filter:**
+```hcl
+data "vra_region" "this" {
+  filter = "externalRegionId eq '${var.external_region_id}' and cloudAccountId eq '${vra_cloud_account.this.id}'"
+}
+```
+
+**Region data source by filter and name:**
+For setting up vra_zone, vra_image_profile, vra_network_profile, etc for a VMC cloud account, use the following example.
+```hcl
+data "vra_region" "this" {
+  filter = "externalRegionId eq '${var.external_region_id}' and cloudAccountId ne '${vra_cloud_account_vmc.this.id}'"
+  name   = var.region_name
+}
+```
+
 The region data source supports the following arguments:
 
 ## Argument Reference
-* `cloud_account_id` - (Required) The Cloud Account ID.
+* `cloud_account_id` - (Optional) The Cloud Account ID.
+
+* `filter` - (Optional) Search criteria to narrow down Images.
+
+* `id` - (Optional) The ID of the region to find.
 
-* `region` - (Required) The specific region associated with the cloud account.
+* `region` - (Optional) The specific region associated with the cloud account.
+
+* `name` - (Optional) Name of the region from the associated vCenter.
 
 ## Attribute Reference
+* `created_at` - Date when entity was created. Date and time format is ISO 8601 and UTC.
+
+* `org_id` - ID of organization that entity belongs to.
+
+* `owner` - Email of entity owner.
+
+* `external_region_id` - External regionId of region.
+
 * `id` - The ID of the given region within the cloud account.
+
+* `updated_at` - Date when entity was updated. Date and time format is ISO 8601 and UTC.