Merge pull request #630 from eshulman2/mdata

Add metadata to server controller

Author: mandre

api/v1alpha1/server_types.go

@@ -181,6 +181,27 @@ type ServerResourceSpec struct {
 	// +listType=set
 	// +optional
 	Tags []ServerTag `json:"tags,omitempty"`
+
+	// metadata is a list of metadata key-value pairs which will be set on the server.
+	// +kubebuilder:validation:MaxItems:=128
+	// +listType=atomic
+	// +optional
+	Metadata []ServerMetadata `json:"metadata,omitempty"`
+}
+
+// ServerMetadata represents a key-value pair for server metadata.
+type ServerMetadata struct {
+	// key is the metadata key.
+	// +kubebuilder:validation:MinLength:=1
+	// +kubebuilder:validation:MaxLength:=255
+	// +required
+	Key string `json:"key,omitempty"`
+
+	// value is the metadata value.
+	// +kubebuilder:validation:MaxLength:=255
+	// +kubebuilder:validation:MinLength:=1
+	// +required
+	Value string `json:"value,omitempty"`
 }
 
 // +kubebuilder:validation:MinProperties:=1
@@ -261,4 +282,23 @@ type ServerResourceStatus struct {
 	// +listType=atomic
 	// +optional
 	Tags []string `json:"tags,omitempty"`
+
+	// metadata is the list of metadata key-value pairs on the resource.
+	// +kubebuilder:validation:MaxItems:=128
+	// +listType=atomic
+	// +optional
+	Metadata []ServerMetadataStatus `json:"metadata,omitempty"`
+}
+
+// ServerMetadataStatus represents a key-value pair for server metadata in status.
+type ServerMetadataStatus struct {
+	// key is the metadata key.
+	// +kubebuilder:validation:MaxLength:=255
+	// +optional
+	Key string `json:"key,omitempty"`
+
+	// value is the metadata value.
+	// +kubebuilder:validation:MaxLength:=255
+	// +optional
+	Value string `json:"value,omitempty"`
 }

api/v1alpha1/zz_generated.deepcopy.go

@@ -231,6 +231,30 @@ spec:
                     x-kubernetes-validations:
                     - message: keypairRef is immutable
                       rule: self == oldSelf
+                  metadata:
+                    description: metadata is a list of metadata key-value pairs which
+                      will be set on the server.
+                    items:
+                      description: ServerMetadata represents a key-value pair for
+                        server metadata.
+                      properties:
+                        key:
+                          description: key is the metadata key.
+                          maxLength: 255
+                          minLength: 1
+                          type: string
+                        value:
+                          description: value is the metadata value.
+                          maxLength: 255
+                          minLength: 1
+                          type: string
+                      required:
+                      - key
+                      - value
+                      type: object
+                    maxItems: 128
+                    type: array
+                    x-kubernetes-list-type: atomic
                   name:
                     description: |-
                       name will be the name of the created resource. If not specified, the
@@ -488,6 +512,25 @@ spec:
                     maxItems: 64
                     type: array
                     x-kubernetes-list-type: atomic
+                  metadata:
+                    description: metadata is the list of metadata key-value pairs
+                      on the resource.
+                    items:
+                      description: ServerMetadataStatus represents a key-value pair
+                        for server metadata in status.
+                      properties:
+                        key:
+                          description: key is the metadata key.
+                          maxLength: 255
+                          type: string
+                        value:
+                          description: value is the metadata value.
+                          maxLength: 255
+                          type: string
+                      type: object
+                    maxItems: 128
+                    type: array
+                    x-kubernetes-list-type: atomic
                   name:
                     description: name is the human-readable name of the resource.
                       Might not be unique.

cmd/models-schema/zz_generated.openapi.go

@@ -20,3 +20,8 @@ spec:
     tags:
       - tag1
       - tag2
+    metadata:
+      - key: environment
+        value: development
+      - key: owner
+        value: sample

config/crd/bases/openstack.k-orc.cloud_servers.yaml

@@ -249,13 +249,19 @@ func (actuator serverActuator) CreateResource(ctx context.Context, obj *orcv1alp
 	// Sort tags before creation to simplify comparisons
 	slices.Sort(tags)
 
+	metadata := make(map[string]string)
+	for _, m := range resource.Metadata {
+		metadata[m.Key] = m.Value
+	}
+
 	serverCreateOpts := servers.CreateOpts{
 		Name:             getResourceName(obj),
 		ImageRef:         *image.Status.ID,
 		FlavorRef:        *flavor.Status.ID,
 		Networks:         portList,
 		UserData:         userData,
 		Tags:             tags,
+		Metadata:         metadata,
 		AvailabilityZone: resource.AvailabilityZone,
 	}
 
@@ -307,6 +313,7 @@ func (actuator serverActuator) GetResourceReconcilers(ctx context.Context, orcOb
 		actuator.checkStatus,
 		actuator.updateResource,
 		actuator.reconcileTags,
+		actuator.reconcileMetadata,
 		actuator.reconcilePortAttachments,
 		actuator.reconcileVolumeAttachments,
 	}, nil
@@ -393,6 +400,39 @@ func (actuator serverActuator) reconcileTags(ctx context.Context, obj orcObjectP
 	return tags.ReconcileTags[orcObjectPT, osResourceT](obj.Spec.Resource.Tags, ptr.Deref(osResource.Tags, []string{}), tags.NewServerTagReplacer(actuator.osClient, osResource.ID))(ctx, obj, osResource)
 }
 
+func (actuator serverActuator) reconcileMetadata(ctx context.Context, obj orcObjectPT, osResource *osResourceT) progress.ReconcileStatus {
+	log := ctrl.LoggerFrom(ctx)
+	resource := obj.Spec.Resource
+	if resource == nil {
+		return progress.WrapError(
+			orcerrors.Terminal(orcv1alpha1.ConditionReasonInvalidConfiguration, "Update requested, but spec.resource is not set"))
+	}
+
+	// Metadata cannot be set on a server that is still building
+	if osResource.Status == "" || osResource.Status == ServerStatusBuild {
+		return progress.NewReconcileStatus().WaitingOnOpenStack(progress.WaitingOnReady, serverActivePollingPeriod)
+	}
+
+	// Build the desired metadata map from spec
+	desiredMetadata := make(map[string]string)
+	for _, m := range resource.Metadata {
+		desiredMetadata[m.Key] = m.Value
+	}
+
+	// Compare with current metadata
+	if maps.Equal(desiredMetadata, osResource.Metadata) {
+		return nil
+	}
+
+	log.V(logging.Verbose).Info("Updating server metadata")
+	_, err := actuator.osClient.ReplaceServerMetadata(ctx, osResource.ID, desiredMetadata)
+	if err != nil {
+		return progress.WrapError(err)
+	}
+
+	return progress.NeedsRefresh()
+}
+
 func (actuator serverActuator) reconcilePortAttachments(ctx context.Context, obj orcObjectPT, osResource *osResourceT) progress.ReconcileStatus {
 	log := ctrl.LoggerFrom(ctx)
 	resource := obj.Spec.Resource