feat: Add additionalCategories field to Nutanix machine details patch (#525)

Adds the `additionalCategories` field to the Nutanix machine details
patch.

Fixes https://jira.nutanix.com/browse/D2IQ-100464

Author: dlipovetsky

api/v1alpha1/nutanix_node_types.go

@@ -51,6 +51,11 @@ type NutanixMachineDetails struct {
 	// The identifier (uuid or name) can be obtained from the console or API.
 	Subnets []NutanixResourceIdentifier `json:"subnets"`
 
+	// List of categories that need to be added to the machines. Categories must already
+	// exist in Prism Central. One category key can have more than one value.
+	// +optional
+	AdditionalCategories []NutanixCategoryIdentifier `json:"additionalCategories,omitempty"`
+
 	// Defines the boot type of the virtual machine. Only supports UEFI and Legacy
 	BootType NutanixBootType `json:"bootType,omitempty"`
 
@@ -93,6 +98,12 @@ func (NutanixMachineDetails) VariableSchema() clusterv1.VariableSchema {
 						"subnet identifies the network subnet to use for the machine. The identifier (uuid or name) can be obtained from the console or API.",
 					).OpenAPIV3Schema),
 				},
+				"additionalCategories": {
+					Type: "array",
+					//nolint:lll // Description is long.
+					Description: "List of categories that need to be added to the machines. Categories must already exist in Prism Central. One category key can have more than one value.",
+					Items:       ptr.To(NutanixCategoryIdentifier{}.VariableSchema().OpenAPIV3Schema),
+				},
 				"bootType": NutanixBootType(
 					capxv1.NutanixBootTypeLegacy,
 				).VariableSchema().
@@ -173,3 +184,24 @@ func (NutanixResourceIdentifier) VariableSchemaFromDescription(
 		},
 	}
 }
+
+type NutanixCategoryIdentifier capxv1.NutanixCategoryIdentifier
+
+func (NutanixCategoryIdentifier) VariableSchema() clusterv1.VariableSchema {
+	return clusterv1.VariableSchema{
+		OpenAPIV3Schema: clusterv1.JSONSchemaProps{
+			Description: "Nutanix Category Identifier",
+			Type:        "object",
+			Properties: map[string]clusterv1.JSONSchemaProps{
+				"key": {
+					Type:        "string",
+					Description: "key is the Key of category in PC.",
+				},
+				"value": {
+					Type:        "string",
+					Description: "value is the category value linked to the category key in PC.",
+				},
+			},
+		},
+	}
+}

api/v1alpha1/zz_generated.deepcopy.go

@@ -50,6 +50,9 @@ spec:
               subnets:
               - name: subnet-name
                 type: name
+              additionalCategories:
+              - key: example-key
+                value: example-value
               systemDiskSize: 40Gi
               vcpuSockets: 2
               vcpusPerSocket: 1
@@ -79,6 +82,9 @@ spec:
       subnet:
       - name: subnet-name
         type: name
+      additionalCategories:
+      - key: example-key
+        value: example-value
       systemDiskSize: 40Gi
       vcpuSockets: 2
       vcpusPerSocket: 1
@@ -106,6 +112,9 @@ spec:
       subnet:
       - name: subnet-name
         type: name
+      additionalCategories:
+      - key: example-key
+        value: example-value
       systemDiskSize: 40Gi
       vcpuSockets: 2
       vcpusPerSocket: 1

docs/content/customization/nutanix/machine-details.md

@@ -108,6 +108,14 @@ func (h *nutanixMachineDetailsPatchHandler) Mutate(
 				spec.Subnets[i] = capxv1.NutanixResourceIdentifier(subnet)
 			}
 
+			spec.AdditionalCategories = make(
+				[]capxv1.NutanixCategoryIdentifier,
+				len(nutanixMachineDetailsVar.AdditionalCategories),
+			)
+			for i, category := range nutanixMachineDetailsVar.AdditionalCategories {
+				spec.AdditionalCategories[i] = capxv1.NutanixCategoryIdentifier(category)
+			}
+
 			obj.Spec.Template.Spec = spec
 			return nil
 		},

pkg/handlers/nutanix/mutation/machinedetails/inject.go

@@ -41,6 +41,16 @@ var (
 				Name: ptr.To("fake-subnet"),
 			},
 		},
+		AdditionalCategories: []v1alpha1.NutanixCategoryIdentifier{
+			{
+				Key:   "fake-key",
+				Value: "fake-value",
+			},
+			{
+				Key:   "fake-key2",
+				Value: "fake-value2",
+			},
+		},
 	}
 
 	matchersForAllFieldsSet = []capitest.JSONPatchMatcher{
@@ -94,6 +104,20 @@ var (
 			Path:         "/spec/template/spec/subnet",
 			ValueMatcher: gomega.HaveLen(1),
 		},
+		{
+			Operation: "add",
+			Path:      "/spec/template/spec/additionalCategories",
+			ValueMatcher: gomega.ContainElements(
+				gomega.SatisfyAll(
+					gomega.HaveKeyWithValue("key", "fake-key"),
+					gomega.HaveKeyWithValue("value", "fake-value"),
+				),
+				gomega.SatisfyAll(
+					gomega.HaveKeyWithValue("key", "fake-key2"),
+					gomega.HaveKeyWithValue("value", "fake-value2"),
+				),
+			),
+		},
 	}
 )
 

pkg/handlers/nutanix/mutation/machinedetails/inject_control_plane_test.go

@@ -45,6 +45,16 @@ func TestVariableValidation(t *testing.T) {
 							MemorySize:     resource.MustParse("8Gi"),
 							SystemDiskSize: resource.MustParse("40Gi"),
 							Subnets:        []v1alpha1.NutanixResourceIdentifier{},
+							AdditionalCategories: []v1alpha1.NutanixCategoryIdentifier{
+								{
+									Key:   "fake-key",
+									Value: "fake-value1",
+								},
+								{
+									Key:   "fake-key",
+									Value: "fake-value2",
+								},
+							},
 						},
 					},
 				},