Merge pull request openshift#7905 from openshift-splat-team/SPLAT-1387

SPLAT-1387: enable additional tags to be associated with vsphere machines

Author: openshift-merge-bot[bot]

data/data/install.openshift.io_installconfigs.yaml

@@ -4420,6 +4420,14 @@ spec:
                               minLength: 1
                               pattern: ^/.*?/host/.*?/Resources.*
                               type: string
+                            tagIDs:
+                              description: tagIDs is an optional set of tags to add
+                                to an instance. Specified tagIDs must use URN-notation
+                                instead of display names. A maximum of 10 tag IDs
+                                may be specified.
+                              items:
+                                type: string
+                              type: array
                             template:
                               description: template is the inventory path of the virtual
                                 machine or template that will be used for cloning.

go.mod

@@ -58,7 +58,7 @@ require (
 	github.com/microsoftgraph/msgraph-sdk-go v0.47.0
 	github.com/nutanix-cloud-native/prism-go-client v0.2.1-0.20220804130801-c8a253627c64
 	github.com/onsi/gomega v1.29.0
-	github.com/openshift/api v0.0.0-20240104110125-c7a2d3b41e1f
+	github.com/openshift/api v0.0.0-20240115183315-0793e918179d
 	github.com/openshift/assisted-image-service v0.0.0-20230829160050-0b98ec74397b
 	github.com/openshift/assisted-service/api v0.0.0
 	github.com/openshift/assisted-service/client v0.0.0

go.sum

@@ -1919,8 +1919,8 @@ github.com/opencontainers/selinux v1.10.1/go.mod h1:2i0OySw99QjzBBQByd1Gr9gSjvuh
 github.com/openshift/api v0.0.0-20200326160804-ecb9283fe820/go.mod h1:RKMJ5CBnljLfnej+BJ/xnOWc3kZDvJUaIAEq2oKSPtE=
 github.com/openshift/api v0.0.0-20200827090112-c05698d102cf/go.mod h1:M3xexPhgM8DISzzRpuFUy+jfPjQPIcs9yqEYj17mXV8=
 github.com/openshift/api v0.0.0-20200829102639-8a3a835f1acf/go.mod h1:M3xexPhgM8DISzzRpuFUy+jfPjQPIcs9yqEYj17mXV8=
-github.com/openshift/api v0.0.0-20240104110125-c7a2d3b41e1f h1:3BMVfQpz1xe8MmJprp1+NL8hrpl9I04JVP9EczdCOqE=
-github.com/openshift/api v0.0.0-20240104110125-c7a2d3b41e1f/go.mod h1:CxgbWAlvu2iQB0UmKTtRu1YfepRg1/vJ64n2DlIEVz4=
+github.com/openshift/api v0.0.0-20240115183315-0793e918179d h1:gtwDqGPf5QmsV8jvOUoDNbtyeby9QeLdsybNQ8mGqHQ=
+github.com/openshift/api v0.0.0-20240115183315-0793e918179d/go.mod h1:CxgbWAlvu2iQB0UmKTtRu1YfepRg1/vJ64n2DlIEVz4=
 github.com/openshift/assisted-image-service v0.0.0-20230829160050-0b98ec74397b h1:wLVEgmzQjs3t4Z96gZzSLF/ws6ULliAks7z1lozNJrE=
 github.com/openshift/assisted-image-service v0.0.0-20230829160050-0b98ec74397b/go.mod h1:KTt/pnfs9gt0McDPrb0zVTkwd0xIFNik/ZJROIBzsbc=
 github.com/openshift/assisted-service/api v0.0.0-20230831114549-1922eda29cf8 h1:+fZLKbycDo4JeLwPGVSAgf2XPaJGLM341l9ZfrrlxG0=

pkg/asset/machines/vsphere/machines.go

@@ -247,6 +247,7 @@ func provider(clusterID string, vcenter *vsphere.VCenter, failureDomain vsphere.
 			Folder:       folder,
 			ResourcePool: resourcePool,
 		},
+		TagIDs:            failureDomain.Topology.TagIDs,
 		NumCPUs:           mpool.NumCPUs,
 		NumCoresPerSocket: mpool.NumCoresPerSocket,
 		MemoryMiB:         mpool.MemoryMiB,

pkg/types/vsphere/platform.go

@@ -212,6 +212,11 @@ type Topology struct {
 	// +kubebuilder:validation:Pattern=`^/.*?/vm/.*?`
 	// +optional
 	Template string `json:"template,omitempty"`
+	// tagIDs is an optional set of tags to add to an instance. Specified tagIDs
+	// must use URN-notation instead of display names. A maximum of 10 tag IDs may be specified.
+	// +kubebuilder:example=urn:vmomi:InventoryServiceTag:5736bf56-49f5-4667-b38c-b97e09dc9578:GLOBAL
+	// +optional
+	TagIDs []string `json:"tagIDs,omitempty"`
 }
 
 // VCenter stores the vCenter connection fields

pkg/types/vsphere/validation/platform.go

@@ -117,6 +117,7 @@ func validateVCenters(p *vsphere.Platform, fldPath *field.Path) field.ErrorList
 
 func validateFailureDomains(p *vsphere.Platform, fldPath *field.Path, isLegacyUpi bool) field.ErrorList {
 	var fdNames []string
+	tagUrnPattern := regexp.MustCompile(`^(urn):(vmomi):(InventoryServiceTag):([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}):([^:]+)$`)
 	allErrs := field.ErrorList{}
 	topologyFld := fldPath.Child("topology")
 	var associatedVCenter *vsphere.VCenter
@@ -172,6 +173,16 @@ func validateFailureDomains(p *vsphere.Platform, fldPath *field.Path, isLegacyUp
 			}
 		}
 
+		if len(failureDomain.Topology.TagIDs) > 10 {
+			allErrs = append(allErrs, field.Invalid(topologyFld.Child("tagIDs"), failureDomain.Topology.TagIDs, "a maximum of 10 tags are allowed"))
+		}
+
+		for _, tagID := range failureDomain.Topology.TagIDs {
+			if tagUrnPattern.FindStringSubmatch(tagID) == nil {
+				allErrs = append(allErrs, field.Invalid(topologyFld.Child("tagIDs"), failureDomain.Topology.TagIDs, "tag ID must be in the format of urn:vmomi:InventoryServiceTag:<UUID>:GLOBAL"))
+			}
+		}
+
 		if len(failureDomain.Topology.Networks) == 0 {
 			if isLegacyUpi {
 				logrus.Warn("network field empty is now deprecated, in later releases this field will be required.")

pkg/types/vsphere/validation/platform_test.go

@@ -194,6 +194,29 @@ func TestValidatePlatform(t *testing.T) {
 			}(),
 			expectedError: `^test-path\.diskType: Invalid value: "invalidDiskType": diskType must be one of \[eagerZeroedThick thick thin\]$`,
 		},
+		{
+			name: "Additional tag IDs provided",
+			platform: func() *vsphere.Platform {
+				p := validPlatform()
+				p.FailureDomains[0].Topology.TagIDs = []string{
+					"urn:vmomi:InventoryServiceTag:5736bf56-49f5-4667-b38c-b97e09dc9578:GLOBAL",
+					"urn:vmomi:InventoryServiceTag:5736bf56-49f5-4667-b38c-b97e09dc9579:GLOBAL",
+				}
+				return p
+			}(),
+		},
+		{
+			name: "Additional invalid tag IDs provided",
+			platform: func() *vsphere.Platform {
+				p := validPlatform()
+				p.FailureDomains[0].Topology.TagIDs = []string{
+					"urn:bad:InventoryServiceTag:5736bf56-49f5-4667-b38c-b97e09dc9578:GLOBAL",
+					"urn:bad:InventoryServiceTag:5736bf56-49f5-4667-b38c-b97e09dc9579:GLOBAL",
+				}
+				return p
+			}(),
+			expectedError: `^test-path\.failureDomains\.topology\.tagIDs\: Invalid value\:.*?: tag ID must be in the format of urn\:vmomi\:InventoryServiceTag\:<UUID>\:GLOBAL$`,
+		},
 
 		{
 			name:     "Valid Multi-zone platform",