Use key for SwiftContainer metadata entries

Author: eshulman2

api/v1alpha1/swiftcontainer_types.go

@@ -27,12 +27,12 @@ type SwiftContainerName string
 // SwiftContainerMetadata defines a key-value pair to be set as a Swift
 // container metadata header (X-Container-Meta-<key>: <value>).
 type SwiftContainerMetadata struct {
-	// name is the name of the metadata item. It will be used as the suffix of
+	// key is the key of the metadata item. It will be used as the suffix of
 	// the X-Container-Meta-* header.
 	// +kubebuilder:validation:MinLength:=1
 	// +kubebuilder:validation:MaxLength:=255
 	// +required
-	Name string `json:"name,omitempty"`
+	Key string `json:"key,omitempty"`
 
 	// value is the value of the metadata item.
 	// +kubebuilder:validation:MaxLength:=255
@@ -43,11 +43,11 @@ type SwiftContainerMetadata struct {
 // SwiftContainerMetadataStatus represents an observed metadata key-value pair
 // on a Swift container.
 type SwiftContainerMetadataStatus struct {
-	// name is the name of the metadata item.
+	// key is the key of the metadata item.
 	// +kubebuilder:validation:MinLength:=1
 	// +kubebuilder:validation:MaxLength:=255
 	// +required
-	Name string `json:"name,omitempty"`
+	Key string `json:"key,omitempty"`
 
 	// value is the value of the metadata item.
 	// +kubebuilder:validation:MaxLength:=255
@@ -103,7 +103,7 @@ type SwiftContainerResourceSpec struct {
 	// X-Container-Meta-* headers on the Swift container.
 	// +kubebuilder:validation:MaxItems:=64
 	// +listType=map
-	// +listMapKey=name
+	// +listMapKey=key
 	// +optional
 	Metadata []SwiftContainerMetadata `json:"metadata,omitempty"`
 
@@ -152,7 +152,7 @@ type SwiftContainerResourceStatus struct {
 	// metadata is the list of observed metadata key-value pairs on the container.
 	// +kubebuilder:validation:MaxItems:=64
 	// +listType=map
-	// +listMapKey=name
+	// +listMapKey=key
 	// +optional
 	Metadata []SwiftContainerMetadataStatus `json:"metadata,omitempty"`
 

cmd/models-schema/zz_generated.openapi.go

@@ -185,9 +185,9 @@ spec:
                         SwiftContainerMetadata defines a key-value pair to be set as a Swift
                         container metadata header (X-Container-Meta-<key>: <value>).
                       properties:
-                        name:
+                        key:
                           description: |-
-                            name is the name of the metadata item. It will be used as the suffix of
+                            key is the key of the metadata item. It will be used as the suffix of
                             the X-Container-Meta-* header.
                           maxLength: 255
                           minLength: 1
@@ -197,13 +197,13 @@ spec:
                           maxLength: 255
                           type: string
                       required:
-                      - name
+                      - key
                       - value
                       type: object
                     maxItems: 64
                     type: array
                     x-kubernetes-list-map-keys:
-                    - name
+                    - key
                     x-kubernetes-list-type: map
                   name:
                     description: |-
@@ -359,8 +359,8 @@ spec:
                         SwiftContainerMetadataStatus represents an observed metadata key-value pair
                         on a Swift container.
                       properties:
-                        name:
-                          description: name is the name of the metadata item.
+                        key:
+                          description: key is the key of the metadata item.
                           maxLength: 255
                           minLength: 1
                           type: string
@@ -369,12 +369,12 @@ spec:
                           maxLength: 255
                           type: string
                       required:
-                      - name
+                      - key
                       type: object
                     maxItems: 64
                     type: array
                     x-kubernetes-list-map-keys:
-                    - name
+                    - key
                     x-kubernetes-list-type: map
                   name:
                     description: name is the name of the Swift container.

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

@@ -12,9 +12,9 @@ spec:
     name: my-custom-bucket
     # metadata sets arbitrary key-value pairs as X-Container-Meta-* headers.
     metadata:
-      - name: owner
+      - key: owner
         value: myteam
-      - name: environment
+      - key: environment
         value: production
     # containerRead sets the X-Container-Read ACL. Use ".r:*" for public read access.
     containerRead: .r:*,.rlistings

examples/swiftcontainer/full.yaml

@@ -209,7 +209,7 @@ func (actuator swiftcontainerActuator) CreateResource(ctx context.Context, obj o
 	if len(resource.Metadata) > 0 {
 		metadata := make(map[string]string, len(resource.Metadata))
 		for _, m := range resource.Metadata {
-			metadata[m.Name] = m.Value
+			metadata[m.Key] = m.Value
 		}
 		createOpts.Metadata = metadata
 	}
@@ -322,7 +322,7 @@ func (actuator swiftcontainerActuator) reconcileMetadata(ctx context.Context, or
 	// in Swift).
 	desiredMetadata := make(map[string]string, len(resource.Metadata))
 	for _, m := range resource.Metadata {
-		desiredMetadata[strings.ToLower(m.Name)] = m.Value
+		desiredMetadata[strings.ToLower(m.Key)] = m.Value
 	}
 
 	// Find keys to add/update and keys to remove.

internal/controllers/swiftcontainer/actuator.go

@@ -396,8 +396,8 @@ func TestListOSResourcesForAdoption(t *testing.T) {
 		actuator := swiftcontainerActuator{client}
 		orcObject := newSwiftContainerObject("my-object", &orcv1alpha1.SwiftContainerResourceSpec{
 			Metadata: []orcv1alpha1.SwiftContainerMetadata{
-				{Name: "env", Value: "prod"},
-				{Name: "team", Value: "infra"},
+				{Key: "env", Value: "prod"},
+				{Key: "team", Value: "infra"},
 			},
 		})
 
@@ -471,8 +471,8 @@ func TestCreateResource(t *testing.T) {
 		orcObject := newSwiftContainerObject("full-container", &orcv1alpha1.SwiftContainerResourceSpec{
 			Name: ptr.To[orcv1alpha1.SwiftContainerName]("full-container"),
 			Metadata: []orcv1alpha1.SwiftContainerMetadata{
-				{Name: "project", Value: "orc"},
-				{Name: "env", Value: "test"},
+				{Key: "project", Value: "orc"},
+				{Key: "env", Value: "test"},
 			},
 			ContainerRead:  ".r:*",
 			ContainerWrite: "account:user",

internal/controllers/swiftcontainer/actuator_test.go

@@ -88,7 +88,7 @@ func (swiftcontainerStatusWriter) ApplyResourceStatus(_ logr.Logger, osResource
 		for _, k := range keys {
 			resourceStatus.WithMetadata(
 				orcapplyconfigv1alpha1.SwiftContainerMetadataStatus().
-					WithName(k).
+					WithKey(k).
 					WithValue(osResource.Metadata[k]),
 			)
 		}

internal/controllers/swiftcontainer/status.go

@@ -30,5 +30,5 @@ assertAll:
     - celExpr: "swiftcontainer.status.id != ''"
     - celExpr: "swiftcontainer.status.id == 'swiftcontainer-create-full-override'"
     - celExpr: "has(swiftcontainer.status.resource.metadata)"
-    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.name == 'Environment' && m.value == 'test')"
-    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.name == 'Owner' && m.value == 'orc-e2e')"
+    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.key == 'Environment' && m.value == 'test')"
+    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.key == 'Owner' && m.value == 'orc-e2e')"

internal/controllers/swiftcontainer/tests/swiftcontainer-create-full/00-assert.yaml

@@ -11,9 +11,9 @@ spec:
   resource:
     name: swiftcontainer-create-full-override
     metadata:
-      - name: environment
+      - key: environment
         value: test
-      - name: owner
+      - key: owner
         value: orc-e2e
     containerRead: ".r:*,.rlistings"
     containerWrite: "openstack:*"

internal/controllers/swiftcontainer/tests/swiftcontainer-create-full/00-create-resource.yaml

@@ -9,8 +9,8 @@ resourceRefs:
 assertAll:
     - celExpr: "swiftcontainer.status.id == 'swiftcontainer-update'"
     - celExpr: "has(swiftcontainer.status.resource.metadata)"
-    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.name == 'Environment' && m.value == 'staging')"
-    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.name == 'Team' && m.value == 'platform')"
+    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.key == 'Environment' && m.value == 'staging')"
+    - celExpr: "swiftcontainer.status.resource.metadata.exists(m, m.key == 'Team' && m.value == 'platform')"
     - celExpr: "swiftcontainer.status.resource.containerRead == '.r:*,.rlistings'"
     - celExpr: "swiftcontainer.status.resource.containerWrite == 'openstack:*'"
 ---