Clarify DeploymentAnnotations doc string and regen files

operator-framework · Jan 25, 2024 · 60fbe24 · 60fbe24
1 parent a816b54
commit 60fbe24
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/crds/operators.coreos.com_subscriptions.yaml b/crds/operators.coreos.com_subscriptions.yaml
@@ -524,8 +524,8 @@ spec:
                                   topologyKey:
                                     description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
                                     type: string
-                    deployment_annotations:
-                      description: DeploymentAnnotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
+                    deploymentAnnotations:
+                      description: DeploymentAnnotations is an unstructured key value map stored with each Deployment in the Operator. Typically, annotations may be set by external tools to store and retrieve arbitrary metadata. Use this field to pre-define annotations that OLM should add to each of the Subscription's deployments.
                       type: object
                       additionalProperties:
                         type: string

diff --git a/crds/zz_defs.go b/crds/zz_defs.go
diff --git a/pkg/operators/v1alpha1/subscription_types.go b/pkg/operators/v1alpha1/subscription_types.go
@@ -91,8 +91,9 @@ type SubscriptionConfig struct {
 	// +optional
 	Affinity *corev1.Affinity `json:"affinity,omitempty" protobuf:"bytes,18,opt,name=affinity"`
 
-	// DeploymentAnnotations is an unstructured key value map stored with a resource that may be
-	// set by external tools to store and retrieve arbitrary metadata.
+	// DeploymentAnnotations is an unstructured key value map stored with each Deployment in the Operator.
+	// Typically, annotations may be set by external tools to store and retrieve arbitrary metadata.
+	// Use this field to pre-define annotations that OLM should add to each of the Subscription's deployments.
 	// +optional
 	DeploymentAnnotations map[string]string `json:"deploymentAnnotations,omitempty" protobuf:"bytes,12,rep,name=deploymentAnnotations"`
 }