Skip to content

Commit 702740f

Browse files
Update internal/operator-controller/labels/labels.go to add documentation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent ba37149 commit 702740f

1 file changed

Lines changed: 36 additions & 7 deletions

File tree

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,41 @@
11
package labels
22

33
const (
4-
OwnerKindKey = "olm.operatorframework.io/owner-kind"
5-
OwnerNameKey = "olm.operatorframework.io/owner-name"
6-
PackageNameKey = "olm.operatorframework.io/package-name"
7-
BundleNameKey = "olm.operatorframework.io/bundle-name"
8-
BundleVersionKey = "olm.operatorframework.io/bundle-version"
9-
BundleReferenceKey = "olm.operatorframework.io/bundle-reference"
10-
ServiceAccountNameKey = "olm.operatorframework.io/service-account-name"
4+
// OwnerKindKey is the label key used to record the kind of the owner
5+
// resource responsible for creating or managing a ClusterExtensionRevision.
6+
OwnerKindKey = "olm.operatorframework.io/owner-kind"
7+
8+
// OwnerNameKey is the label key used to record the name of the owner
9+
// resource responsible for creating or managing a ClusterExtensionRevision.
10+
OwnerNameKey = "olm.operatorframework.io/owner-name"
11+
12+
// PackageNameKey is the label key used to record the package name
13+
// associated with a ClusterExtensionRevision.
14+
PackageNameKey = "olm.operatorframework.io/package-name"
15+
16+
// BundleNameKey is the label key used to record the bundle name
17+
// associated with a ClusterExtensionRevision.
18+
BundleNameKey = "olm.operatorframework.io/bundle-name"
19+
20+
// BundleVersionKey is the label key used to record the bundle version
21+
// associated with a ClusterExtensionRevision.
22+
BundleVersionKey = "olm.operatorframework.io/bundle-version"
23+
24+
// BundleReferenceKey is the label key used to record an external reference
25+
// (such as an image or catalog reference) to the bundle for a
26+
// ClusterExtensionRevision.
27+
BundleReferenceKey = "olm.operatorframework.io/bundle-reference"
28+
29+
// ServiceAccountNameKey is the label key used to record the name of the
30+
// ServiceAccount configured on the owning ClusterExtension. It is applied
31+
// as an annotation on ClusterExtensionRevision resources to capture which
32+
// ServiceAccount was used for their lifecycle operations.
33+
ServiceAccountNameKey = "olm.operatorframework.io/service-account-name"
34+
35+
// ServiceAccountNamespaceKey is the label key used to record the namespace
36+
// of the ServiceAccount configured on the owning ClusterExtension. It is
37+
// applied as an annotation on ClusterExtensionRevision resources together
38+
// with ServiceAccountNameKey so that the effective ServiceAccount identity
39+
// used for ClusterExtensionRevision operations is preserved.
1140
ServiceAccountNamespaceKey = "olm.operatorframework.io/service-account-namespace"
1241
)

0 commit comments

Comments
 (0)