[wip]OPRUN-4764: CSV: Extend RelatedImage with labels

crds/operators.coreos.com_clusterserviceversions.yaml

@@ -9048,6 +9048,24 @@ spec:
                     properties:
                       image:
                         type: string
+                      labels:
+                        description: |-
+                          Map of string keys and values that can be used to organize and categorize
+                          (scope and select) this related image, for instance, by the product features it belongs to.
+                          Keys and values follow the Kubernetes label syntax and constraints, see
+                          https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set.
+                          The semantics of the labels is defined by their consumer, which typically picks related images with
+                          Kubernetes label selectors. The first consumer is `oc-mirror`, see
+                          https://github.com/openshift/oc-mirror/blob/main/README.md for how it selects the related images to mirror.
+                          Labeling a related image makes it optional for mirroring: `oc-mirror` mirrors it only if the entry for its
+                          package in the ImageSetConfiguration carries a selector that matches the labels. If that package entry has
+                          no matching selector, the image is skipped. Related images without labels are always mirrored.
+                          Note that `operator-sdk generate bundle` may not recognize these labels and drop them from the generated
+                          CSV. It is the operator author's responsibility to make sure the labels end up in the bundle's CSV,
+                          restoring them manually if needed.
+                        type: object
+                        additionalProperties:
+                          type: string
                       name:
                         type: string
                 release:

pkg/operators/v1alpha1/clusterserviceversion_types.go

@@ -395,6 +395,21 @@ type Icon struct {
 type RelatedImage struct {
 	Name  string `json:"name"`
 	Image string `json:"image"`
+	// Map of string keys and values that can be used to organize and categorize
+	// (scope and select) this related image, for instance, by the product features it belongs to.
+	// Keys and values follow the Kubernetes label syntax and constraints, see
+	// https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set.
+	// The semantics of the labels is defined by their consumer, which typically picks related images with
+	// Kubernetes label selectors. The first consumer is `oc-mirror`, see
+	// https://github.com/openshift/oc-mirror/blob/main/README.md for how it selects the related images to mirror.
+	// Labeling a related image makes it optional for mirroring: `oc-mirror` mirrors it only if the entry for its
+	// package in the ImageSetConfiguration carries a selector that matches the labels. If that package entry has
+	// no matching selector, the image is skipped. Related images without labels are always mirrored.
+	// Note that `operator-sdk generate bundle` may not recognize these labels and drop them from the generated
+	// CSV. It is the operator author's responsibility to make sure the labels end up in the bundle's CSV,
+	// restoring them manually if needed.
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
 }
 
 // ClusterServiceVersionPhase is a label for the condition of a ClusterServiceVersion at the current time.

pkg/operators/v1alpha1/types_test.go

@@ -211,6 +211,66 @@ func TestCatalogSource_Poll(t *testing.T) {
 	}
 }
 
+func TestRelatedImageLabelsRoundTrip(t *testing.T) {
+	tests := []struct {
+		name string
+		in   []byte
+		out  RelatedImage
+	}{
+		{
+			name: "no labels",
+			in:   []byte(`{"name":"operator","image":"quay.io/example-com/foo-operator@sha256:abc"}`),
+			out: RelatedImage{
+				Name:  "operator",
+				Image: "quay.io/example-com/foo-operator@sha256:abc",
+			},
+		},
+		{
+			name: "empty labels",
+			in:   []byte(`{"name":"operator","image":"quay.io/example-com/foo-operator@sha256:abc","labels":{}}`),
+			out: RelatedImage{
+				Name:   "operator",
+				Image:  "quay.io/example-com/foo-operator@sha256:abc",
+				Labels: map[string]string{},
+			},
+		},
+		{
+			name: "several labels",
+			in:   []byte(`{"name":"operator","image":"quay.io/example-com/foo-operator@sha256:abc","labels":{"CoolFeatureA":"true","GreatFeatureB":"true"}}`),
+			out: RelatedImage{
+				Name:  "operator",
+				Image: "quay.io/example-com/foo-operator@sha256:abc",
+				Labels: map[string]string{
+					"CoolFeatureA":  "true",
+					"GreatFeatureB": "true",
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ri := RelatedImage{}
+			require.NoError(t, json.Unmarshal(tt.in, &ri))
+			require.Equal(t, tt.out, ri)
+
+			marshalled, err := json.Marshal(ri)
+			require.NoError(t, err)
+			// labels is omitempty: an empty map is not serialized back.
+			if len(tt.out.Labels) > 0 {
+				require.JSONEq(t, string(tt.in), string(marshalled))
+			}
+
+			// DeepCopy must not alias the labels of the original.
+			cp := ri.DeepCopy()
+			require.Equal(t, ri, *cp)
+			if cp.Labels != nil {
+				cp.Labels["added-by-the-copy"] = "true"
+				require.Equal(t, tt.out.Labels, ri.Labels)
+			}
+		})
+	}
+}
+
 func TestUpdateStrategyUnmarshal(t *testing.T) {
 	type TestStruct struct {
 		UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`