Rename the annotation used to inject the proxy

apply deislabs#49

Author: vbehar

README.md

@@ -138,7 +138,7 @@ spec:
       labels:
         app: nginx
       annotations:
-        osiris.dm.gg/enabled: "true"
+        osiris.dm.gg/collectMetrics: "true"
     # ...
   # ...
 ```
@@ -191,7 +191,7 @@ The following table lists the supported annotations for Kubernetes `Pods` and th
 
 | Annotation | Description | Default |
 | ---------- | ----------- | ------- |
-| `osiris.dm.gg/enabled` | Enable the metrics collecting proxy sidecar container to be injected into this pod. Allowed values: `y`, `yes`, `true`, `on`, `1`. | _no value_ (= disabled) |
+| `osiris.dm.gg/collectMetrics` | Enable the metrics collecting proxy to be injected as a sidecar container into this pod. This is _required_ for metrics collection. Allowed values: `y`, `yes`, `true`, `on`, `1`. | _no value_ (= disabled) |
 | `osiris.dm.gg/ignoredPaths` | The list of (url) paths that should be "ignored" by Osiris. Requests to such paths won't be "counted" by the proxy. Format: comma-separated string. | _no value_ |
 
 #### Service Annotations

example/hello-osiris.yaml

@@ -40,7 +40,7 @@ spec:
       labels:
         app: hello-osiris
       annotations:
-        osiris.dm.gg/enabled: "true"
+        osiris.dm.gg/collectMetrics: "true"
         osiris.dm.gg/ignoredPaths: "/first/path,/second-path"
     spec:
       containers:

pkg/kubernetes/osiris.go

@@ -9,12 +9,23 @@ const (
 	IgnoredPathsAnnotationName         = "osiris.dm.gg/ignoredPaths"
 	MetricsCheckIntervalAnnotationName = "osiris.deislabs.io/metricsCheckInterval"
 	osirisEnabledAnnotationName        = "osiris.dm.gg/enabled"
+	collectMetricsAnnotationName       = "osiris.dm.gg/collectMetrics"
 )
 
 // ResourceIsOsirisEnabled checks the annotations to see if the
 // kube resource is enabled for osiris or not.
 func ResourceIsOsirisEnabled(annotations map[string]string) bool {
-	enabled, ok := annotations[osirisEnabledAnnotationName]
+	return annotationBooleanValue(annotations, osirisEnabledAnnotationName)
+}
+
+// PodIsEligibleForProxyInjection checks the annotations to see if the
+// pod is eligible for proxy injection or not.
+func PodIsEligibleForProxyInjection(annotations map[string]string) bool {
+	return annotationBooleanValue(annotations, collectMetricsAnnotationName)
+}
+
+func annotationBooleanValue(annotations map[string]string, key string) bool {
+	enabled, ok := annotations[key]
 	if !ok {
 		return false
 	}

pkg/metrics/proxy/injector/pod_patch.go

@@ -41,7 +41,7 @@ func (i *injector) getPodPatchOperations(
 		req.UserInfo,
 	)
 
-	if !kubernetes.ResourceIsOsirisEnabled(pod.Annotations) ||
+	if !kubernetes.PodIsEligibleForProxyInjection(pod.Annotations) ||
 		(podContainsProxyInitContainer(&pod) && podContainsProxyContainer(&pod)) {
 		return nil, nil
 	}