Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add feature annotation key prefix #431

Closed
wants to merge 2 commits into from
Closed

Add feature annotation key prefix #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67c7d0c
Add feature annotation key prefix
alexeykazakov Jun 25, 2024
9469259
reorg
alexeykazakov Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions api/v1alpha1/featutetoggles.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package v1alpha1

const (
// FeatureToggleNameAnnotationKey is used for referring tier template objects to feature toggles defined in configuration
FeatureToggleNameAnnotationKey = LabelKeyPrefix + "feature"

// FeatureAnnotationKeyPrefix is used in feature annotation keys in Space, NSTemplate and other resources
// to refer to the corresponding feature toggle from the configuration:
// "toolchain.dev.openshift.com/feature/<feature-name>
FeatureAnnotationKeyPrefix = FeatureToggleNameAnnotationKey + "/"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another option would be to list the enabled features in the value of the annotation:

Suggested change
FeatureAnnotationKeyPrefix = FeatureToggleNameAnnotationKey + "/"
toolchain.dev.openshift.com/features: o-lightspeed,another-one,...

That would be easy to manage too, right? Or is there any specific reason for putting the key into the key part?
I mean, it would be understandable if we wanted to store it as a label and list them, but that's not the case.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I misunderstanding this or there can be only one slash in the annotation key according to https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mfrancisc you are right. It doesn't actually allow more than one slash in the annotation key. It's not actually clear from the documentation but I tried it and it failed the validation.

@MatousJobanek I was thinking about using a list of features in a single annotation instead of separate annotations for each feature but thought that it would be a bit simpler to handle multiple annotations. But since multiple slashes are not allowed anyway I'm going to switch to a single annotation now.

)
3 changes: 0 additions & 3 deletions api/v1alpha1/toolchainconfig_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ const (
ToolchainConfigSyncComplete ConditionType = "SyncComplete"
ToolchainConfigRegServiceDeploy ConditionType = "RegServiceDeploy"

// FeatureToggleNameAnnotationKey is used for referring tier template objects to feature toggles defined in configuration
FeatureToggleNameAnnotationKey = LabelKeyPrefix + "feature"

// Status condition reasons
// ToolchainConfigSyncedReason when the MemberOperatorConfigs were successfully synced to the member clusters
ToolchainConfigSyncedReason = "Synced"
Expand Down
Loading