Add support for NSX-T Alb General Settings

.changes/v2.14.0/403-features.md

@@ -0,0 +1,2 @@
+* Added type `NsxtAlbConfig` and functions `NsxtEdgeGateway.UpdateAlbSettings`, `NsxtEdgeGateway.GetAlbSettings`,
+  `NsxtEdgeGateway.DisableAlb` [GH-403]

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.14.0 (Unreleased)
+
+Changes in progress for v2.14.0 are available at [.changes/v2.14.0](https://github.com/vmware/go-vcloud-director/tree/master/.changes/v2.14.0) until the release.
+
+
 ## 2.13.0 (September 30, 2021)
 
 ## FEATURES

govcd/nsxt_alb_clouds_test.go

@@ -115,7 +115,7 @@ func spawnAlbControllerAndCloud(vcd *TestVCD, check *C) (*NsxtAlbController, *Ns
 	check.Assert(err, IsNil)
 
 	openApiEndpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointAlbCloud + createdAlbCloud.NsxtAlbCloud.ID
-	AddToCleanupListOpenApi(createdAlbCloud.NsxtAlbCloud.Name, check.TestName(), openApiEndpoint)
+	PrependToCleanupListOpenApi(createdAlbCloud.NsxtAlbCloud.Name, check.TestName(), openApiEndpoint)
 
 	return albController, createdAlbCloud
 }

govcd/nsxt_alb_service_engine_groups_test.go

@@ -78,3 +78,34 @@ func (vcd *TestVCD) Test_GetAllAlbServiceEngineGroups(check *C) {
 	err = controller.Delete()
 	check.Assert(err, IsNil)
 }
+
+// spawnAlbControllerCloudServiceEngineGroup is a helper function to spawn NSX-T ALB Controller, ALB Cloud, and ALB
+// Service Engine Group
+func spawnAlbControllerCloudServiceEngineGroup(vcd *TestVCD, check *C) (*NsxtAlbController, *NsxtAlbCloud, *NsxtAlbServiceEngineGroup) {
+	skipNoNsxtAlbConfiguration(vcd, check)
+
+	albController, createdAlbCloud := spawnAlbControllerAndCloud(vcd, check)
+
+	importableSeGroups, err := vcd.client.GetAllAlbImportableServiceEngineGroups(createdAlbCloud.NsxtAlbCloud.ID, nil)
+	check.Assert(err, IsNil)
+	check.Assert(len(importableSeGroups) > 0, Equals, true)
+	albSeGroup := &types.NsxtAlbServiceEngineGroup{
+		Name:            check.TestName() + "SE-group",
+		Description:     "Service Engine Group created by " + check.TestName(),
+		ReservationType: "DEDICATED",
+		ServiceEngineGroupBacking: types.ServiceEngineGroupBacking{
+			BackingId: importableSeGroups[0].NsxtAlbImportableServiceEngineGroups.ID,
+			LoadBalancerCloudRef: &types.OpenApiReference{
+				ID: createdAlbCloud.NsxtAlbCloud.ID,
+			},
+		},
+	}
+
+	createdSeGroup, err := vcd.client.CreateNsxtAlbServiceEngineGroup(albSeGroup)
+	check.Assert(err, IsNil)
+
+	openApiEndpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointAlbServiceEngineGroups + createdSeGroup.NsxtAlbServiceEngineGroup.ID
+	PrependToCleanupListOpenApi(createdSeGroup.NsxtAlbServiceEngineGroup.Name, check.TestName(), openApiEndpoint)
+
+	return albController, createdAlbCloud, createdSeGroup
+}

govcd/nsxt_alb_settings.go

@@ -0,0 +1,66 @@
+package govcd
+
+import (
+	"fmt"
+
+	"github.com/vmware/go-vcloud-director/v2/types/v56"
+)
+
+// GetAlbSettings retrieves NSX-T ALB settings for a particular Edge Gateway
+func (egw *NsxtEdgeGateway) GetAlbSettings() (*types.NsxtAlbConfig, error) {
+	client := egw.client
+	endpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointEdgeGatewayAlb
+	apiVersion, err := client.getOpenApiHighestElevatedVersion(endpoint)
+	if err != nil {
+		return nil, err
+	}
+
+	urlRef, err := client.OpenApiBuildEndpoint(fmt.Sprintf(endpoint, egw.EdgeGateway.ID))
+	if err != nil {
+		return nil, err
+	}
+
+	typeResponse := &types.NsxtAlbConfig{}
+	err = client.OpenApiGetItem(apiVersion, urlRef, nil, &typeResponse, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return typeResponse, nil
+}
+
+// UpdateAlbSettings updates NSX-T ALB settings for a particular Edge Gateway
+func (egw *NsxtEdgeGateway) UpdateAlbSettings(config *types.NsxtAlbConfig) (*types.NsxtAlbConfig, error) {
+	client := egw.client
+	endpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointEdgeGatewayAlb
+	apiVersion, err := client.getOpenApiHighestElevatedVersion(endpoint)
+	if err != nil {
+		return nil, err
+	}
+
+	urlRef, err := client.OpenApiBuildEndpoint(fmt.Sprintf(endpoint, egw.EdgeGateway.ID))
+	if err != nil {
+		return nil, err
+	}
+
+	typeResponse := &types.NsxtAlbConfig{}
+	err = client.OpenApiPutItem(apiVersion, urlRef, nil, config, typeResponse, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return typeResponse, nil
+}
+
+// DisableAlb is a shortcut wrapping UpdateAlbSettings which disables ALB configuration
+func (egw *NsxtEdgeGateway) DisableAlb() error {
+	config := &types.NsxtAlbConfig{
+		Enabled: false,
+	}
+	_, err := egw.UpdateAlbSettings(config)
+	if err != nil {
+		return fmt.Errorf("error disabling NSX-T ALB: %s", err)
+	}
+
+	return nil
+}

govcd/nsxt_alb_settings_test.go

@@ -0,0 +1,77 @@
+//go:build nsxt || alb || functional || ALL
+// +build nsxt alb functional ALL
+
+package govcd
+
+import (
+	"fmt"
+
+	"github.com/vmware/go-vcloud-director/v2/types/v56"
+
+	. "gopkg.in/check.v1"
+)
+
+func (vcd *TestVCD) Test_GetAlbSettings(check *C) {
+	skipNoNsxtAlbConfiguration(vcd, check)
+	skipOpenApiEndpointTest(vcd, check, types.OpenApiPathVersion1_0_0+types.OpenApiEndpointEdgeGatewayAlb)
+
+	edge, err := vcd.nsxtVdc.GetNsxtEdgeGatewayByName(vcd.config.VCD.Nsxt.EdgeGateway)
+	check.Assert(err, IsNil)
+
+	albSettings, err := edge.GetAlbSettings()
+	check.Assert(err, IsNil)
+	check.Assert(albSettings, NotNil)
+	check.Assert(albSettings.Enabled, Equals, false)
+}
+
+func (vcd *TestVCD) Test_UpdateAlbSettings(check *C) {
+	if vcd.skipAdminTests {
+		check.Skip(fmt.Sprintf(TestRequiresSysAdminPrivileges, check.TestName()))
+	}
+	skipNoNsxtAlbConfiguration(vcd, check)
+	skipOpenApiEndpointTest(vcd, check, types.OpenApiPathVersion1_0_0+types.OpenApiEndpointEdgeGatewayAlb)
+
+	controller, cloud, seGroup := spawnAlbControllerCloudServiceEngineGroup(vcd, check)
+	edge, err := vcd.nsxtVdc.GetNsxtEdgeGatewayByName(vcd.config.VCD.Nsxt.EdgeGateway)
+	check.Assert(err, IsNil)
+
+	// Enable ALB on Edge Gateway with default ServiceNetworkDefinition
+	albSettingsConfig := &types.NsxtAlbConfig{
+		Enabled: true,
+	}
+	enabledSettings, err := edge.UpdateAlbSettings(albSettingsConfig)
+	check.Assert(err, IsNil)
+	check.Assert(enabledSettings.Enabled, Equals, true)
+	check.Assert(enabledSettings.ServiceNetworkDefinition, Equals, "192.168.255.1/25")
+
+	// Disable ALB on Edge Gateway
+	albSettingsConfig.Enabled = false
+	disabledSettings, err := edge.UpdateAlbSettings(albSettingsConfig)
+	check.Assert(err, IsNil)
+	check.Assert(disabledSettings.Enabled, Equals, false)
+
+	// Enable ALB on Edge Gateway with custom ServiceNetworkDefinition
+	albSettingsConfig.Enabled = true
+	albSettingsConfig.ServiceNetworkDefinition = "93.93.11.1/25"
+	enabledSettingsCustomServiceDefinition, err := edge.UpdateAlbSettings(albSettingsConfig)
+	check.Assert(err, IsNil)
+	check.Assert(enabledSettingsCustomServiceDefinition.Enabled, Equals, true)
+	check.Assert(enabledSettingsCustomServiceDefinition.ServiceNetworkDefinition, Equals, "93.93.11.1/25")
+
+	// Disable ALB on Edge Gateway again and ensure it was disabled
+	err = edge.DisableAlb()
+	check.Assert(err, IsNil)
+
+	albSettings, err := edge.GetAlbSettings()
+	check.Assert(err, IsNil)
+	check.Assert(albSettings, NotNil)
+	check.Assert(albSettings.Enabled, Equals, false)
+
+	// Remove objects
+	err = seGroup.Delete()
+	check.Assert(err, IsNil)
+	err = cloud.Delete()
+	check.Assert(err, IsNil)
+	err = controller.Delete()
+	check.Assert(err, IsNil)
+}

govcd/openapi_endpoints.go

@@ -50,6 +50,7 @@ var endpointMinApiVersions = map[string]string{
 	types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointAlbImportableServiceEngineGroups: "35.0", // VCD 10.2+
 	types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointAlbCloud:                         "35.0", // VCD 10.2+
 	types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointAlbServiceEngineGroups:           "35.0", // VCD 10.2+
+	types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointEdgeGatewayAlb:                   "35.0", // VCD 10.2+
 }
 
 // elevateNsxtNatRuleApiVersion helps to elevate API version to consume newer NSX-T NAT Rule features

types/v56/constants.go

@@ -366,6 +366,8 @@ const (
 	OpenApiEndpointAlbImportableServiceEngineGroups = "nsxAlbResources/importableServiceEngineGroups"
 	OpenApiEndpointAlbCloud                         = "loadBalancer/clouds/"
 	OpenApiEndpointAlbServiceEngineGroups           = "loadBalancer/serviceEngineGroups/"
+
+	OpenApiEndpointEdgeGatewayAlb = "edgeGateways/%s/loadBalancer"
 )
 
 // Header keys to run operations in tenant context

types/v56/nsxt_types.go

@@ -813,3 +813,21 @@ type NsxtAlbImportableServiceEngineGroups struct {
 	// HaMode (e.g. 'ELASTIC_N_PLUS_M_BUFFER')
 	HaMode string `json:"haMode"`
 }
+
+// NsxtAlbConfig describes Load Balancer Service configuration on an NSX-T Edge Gateway
+type NsxtAlbConfig struct {
+	// Enabled is a mandatory flag indicating whether Load Balancer Service is enabled or not
+	Enabled bool `json:"enabled"`
+	// LicenseType of the backing Load Balancer Cloud.
+	// * BASIC - Basic edition of the NSX Advanced Load Balancer.
+	// * ENTERPRISE - Full featured edition of the NSX Advanced Load Balancer.
+	LicenseType string `json:"licenseType,omitempty"`
+	// LoadBalancerCloudRef
+	LoadBalancerCloudRef *OpenApiReference `json:"loadBalancerCloudRef,omitempty"`
+
+	// ServiceNetworkDefinition in Gateway CIDR format which will be used by Load Balancer service. All the load balancer
+	// service engines associated with the Service Engine Group will be attached to this network. The subnet prefix length
+	// must be 25. If nothing is set, the default is 192.168.255.1/25. Default CIDR can be configured. This field cannot
+	// be updated.
+	ServiceNetworkDefinition string `json:"serviceNetworkDefinition,omitempty"`
+}