Self review, changelog

Didainius · Didainius · commit ea6c97a7a3d8 · 2024-12-19T08:20:45.000+02:00
Signed-off-by: Dainius Serplis &lt;dserplis@vmware.com&gt;
diff --git a/.changes/v4.0.0/1375-features.md b/.changes/v4.0.0/1375-features.md
@@ -0,0 +1,3 @@
+* **New Data Source:** `vcd_tm_edge_cluster` to read and sync TM Edge Clusters [GH-1375]
+* **New Resource:** `vcd_tm_edge_cluster_qos` to manage QoS settings for TM Edge Clusters [GH-1375]
+* **New Data Source:** `vcd_tm_edge_cluster_qos` to read QoS settings for TM Edge Clusters [GH-1375]
diff --git a/go.mod b/go.mod
@@ -71,4 +71,4 @@ require (
 )
 
 //replace github.com/vmware/go-vcloud-director/v3 => github.com/Didainius/go-vcloud-director/v3 v2.12.1-0.20211018060826-c7f8ab32330e
-replace github.com/vmware/go-vcloud-director/v3 => github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241218070848-7438f3a2dacd
+replace github.com/vmware/go-vcloud-director/v3 => github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241219055930-5632625dd670
diff --git a/go.sum b/go.sum
@@ -1,7 +1,7 @@
 dario.cat/mergo v1.0.0 h1:AGCNq9Evsj31mOgNPcLyXc+4PNABt905YmuqPYYpBWk=
 dario.cat/mergo v1.0.0/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk=
-github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241218070848-7438f3a2dacd h1:ge5eLNUWIP0VGZMT0+/Ka1RQJU9dJtQHpSu6k0X3fZk=
-github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241218070848-7438f3a2dacd/go.mod h1:68KHsVns52dsq/w5JQYzauaU/+NAi1FmCxhBrFc/VoQ=
+github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241219055930-5632625dd670 h1:NjHoGj5LNQuYuOwjZ0gQd2rIamFra8SGc3Up6IOHARs=
+github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241219055930-5632625dd670/go.mod h1:68KHsVns52dsq/w5JQYzauaU/+NAi1FmCxhBrFc/VoQ=
 github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migciow=
 github.com/Microsoft/go-winio v0.6.1/go.mod h1:LRdKpFKfdobln8UmuiYcKPot9D2v6svN5+sAH+4kjUM=
 github.com/ProtonMail/go-crypto v1.1.0-alpha.2 h1:bkyFVUP+ROOARdgCiJzNQo2V2kiB97LyUpzH9P6Hrlg=
diff --git a/vcd/datasource_vcd_tm_edge_cluster_qos.go b/vcd/datasource_vcd_tm_edge_cluster_qos.go
@@ -44,7 +44,7 @@ func datasourceVcdTmEdgeClusterQos() *schema.Resource {
 			"egress_burst_size_bytes": {
 				Type:        schema.TypeString,
 				Computed:    true,
-				Description: fmt.Sprintf("Ingress burst size bytes for %s", labelTmEdgeCluster),
+				Description: fmt.Sprintf("Egress burst size bytes for %s", labelTmEdgeCluster),
 			},
 		},
 	}
diff --git a/vcd/resource_generic_crud.go b/vcd/resource_generic_crud.go
@@ -252,7 +252,6 @@ func readDatasource[O any, I any](_ context.Context, d *schema.ResourceData, met
 		util.Logger.Printf("[DEBUG] Overriding %s field 'name' to '%s' for datasource lookup", c.entityLabel, c.overrideDefaultNameField)
 	}
 	entityName := d.Get(fieldName).(string)
