Skip to content

Commit 60fbe24

Browse files
committed
Clarify DeploymentAnnotations doc string and regen files
1 parent a816b54 commit 60fbe24

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

crds/operators.coreos.com_subscriptions.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -524,8 +524,8 @@ spec:
524524
topologyKey:
525525
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.
526526
type: string
527-
deployment_annotations:
528-
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.
527+
deploymentAnnotations:
528+
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.
529529
type: object
530530
additionalProperties:
531531
type: string

crds/zz_defs.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/operators/v1alpha1/subscription_types.go

Lines changed: 3 additions & 2 deletions
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)