Merge pull request #262 from james-milligan/annotation-refactor

refactor: annotation refactor

Author: james-milligan

README.md

@@ -137,8 +137,8 @@ kind: Pod
 metadata:
   name: nginx
   annotations:
-    openfeature.dev: "enabled"
-    openfeature.dev/featureflagconfiguration: "default.featureflagconfiguration-sample"
+    openfeature.dev/enabled: "true"
+    openfeature.dev/featureflagconfiguration: "default/featureflagconfiguration-sample"
 spec:
   containers:
   - name: nginx

config/samples/deployment.yaml

@@ -12,7 +12,7 @@ spec:
       labels:
         app: nginx
       annotations:
-        openfeature.dev: "enabled"
+        openfeature.dev/enabled: "true"
         openfeature.dev/featureflagconfiguration: "featureflagconfiguration-sample"
     spec:
       containers:
@@ -35,7 +35,7 @@ spec:
       labels:
         app: nginx
       annotations:
-        openfeature.dev: "enabled"
+        openfeature.dev/enabled: "true"
         openfeature.dev/featureflagconfiguration: "featureflagconfiguration-sample"
     spec:
       containers:

config/samples/end-to-end.yaml

@@ -62,7 +62,7 @@ spec:
       labels:
         app: open-feature-demo
       annotations:
-        openfeature.dev: "enabled"
+        openfeature.dev/enabled: "true"
         openfeature.dev/featureflagconfiguration: "end-to-end"
     spec:
       serviceAccountName: open-feature-demo-sa

config/samples/pod.yaml

@@ -3,7 +3,7 @@ kind: Pod
 metadata:
   name: nginx
   annotations:
-    openfeature.dev: "enabled"
+    openfeature.dev/enabled: "true"
     openfeature.dev/featureflagconfiguration: "featureflagconfiguration-sample"
 spec:
   containers:

docs/annotations.md

@@ -0,0 +1,35 @@
+# Annotations
+
+The following annotations are used by the operator to control the injection and define configuration of the flagd sidecar.
+
+### `openfeature.dev/enabled`
+When a value of `"true"` is provided, the operator will inject a flagd sidecar into the annotated pods.  
+Example: 
+```
+    metadata:
+    annotations:
+        openfeature.dev/enabled: "true"
+```
+
+### `openfeature.dev/featureflagconfiguration`
+This annotation specifies the names of the FeatureFlagConfigurations used to configure the injected flagd sidecar.
+The annotation value a comma separated list of values following one of 2 patterns: {NAME} or {NAMESPACE}/{NAME}. 
+If no namespace is provided it is assumed that the CR is within the same namespace as the deployed pod.
+Example:
+```
+    metadata:
+    annotations:
+        openfeature.dev/enabled: "true"
+        openfeature.dev/featureflagconfiguration: "demo, test/demo-2"
+```
+
+### `openfeature.dev`
+*This annotation is deprecated in favour of the `openfeature.dev/enabled` annotation and should no longer be used.* 
+
+When a value of `"enabled"` is provided, the operator will inject a flagd sidecar into the annotated pods.  
+Example: 
+```
+    metadata:
+    annotations:
+        openfeature.dev: "enabled"
+```

test/e2e/e2e.yml

@@ -58,7 +58,7 @@ spec:
       labels:
         app: open-feature-e2e-test
       annotations:
-        openfeature.dev: "enabled"
+        openfeature.dev/enabled: "true"
         openfeature.dev/featureflagconfiguration: "end-to-end-test"
     spec:
       serviceAccountName: open-feature-e2e-test-sa

test/e2e/tests/001.flagd-response.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-./"$(dirname "${BASH_SOURCE[0]}")"/../simple-flag-evaluation.sh '{"value":true,"reason":"DEFAULT","variant":"on"}'
+./"$(dirname "${BASH_SOURCE[0]}")"/../simple-flag-evaluation.sh '{"value":true,"reason":"STATIC","variant":"on"}'

test/e2e/tests/002.crd-configuration-reconciliation.sh

@@ -21,7 +21,7 @@ spec:
     }
 EOF
 
-./"$(dirname "${BASH_SOURCE[0]}")"/../simple-flag-evaluation.sh '{"reason":"DEFAULT","variant":"off"}'
+./"$(dirname "${BASH_SOURCE[0]}")"/../simple-flag-evaluation.sh '{"reason":"STATIC","variant":"off"}'
 EXIT_CODE=$?
 
 kubectl -n open-feature-operator-system apply -f ./test/e2e/e2e.yml > /dev/null # reset state quietly

webhooks/pod_webhook.go

@@ -61,13 +61,26 @@ func (m *PodMutator) Handle(ctx context.Context, req admission.Request) admissio
 	}
 
 	// Check enablement
+	enabled := false
 	val, ok := pod.GetAnnotations()["openfeature.dev"]
 	if ok {
-		if val != "enabled" {
-			m.Log.V(2).Info("openfeature.dev Annotation is not enabled")
-			return admission.Allowed("openfeature is disabled")
+		m.Log.V(1).Info("DEPRECATED: The openfeature.dev annotation has been superseded by the openfeature.dev/enabled annotation. " +
+			"Docs: https://github.com/open-feature/open-feature-operator/blob/main/docs/annotations.md")
+		if val == "enabled" {
+			enabled = true
 		}
 	}
+	val, ok = pod.GetAnnotations()["openfeature.dev/enabled"]
+	if ok {
+		if val == "true" {
+			enabled = true
+		}
+	}
+
+	if !enabled {
+		m.Log.V(2).Info(`openfeature.dev/enabled annotation is not set to "true"`)
+		return admission.Allowed("OpenFeature is disabled")
+	}
 
 	// Check configuration
 	val, ok = pod.GetAnnotations()["openfeature.dev/featureflagconfiguration"]