-
 	retrievedEntity, err := c.getEntityFunc(entityName)
 	if err != nil {
 		return diag.Errorf("error getting %s by Name '%s': %s", c.entityLabel, entityName, err)
diff --git a/vcd/resource_vcd_tm_edge_cluster_qos.go b/vcd/resource_vcd_tm_edge_cluster_qos.go
@@ -36,28 +36,28 @@ func resourceVcdTmEdgeClusterQos() *schema.Resource {
 				Description: fmt.Sprintf("Region ID of  %s", labelTmEdgeCluster),
 			},
 			"ingress_committed_bandwidth_mbps": {
-				Type:         schema.TypeString,
+				Type:         schema.TypeString, // string + validation due to usual problem of differentiation between 0 and empty value for TypeInt
 				Optional:     true,
 				Description:  fmt.Sprintf("Ingress committed bandwidth in Mbps for %s", labelTmEdgeCluster),
 				ValidateFunc: emptyOrIsIntAndAtLeast(1),
 				RequiredWith: []string{"ingress_burst_size_bytes"},
 			},
 			"ingress_burst_size_bytes": {
-				Type:         schema.TypeString,
+				Type:         schema.TypeString, // string + validation due to usual problem of differentiation between 0 and empty value for TypeInt
 				Optional:     true,
 				Description:  fmt.Sprintf("Ingress burst size bytes for %s", labelTmEdgeCluster),
 				ValidateFunc: emptyOrIsIntAndAtLeast(1),
 				RequiredWith: []string{"ingress_committed_bandwidth_mbps"},
 			},
 			"egress_committed_bandwidth_mbps": {
-				Type:         schema.TypeString,
+				Type:         schema.TypeString, // string + validation due to usual problem of differentiation between 0 and empty value for TypeInt
 				Optional:     true,
 				Description:  fmt.Sprintf("Egress committed bandwidth in Mbps for %s", labelTmEdgeCluster),
 				ValidateFunc: emptyOrIsIntAndAtLeast(1),
 				RequiredWith: []string{"egress_burst_size_bytes"},
 			},
 			"egress_burst_size_bytes": {
-				Type:         schema.TypeString,
+				Type:         schema.TypeString, // string + validation due to usual problem of differentiation between 0 and empty value for TypeInt
 				Optional:     true,
 				Description:  fmt.Sprintf("Ingress burst size bytes for %s", labelTmEdgeCluster),
 				ValidateFunc: emptyOrIsIntAndAtLeast(1),
@@ -92,7 +92,6 @@ func resourceVcdTmEdgeClusterQosCreate(ctx context.Context, d *schema.ResourceDa
 
 func resourceVcdTmEdgeClusterQosUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	vcdClient := meta.(*VCDClient)
-
 	c := crudConfig[*govcd.TmEdgeCluster, types.TmEdgeCluster]{
 		entityLabel:      labelTmEdgeClusterQos,
 		getTypeFunc:      getTmEdgeClusterQosType,
@@ -115,7 +114,6 @@ func resourceVcdTmEdgeClusterQosRead(ctx context.Context, d *schema.ResourceData
 
 func resourceVcdTmEdgeClusterQosDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	vcdClient := meta.(*VCDClient)
-
 	c := crudConfig[*govcd.TmEdgeCluster, types.TmEdgeCluster]{
 		entityLabel:   labelTmEdgeClusterQos,
 		getEntityFunc: vcdClient.GetTmEdgeClusterById,
@@ -126,7 +124,6 @@ func resourceVcdTmEdgeClusterQosDelete(ctx context.Context, d *schema.ResourceDa
 
 func resourceVcdTmEdgeClusterQosImport(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
 	vcdClient := meta.(*VCDClient)
-
 	ec, err := vcdClient.GetTmEdgeClusterByName(d.Id())
 	if err != nil {
 		return nil, fmt.Errorf("error retrieving %s by Name '%s': %s", labelTmEdgeClusterQos, d.Id(), err)
diff --git a/website/docs/d/tm_edge_cluster.html.markdown b/website/docs/d/tm_edge_cluster.html.markdown
@@ -37,8 +37,8 @@ The following arguments are supported:
 
 ## Attribute Reference
 
-* `node_count` - NodeCount contains number of transport nodes in the Edge Cluster. If this
-  information is not available, nodeCount will be set to `-1`
+* `node_count` - Number of transport nodes in the Edge Cluster. If this information is not
+  available, it will be set to `-1`
 * `org_count` - Number of organization using this Edge Cluster
 * `vpc_count` - Number of VPCs using this Edge Cluster
 * `average_cpu_usage_percentage` - Average CPU utilization percentage across all member nodes
@@ -47,14 +47,14 @@ The following arguments are supported:
  * `UP` - The Edge Cluster is healthy
  * `DOWN` - The Edge Cluster is down
  * `DEGRADED` - The Edge Cluster is not operating at capacity. One or more member nodes are down or inactive
- * `UNKNOWN` - The Edge Cluster state is unknown. If UNKNOWN, avgMemoryUsagePercentage and avgCpuUsagePercentage will be not be set
+ * `UNKNOWN` - The Edge Cluster state is unknown. If UNKNOWN, `average_cpu_usage_percentage` and `average_memory_usage_percentage` will be not be set
 * `status` - Represents current status of the networking entity. One of:
- * `PENDING` - Desired entity configuration has been received by system and is pending realization.
- * `CONFIGURING` - The system is in process of realizing the entity.
- * `REALIZED` - The entity is successfully realized in the system.
+ * `PENDING` - Desired entity configuration has been received by system and is pending realization
+ * `CONFIGURING` - The system is in process of realizing the entity
+ * `REALIZED` - The entity is successfully realized in the system
  * `REALIZATION_FAILED` - There are some issues and the system is not able to realize the entity
  * `UNKNOWN` - Current state of entity is unknown
 * `deployment_type` - Deployment type for transport nodes in the Edge Cluster. Possible values are:
- * `VIRTUAL_MACHINE` - If all members are of type VIRTUAL_MACHINE
- * `PHYSICAL_MACHINE` - If all members are of type PHYSICAL_MACHINE
+ * `VIRTUAL_MACHINE` - If all members are of type _VIRTUAL_MACHINE_
+ * `PHYSICAL_MACHINE` - If all members are of type _PHYSICAL_MACHINE_
  * `UNKNOWN` - If there are no members or their type is not known
diff --git a/website/docs/d/tm_edge_cluster_qos.html.markdown b/website/docs/d/tm_edge_cluster_qos.html.markdown
@@ -3,12 +3,12 @@ layout: "vcd"
 page_title: "VMware Cloud Director: vcd_tm_edge_cluster_qos"
 sidebar_current: "docs-vcd-data-source-tm-edge-cluster-qos"
 description: |-
-  Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS.
+  Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS data source.
 ---
 
 # vcd\_tm\_edge\_cluster\_qos
 
-Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS.
+Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS data source.
 
 ## Example Usage
 
diff --git a/website/docs/r/tm_edge_cluster_qos.html.markdown b/website/docs/r/tm_edge_cluster_qos.html.markdown
@@ -3,16 +3,16 @@ layout: "vcd"
 page_title: "VMware Cloud Director: vcd_tm_edge_cluster_qos"
 sidebar_current: "docs-vcd-resource-tm-edge-cluster-qos"
 description: |-
-  Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS.
+  Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS resource.
 ---
 
 # vcd\_tm\_edge\_cluster\_qos
 
-Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS.
+Provides a VMware Cloud Foundation Tenant Manager Edge Cluster QoS resource.
 
--> This resource does not actually create an Edge Cluster QoS, but configures QoS for a given
+-> This resource does not create an Edge Cluster QoS entity, but configures QoS for a given
 `edge_cluster_id`. Similarly, `terraform destroy` operation does not remove Edge Cluster, but resets
-QoS settings to unlimited. 
+QoS settings to default (unlimited). 
 
 ## Example Usage
 
@@ -44,28 +44,14 @@ The following arguments are supported:
 * `edge_cluster_id` - (Required) An ID of Edge Cluster. Can be looked up using
   [vcd_tm_edge_cluster](/providers/vmware/vcd/latest/docs/data-sources/tm_edge_cluster) data source
 * `egress_committed_bandwidth_mbps` - (Optional) Committed egress bandwidth specified in Mbps.
-  Bandwidth is limited to line rate when the value configured is greater than line rate. Traffic
-  exceeding bandwidth will be dropped
+  Bandwidth is limited to line rate. Traffic exceeding bandwidth will be dropped
 * `egress_burst_size_bytes` - (Optional) Egress burst size in bytes
 * `ingress_committed_bandwidth_mbps` - (Optional) Committed ingress bandwidth specified in Mbps.
-  Bandwidth is limited to line rate when the value configured is greater than line rate. Traffic
-  exceeding bandwidth will be dropped
+  Bandwidth is limited to line rate. Traffic exceeding bandwidth will be dropped
 * `ingress_burst_size_bytes` - (Optional) Ingres burst size in bytes
 
 -> Choosing to set _egress_ or _ingress_ requires both of that traffic direction must be set
 
-## Attribute Reference
-
-The following attributes are exported on this resource:
-
-* `max_virtual_services` - Maximum number of virtual services this NSX-T ALB Service Engine Group can run
-* `reserved_virtual_services` - Number of reserved virtual services
-* `deployed_virtual_services` - Number of deployed virtual services
-* `ha_mode` defines High Availability Mode for Service Engine Group. One off:
-  * ELASTIC_N_PLUS_M_BUFFER - Service Engines will scale out to N active nodes with M nodes as buffer.
-  * ELASTIC_ACTIVE_ACTIVE - Active-Active with scale out.
-  * LEGACY_ACTIVE_STANDBY - Traditional single Active-Standby configuration
-
 ## Importing
 
 ~> **Note:** The current implementation of Terraform import can only import resources into the
@@ -78,7 +64,8 @@ path for it. An example is below:
 [docs-import]: https://www.terraform.io/docs/import/
 
 ```
-terraform import vcd_tm_ip_space.imported my-ip-space-name
+terraform import vcd_tm_edge_cluster_qos.imported my-region-name.my-edge-cluster-name
 ```
 
-The above would import the `my-ip-space-name` IP Space.
+The above would import the `my-edge-cluster-name` Edge Cluster QoS settings that is in
+`my-region-name` Region.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+* New Data Source: `vcd_tm_edge_cluster` to read and sync TM Edge Clusters [GH-1375]
	`2`	+* New Resource: `vcd_tm_edge_cluster_qos` to manage QoS settings for TM Edge Clusters [GH-1375]
	`3`	+* New Data Source: `vcd_tm_edge_cluster_qos` to read QoS settings for TM Edge Clusters [GH-1375]
Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,4 @@ require (`
`71`	`71`	`)`
`72`	`72`
`73`	`73`	`//replace github.com/vmware/go-vcloud-director/v3 => github.com/Didainius/go-vcloud-director/v3 v2.12.1-0.20211018060826-c7f8ab32330e`
`74`		`-replace github.com/vmware/go-vcloud-director/v3 => github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241218070848-7438f3a2dacd`
	`74`	`+replace github.com/vmware/go-vcloud-director/v3 => github.com/Didainius/go-vcloud-director/v3 v3.0.0-alpha.4.0.20241219055930-5632625dd670`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ func datasourceVcdTmEdgeClusterQos() *schema.Resource {`
`44`	`44`	`"egress_burst_size_bytes": {`
`45`	`45`	`Type: schema.TypeString,`
`46`	`46`	`Computed: true,`
`47`		`- Description: fmt.Sprintf("Ingress burst size bytes for %s", labelTmEdgeCluster),`
	`47`	`+ Description: fmt.Sprintf("Egress burst size bytes for %s", labelTmEdgeCluster),`
`48`	`48`	`},`
`49`	`49`	`},`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -252,7 +252,6 @@ func readDatasource[O any, I any](_ context.Context, d *schema.ResourceData, met`
`252`	`252`	`util.Logger.Printf("[DEBUG] Overriding %s field 'name' to '%s' for datasource lookup", c.entityLabel, c.overrideDefaultNameField)`
`253`	`253`	`}`
`254`	`254`	`entityName := d.Get(fieldName).(string)`
`255`		`-`
`256`	`255`	`retrievedEntity, err := c.getEntityFunc(entityName)`
`257`	`256`	`if err != nil {`
`258`	`257`	`return diag.Errorf("error getting %s by Name '%s': %s", c.entityLabel, entityName, err)`