Support per-config configTracker disable via ConfigMap/Secret annotation

This allows a user to annotate a specific ConfigMap or Secret to be disabled/ignored via the
configTracking logic that tracks config changes makes configuration copies for the primary Deploy

Closes #435

docs/gitbook/usage/how-it-works.md

@@ -75,16 +75,11 @@ Based on the above configuration, Flagger generates the following Kubernetes obj
 * `deployment/<targetRef.name>-primary`
 * `hpa/<autoscalerRef.name>-primary`
 
-The primary deployment is considered the stable release of your app, by default all traffic is routed to this version 
+The primary deployment is considered the stable release of your app, by default all traffic is routed to this version
 and the target deployment is scaled to zero.
 Flagger will detect changes to the target deployment (including secrets and configmaps) and will perform a
 canary analysis before promoting the new version as primary.
 
-If the target deployment uses secrets and/or configmaps, Flagger will create a copy of each object using the `-primary`
-prefix and will reference these objects in the primary deployment. You can disable the secrets/configmaps tracking 
-with the `-enable-config-tracking=false` command flag in the Flagger deployment manifest under containers args
-or by setting `--set configTracking.enabled=false` when installing Flagger with Helm.
-
 **Note** that the target deployment must have a single label selector in the format `app: <DEPLOYMENT-NAME>`:
 
 ```yaml
@@ -102,11 +97,20 @@ spec:
         app: podinfo
 ```
 
-Besides `app` Flagger supports `name` and `app.kubernetes.io/name` selectors.
+In addition to `app`, Flagger supports `name` and `app.kubernetes.io/name` selectors.
 If you use a different convention you can specify your label with
 the `-selector-labels=my-app-label` command flag in the Flagger deployment manifest under containers args
 or by setting `--set selectorLabels=my-app-label` when installing Flagger with Helm.
 
+If the target deployment uses secrets and/or configmaps, Flagger will create a copy of each object using the `-primary`
+prefix and will reference these objects in the primary deployment. If you annotate your ConfigMap or Secret with
+`flagger.app/config-tracking: disabled`, Flagger will use the same object for the primary deployment instead of making
+a primary copy.
+You can disable the secrets/configmaps tracking globally with the `-enable-config-tracking=false` command flag in
+the Flagger deployment manifest under containers args or by setting `--set configTracking.enabled=false` when
+installing Flagger with Helm, but disabling config-tracking using the the per Secret/ConfigMap annotation may fit your
+use-case better.
+
 The autoscaler reference is optional, when specified, Flagger will pause the traffic increase while the 
 target and primary deployments are scaled up or down. HPA can help reduce the resource usage during the canary analysis.
 

pkg/canary/config_tracker.go

@@ -5,6 +5,7 @@ import (
 	"crypto/sha256"
 	"encoding/json"
 	"fmt"
+	"strings"
 
 	"go.uber.org/zap"
 	corev1 "k8s.io/api/core/v1"
@@ -50,6 +51,15 @@ func checksum(data interface{}) string {
 	return fmt.Sprintf("%x", hashBytes[:8])
 }
 
+func configIsDisabled(annotations map[string]string) bool {
+	for k, v := range annotations {
+		if k == "flagger.app/config-tracking" && strings.HasPrefix(v, "disable") {
+			return true
+		}
+	}
+	return false
+}
+
 // getRefFromConfigMap transforms a Kubernetes ConfigMap into a ConfigRef
 // and computes the checksum of the ConfigMap data
 func (ct *ConfigTracker) getRefFromConfigMap(name string, namespace string) (*ConfigRef, error) {
@@ -58,6 +68,10 @@ func (ct *ConfigTracker) getRefFromConfigMap(name string, namespace string) (*Co
 		return nil, fmt.Errorf("configmap  %s.%s get query error: %w", name, namespace, err)
 	}
 
+	if configIsDisabled(config.GetAnnotations()) {
+		return nil, nil
+	}
+
 	return &ConfigRef{
 		Name:     config.Name,
 		Type:     ConfigRefMap,
@@ -82,6 +96,10 @@ func (ct *ConfigTracker) getRefFromSecret(name string, namespace string) (*Confi
 		return nil, nil
 	}
 
+	if configIsDisabled(secret.GetAnnotations()) {
+		return nil, nil
+	}
+
 	return &ConfigRef{
 		Name:     secret.Name,
 		Type:     ConfigRefSecret,
@@ -180,7 +198,9 @@ func (ct *ConfigTracker) GetTargetConfigs(cd *flaggerv1.Canary) (map[string]Conf
 			ct.Logger.Errorf("getRefFromConfigMap failed: %v", err)
 			continue
 		}
-		res[config.GetName()] = *config
+		if config != nil {
+			res[config.GetName()] = *config
+		}
 	}
 	for secretName := range secretNames {
 		secret, err := ct.getRefFromSecret(secretName, cd.Namespace)

pkg/canary/config_tracker_test.go

@@ -46,6 +46,15 @@ func TestConfigTracker_ConfigMaps(t *testing.T) {
 		if assert.NoError(t, err) {
 			assert.Equal(t, configMapProjected.Data["color"], configPrimaryProjected.Data["color"])
 		}
+
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-enabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-enabled-primary", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-disabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-disabled-primary", metav1.GetOptions{})
+		assert.Error(t, err)
 	})
 
 	t.Run("daemonset", func(t *testing.T) {
@@ -84,6 +93,15 @@ func TestConfigTracker_ConfigMaps(t *testing.T) {
 		if assert.NoError(t, err) {
 			assert.Equal(t, configMapProjected.Data["color"], configPrimaryProjected.Data["color"])
 		}
+
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-enabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-enabled-primary", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-disabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().ConfigMaps("default").Get(context.TODO(), "podinfo-config-tracker-disabled-primary", metav1.GetOptions{})
+		assert.Error(t, err)
 	})
 }
 
@@ -123,6 +141,15 @@ func TestConfigTracker_Secrets(t *testing.T) {
 		if assert.NoError(t, err) {
 			assert.Equal(t, string(secretProjected.Data["apiKey"]), string(secretPrimaryProjected.Data["apiKey"]))
 		}
+
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-enabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-enabled-primary", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-disabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-disabled-primary", metav1.GetOptions{})
+		assert.Error(t, err)
 	})
 
 	t.Run("daemonset", func(t *testing.T) {
@@ -160,5 +187,14 @@ func TestConfigTracker_Secrets(t *testing.T) {
 		if assert.NoError(t, err) {
 			assert.Equal(t, string(secretProjected.Data["apiKey"]), string(secretPrimaryProjected.Data["apiKey"]))
 		}
+
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-enabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-enabled-primary", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-disabled", metav1.GetOptions{})
+		assert.NoError(t, err)
+		_, err = mocks.kubeClient.CoreV1().Secrets("default").Get(context.TODO(), "podinfo-secret-tracker-disabled-primary", metav1.GetOptions{})
+		assert.Error(t, err)
 	})
 }