Adds Prune=false and IgnoreExtraneous options

common/common.go

@@ -96,6 +96,8 @@ const (
 	AnnotationKeyHelmHook = "helm.sh/hook"
 	// AnnotationValueHelmHookCRDInstall is a value of crd helm hook
 	AnnotationValueHelmHookCRDInstall = "crd-install"
+	// AnnotationSyncStatusOptions is a comma-separated list of options
+	AnnotationSyncStatusOptions = "argocd.argoproj.io/sync-status-options"
 	// ResourcesFinalizerName the finalizer value which we inject to finalize deletion of an application
 	ResourcesFinalizerName = "resources-finalizer.argocd.argoproj.io"
 )

controller/state.go

@@ -27,6 +27,7 @@ import (
 	"github.com/argoproj/argo-cd/util/health"
 	hookutil "github.com/argoproj/argo-cd/util/hook"
 	kubeutil "github.com/argoproj/argo-cd/util/kube"
+	"github.com/argoproj/argo-cd/util/resource"
 	"github.com/argoproj/argo-cd/util/settings"
 )
 
@@ -313,6 +314,7 @@ func (m *appStateManager) CompareAppState(app *v1alpha1.Application, revision st
 		}
 
 		diffResult := diffResults.Diffs[i]
+
 		if resState.Hook {
 			// For resource hooks, don't store sync status, and do not affect overall sync status
 		} else if diffResult.Modified || targetObjs[i] == nil || managedLiveObj[i] == nil {
@@ -321,7 +323,10 @@ func (m *appStateManager) CompareAppState(app *v1alpha1.Application, revision st
 			// * target resource not defined and live resource is extra
 			// * target resource present but live resource is missing
 			resState.Status = v1alpha1.SyncStatusCodeOutOfSync
-			syncCode = v1alpha1.SyncStatusCodeOutOfSync
+			// we don't apply to the application
+			if !resource.HasAnnotationOption(obj, common.AnnotationSyncStatusOptions, "Ignore") {
+				syncCode = v1alpha1.SyncStatusCodeOutOfSync
+			}
 		} else {
 			resState.Status = v1alpha1.SyncStatusCodeSynced
 		}

controller/state_test.go

@@ -117,6 +117,34 @@ func TestCompareAppStateHook(t *testing.T) {
 	assert.Equal(t, 0, len(compRes.conditions))
 }
 
+// checks that ignore resources are detected, but excluded from status
+func TestCompareAppStateSyncOptionIgnore(t *testing.T) {
+	pod := test.NewPod()
+	pod.SetAnnotations(map[string]string{common.AnnotationSyncStatusOptions: "Ignore"})
+	podBytes, _ := json.Marshal(pod)
+	app := newFakeApp()
+	data := fakeData{
+		apps: []runtime.Object{app},
+		manifestResponse: &repository.ManifestResponse{
+			Manifests: []string{string(podBytes)},
+			Namespace: test.FakeDestNamespace,
+			Server:    test.FakeClusterURL,
+			Revision:  "abc123",
+		},
+		managedLiveObjs: make(map[kube.ResourceKey]*unstructured.Unstructured),
+	}
+	ctrl := newFakeController(&data)
+
+	compRes, err := ctrl.appStateManager.CompareAppState(app, "", app.Spec.Source, false)
+
+	assert.NoError(t, err)
+	assert.NotNil(t, compRes)
+	assert.Equal(t, argoappv1.SyncStatusCodeSynced, compRes.syncStatus.Status)
+	assert.Equal(t, []argoappv1.ResourceStatus{{Version: "v1", Kind: "Pod", Name: "my-pod", Namespace: test.FakeDestNamespace, Status: argoappv1.SyncStatusCodeOutOfSync, Health: &argoappv1.HealthStatus{Status: argoappv1.HealthStatusMissing}}}, compRes.resources)
+	assert.Equal(t, 1, len(compRes.managedResources))
+	assert.Equal(t, 0, len(compRes.conditions))
+}
+
 // TestCompareAppStateExtraHook tests when there is an extra _hook_ object in live but not defined in git
 func TestCompareAppStateExtraHook(t *testing.T) {
 	pod := test.NewPod()

docs/user-guide/kustomize.md

@@ -10,4 +10,7 @@ You have three configuration options for Kustomize:
 * `imageTags` is a list of Kustomize 1.0 image tag overrides
 * `images` is a list of Kustomize 2.0 image overrides
 
-To use Kustomize with an overlay, point your path to the overlay.
+To use Kustomize with an overlay, point your path to the overlay.
+
+!!! tip
+    If you're generating resources, you should read up how to ignore those generated resources using [sync status options](sync_status_options.md).

docs/user-guide/sync_status_options.md

@@ -0,0 +1,27 @@
+# Sync Status Options
+
+## Ignoring Resources
+
+You may wish to exclude resources for the app's overall sync status under certain circumstances, for example if they are generated by the tool. This can be done by adding an annotation:
+
+```yaml
+metadata:
+  annotations:
+    argocd.argoproj.io/sync-status-options: Ignore
+```
+
+!!! note
+    This only affect the sync status. If the resource's health is degraded, then the app will also be degraded.
+
+Kustomize has a feature that allows you to generate config maps. You can set `generatorOptions` to add this annotation so that your app remains in sync:
+
+```yaml
+configMapGenerator:
+  - name: my-map
+    literals:
+      - foo=bar
+generatorOptions:
+  annotations:
+    argocd.argoproj.io/sync-status-options: Ignore
+kind: Kustomization
+``` 

mkdocs.yml

@@ -46,6 +46,7 @@ nav:
     - user-guide/private-repositories.md
     - user-guide/auto_sync.md
     - user-guide/diffing.md
+    - user-guide/sync_status_options.md
     - user-guide/parameters.md
     - user-guide/tracking_strategies.md
     - user-guide/resource_hooks.md

test/e2e/kustomize_test.go

@@ -0,0 +1,47 @@
+package e2e
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	. "github.com/argoproj/argo-cd/pkg/apis/application/v1alpha1"
+	. "github.com/argoproj/argo-cd/test/e2e/fixture/app"
+)
+
+// when we have a config map generator, AND the ignore annotation, it is ignored in the app's sync status
+func TestSyncStatusOptionIgnore(t *testing.T) {
+	var mapName string
+	Given(t).
+		Path("kustomize-cm-gen").
+		When().
+		Create().
+		Sync().
+		Then().
+		Expect(OperationPhaseIs(OperationSucceeded)).
+		Expect(SyncStatusIs(SyncStatusCodeSynced)).
+		Expect(HealthIs(HealthStatusHealthy)).
+		And(func(app *Application) {
+			resourceStatus := app.Status.Resources[0]
+			assert.Contains(t, resourceStatus.Name, "my-map-")
+			assert.Equal(t, SyncStatusCodeSynced, resourceStatus.Status)
+
+			mapName = resourceStatus.Name
+		}).
+		When().
+		// we now force generation of a second CM
+		Patch("kustomization.yaml", `[{"op": "replace", "path": "/configMapGenerator/0/literals/0", "value": "foo=baz"}]`).
+		Refresh(RefreshTypeHard).
+		Sync().
+		Then().
+		Expect(OperationPhaseIs(OperationSucceeded)).
+		Expect(SyncStatusIs(SyncStatusCodeSynced)).
+		Expect(HealthIs(HealthStatusHealthy)).
+		And(func(app *Application) {
+			resourceStatus := app.Status.Resources[0]
+			assert.Contains(t, resourceStatus.Name, "my-map-")
+			// make sure we've a new map with changed name
+			assert.NotEqual(t, mapName, resourceStatus.Name)
+			assert.Equal(t, SyncStatusCodeSynced, resourceStatus.Status)
+		})
+}

test/e2e/testdata/kustomize-cm-gen/kustomization.yaml

@@ -0,0 +1,8 @@
+configMapGenerator:
+  - name: my-map
+    literals:
+      - foo=bar
+generatorOptions:
+  annotations:
+    argocd.argoproj.io/sync-status-options: Ignore
+kind: Kustomization

util/resource/annotations.go

@@ -0,0 +1,16 @@
+package resource
+
+import (
+	"strings"
+
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+)
+
+func HasAnnotationOption(obj *unstructured.Unstructured, key, val string) bool {
+	for _, item := range strings.Split(obj.GetAnnotations()[key], ",") {
+		if strings.TrimSpace(item) == val {
+			return true
+		}
+	}
+	return false
+}

util/resource/annotations_test.go

@@ -0,0 +1,41 @@
+package resource
+
+import (
+	"testing"
+
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+
+	"github.com/argoproj/argo-cd/test"
+)
+
+func TestHasAnnotationOption(t *testing.T) {
+	type args struct {
+		obj *unstructured.Unstructured
+		key string
+		val string
+	}
+	tests := []struct {
+		name string
+		args args
+		want bool
+	}{
+		{"Nil", args{test.NewPod(), "foo", "bar"}, false},
+		{"Empty", args{example(""), "foo", "bar"}, false},
+		{"Single", args{example("bar"), "foo", "bar"}, true},
+		{"Double", args{example("bar,baz"), "foo", "baz"}, true},
+		{"Spaces", args{example("bar "), "foo", "bar"}, true},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := HasAnnotationOption(tt.args.obj, tt.args.key, tt.args.val); got != tt.want {
+				t.Errorf("HasAnnotationOption() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func example(val string) *unstructured.Unstructured {
+	obj := test.NewPod()
+	obj.SetAnnotations(map[string]string{"foo": val})
+	return obj
+}