Skip to content

Commit 75aeb9d

Browse files
committed
Clarify DeploymentAnnotations doc string
1 parent a816b54 commit 75aeb9d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

pkg/operators/v1alpha1/subscription_types.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ type SubscriptionConfig struct {
9191
// +optional
9292
Affinity *corev1.Affinity `json:"affinity,omitempty" protobuf:"bytes,18,opt,name=affinity"`
9393

94-
// DeploymentAnnotations is an unstructured key value map stored with a resource that may be
95-
// set by external tools to store and retrieve arbitrary metadata.
94+
// DeploymentAnnotations is an unstructured key value map stored with each Deployment in the Operator.
95+
// Typically, annotations may be set by external tools to store and retrieve arbitrary metadata.
96+
// Use this field to pre-define annotations that OLM should add to each of the Subscription's deployments.
9697
// +optional
9798
DeploymentAnnotations map[string]string `json:"deploymentAnnotations,omitempty" protobuf:"bytes,12,rep,name=deploymentAnnotations"`
9899
}

0 commit comments

Comments
 (0)