Add GM support to upgrade components

Support the upgrade of Global Manager using the Terraform provider.

Signed-off-by: Kobi Samoray <[email protected]>

Author: ksamoray

nsxt/resource_nsxt_upgrade_prepare.go

@@ -25,7 +25,8 @@ import (
 	"github.com/vmware/vsphere-automation-sdk-go/services/nsxt-mp/nsx/upgrade/pre_upgrade_checks"
 )
 
-var precheckComponentTypes = []string{"EDGE", "HOST", "MP"}
+var lmPrecheckComponentTypes = []string{"EDGE", "HOST", "MP"}
+var gmPrecheckComponentTypes = []string{"MP"}
 
 const bundleUploadTimeout int = 3600
 const ucUpgradeTimeout int = 3600
@@ -399,7 +400,7 @@ func executePreupgradeChecks(d *schema.ResourceData, m interface{}) error {
 		return err
 	}
 	timeout := d.Get("precheck_timeout").(int)
-	for _, componentType := range precheckComponentTypes {
+	for _, componentType := range getPrecheckComponentTypes(m) {
 		log.Printf("Execute pre-upgrade check on %s", componentType)
 		err = waitForPrecheckComplete(m, componentType, timeout)
 		if err != nil {
@@ -409,6 +410,13 @@ func executePreupgradeChecks(d *schema.ResourceData, m interface{}) error {
 	return nil
 }
 
+func getPrecheckComponentTypes(m interface{}) []string {
+	if isPolicyGlobalManager(m) {
+		return gmPrecheckComponentTypes
+	}
+	return lmPrecheckComponentTypes
+}
+
 func getPrecheckErrors(m interface{}, typeParam *string) ([]nsxModel.UpgradeCheckFailure, error) {
 	connector := getPolicyConnector(m)
 	client := pre_upgrade_checks.NewFailuresClient(connector)

nsxt/resource_nsxt_upgrade_run.go

@@ -35,6 +35,10 @@ var upgradeComponentListPost9 = []string{
 	finalizeUpgradeGroup,
 }
 
+var upgradeComponentListGlobalManager = []string{
+	mpUpgradeGroup,
+}
+
 var postCheckComponentList = []string{
 	edgeUpgradeGroup,
 	hostUpgradeGroup,
@@ -52,6 +56,7 @@ var componentToSettingKey = map[string]string{
 
 var supportedUpgradeMode = []string{"maintenance_mode", "in_place", "stage_in_vlcm"}
 var supportedMaintenanceModeConfigVsanMode = []string{"evacuate_all_data", "ensure_object_accessibility", "no_action"}
+var lmOnlyAttributes = []string{"edge_group", "host_group", "finalize_upgrade_setting", "edge_upgrade_setting", "host_upgrade_setting"}
 
 var (
 	// Default waiting setup in seconds
@@ -100,7 +105,10 @@ func getTargetVersion(m interface{}) (string, error) {
 	return *obj.TargetVersion, nil
 }
 
-func getUpgradeComponentList(targetVersion string) []string {
+func getUpgradeComponentList(targetVersion string, m interface{}) []string {
+	if isPolicyGlobalManager(m) {
+		return upgradeComponentListGlobalManager
+	}
 	if util.VersionHigherOrEqual(targetVersion, "9.0.0") {
 		return upgradeComponentListPost9
 	}
@@ -412,6 +420,15 @@ func upgradeRunCreateOrUpdate(d *schema.ResourceData, m interface{}) error {
 		id = newUUID()
 	}
 
+	// Fail if upgrade groups are configured for global manager
+	if isPolicyGlobalManager(m) {
+		for _, attr := range lmOnlyAttributes {
+			if d.HasChange(attr) {
+				return fmt.Errorf("attribute %s is not supported for Global Manager", attr)
+			}
+		}
+	}
+
 	// Validate that upgrade_prepare_id is actually from the nsxt_upgrade_prepare_ready data source
 	upgradePrepareReadyID := d.Get("upgrade_prepare_ready_id").(string)
 	if !util.VerifyVerifiableID(upgradePrepareReadyID, "nsxt_upgrade_prepare_ready") {
@@ -427,7 +444,7 @@ func upgradeRunCreateOrUpdate(d *schema.ResourceData, m interface{}) error {
 
 	log.Printf("[INFO] Updating UpgradeUnitGroup and UpgradePlanSetting.")
 	var hasVLCM bool
-	err = prepareUpgrade(upgradeClientSet, d, targetVersion, &hasVLCM)
+	err = prepareUpgrade(upgradeClientSet, d, m, targetVersion, &hasVLCM)
 	if err != nil {
 		return handleCreateError("NsxtUpgradeRun", id, err)
 	}
@@ -442,7 +459,7 @@ func upgradeRunCreateOrUpdate(d *schema.ResourceData, m interface{}) error {
 		}
 	}
 
-	err = runUpgrade(upgradeClientSet, getPartialUpgradeMap(d, targetVersion), targetVersion, hasVLCM, finalizeUpgrade)
+	err = runUpgrade(upgradeClientSet, m, getPartialUpgradeMap(d, m, targetVersion), targetVersion, hasVLCM, finalizeUpgrade)
 	if err != nil {
 		return handleCreateError("NsxtUpgradeRun", id, err)
 	}
@@ -453,8 +470,8 @@ func upgradeRunCreateOrUpdate(d *schema.ResourceData, m interface{}) error {
 	return resourceNsxtUpgradeRunRead(d, m)
 }
 
-func prepareUpgrade(upgradeClientSet *upgradeClientSet, d *schema.ResourceData, targetVersion string, hasVLCM *bool) error {
-	for _, component := range getUpgradeComponentList(targetVersion) {
+func prepareUpgrade(upgradeClientSet *upgradeClientSet, d *schema.ResourceData, m interface{}, targetVersion string, hasVLCM *bool) error {
+	for _, component := range getUpgradeComponentList(targetVersion, m) {
 		// Customize MP upgrade is not allowed
 		if component == mpUpgradeGroup || component == finalizeUpgradeGroup {
 			continue
@@ -515,12 +532,12 @@ func prepareUpgrade(upgradeClientSet *upgradeClientSet, d *schema.ResourceData,
 	return nil
 }
 
-func getPartialUpgradeMap(d *schema.ResourceData, targetVersion string) map[string]bool {
+func getPartialUpgradeMap(d *schema.ResourceData, m interface{}, targetVersion string) map[string]bool {
 	isPartialUpgradeMap := map[string]bool{
 		edgeUpgradeGroup: false,
 		hostUpgradeGroup: false,
 	}
-	for _, component := range getUpgradeComponentList(targetVersion) {
+	for _, component := range getUpgradeComponentList(targetVersion, m) {
 		if component == mpUpgradeGroup || component == finalizeUpgradeGroup {
 			continue
 		}
@@ -808,10 +825,10 @@ func updateComponentUpgradePlanSetting(settingClient plan.SettingsClient, d *sch
 	return err
 }
 
-func runUpgrade(upgradeClientSet *upgradeClientSet, partialUpgradeMap map[string]bool, targetVersion string, hasVLCM, finalizeUpgrade bool) error {
+func runUpgrade(upgradeClientSet *upgradeClientSet, m interface{}, partialUpgradeMap map[string]bool, targetVersion string, hasVLCM, finalizeUpgrade bool) error {
 	partialUpgradeExist := false
 	prevComponent := ""
-	for _, c := range getUpgradeComponentList(targetVersion) {
+	for _, c := range getUpgradeComponentList(targetVersion, m) {
 		component := c
 		if !finalizeUpgrade && component == finalizeUpgradeGroup {
 			continue

website/docs/guides/upgrade.html.markdown

@@ -192,6 +192,47 @@ When the ESXi software is not upgraded, the finalization stage will fail. There
 the NSX management plane, the Edge appliances and the NSX bits on the ESXi hosts, and postpone the ESXi OS upgrade to 
 a later time.
 
+### Upgrading Global Manager
+
+NSX Global Manager upgrade is similar to Local Manager. Yet, Global Manager has no Edge or Host components and therefore
+Doesn't allow the configuration of these components in upgrade groups in the `nsxt_upgrade_run` resource.
+
+The example below uses Terraform to upgrade a Global Manager.
+
+```hcl
+provider "nsxt" {
+  host                 = "global.manager.somedomain.org"
+  username             = "admin"
+  password             = "AdminPassword"
+  allow_unverified_ssl = true
+  global_manager       = true // This is required to indicate that we upgrade a Global Manager
+}
+
+resource "nsxt_upgrade_prepare" "gm_prepare_res" {
+  upgrade_bundle_url    = var.upgrade_bundle_url
+  accept_user_agreement = true
+}
+
+resource "nsxt_upgrade_precheck_acknowledge" "gm_precheck_ack" {
+  provider = nsxt.gm_nsxt
+
+  precheck_ids   = var.gm_precheck_warns
+  target_version = nsxt_upgrade_prepare.gm_prepare_res.target_version
+}
+
+data "nsxt_upgrade_prepare_ready" "gm_ready" {
+  provider = nsxt.gm_nsxt
+
+  upgrade_prepare_id = nsxt_upgrade_prepare.gm_prepare_res.id
+  depends_on         = [nsxt_upgrade_precheck_acknowledge.gm_precheck_ack]
+}
+
+resource "nsxt_upgrade_run" "gm_run" {
+  provider                 = nsxt.gm_nsxt
+  upgrade_prepare_ready_id = data.nsxt_upgrade_prepare_ready.gm_ready.id
+}
+```
+
 ### Post upgrade checks
 
 Upgrade post check data sources can be used to examine the results of the edge and host upgrades, to conclude if the 

website/docs/r/upgrade_run.html.markdown

@@ -93,12 +93,15 @@ The following arguments are supported:
 * `timeout` - (Optional) Upgrade status check timeout in seconds. Default: 3600 seconds.
 * `interval` - (Optional) Interval to check upgrade status in seconds. Default: 30 seconds.
 * `delay` - (Optional) Initial delay to start upgrade status checks in seconds. Default: 300 seconds. 
+* `max_retries` - (Optional) Maximum number of retries before failing the upgrade operation. Default: 100. 
+
+**NOTE:** With Global Manager, `edge_group`, `host_group`, `finalize_upgrade_setting`, `edge_upgrade_setting`, `host_upgrade_setting` attributes are not supported.
 
 ## Argument Reference
 
 In addition to arguments listed above, the following attributes are exported:
 
-* `upgrade_plan` - (Computed) Upgrade plan for current upgrade. Upgrade unit groups that are not defined in `edge_group` or `host_group` will also be included here.
+* `upgrade_group_plan` - (Computed) Upgrade plan for current upgrade. Upgrade unit groups that are not defined in `edge_group` or `host_group` will also be included here.
     * `type` - Component type.
     * `id` - ID of the upgrade unit group.
     * `enabled` - Flag to indicate whether upgrade of this group is enabled or not.