Adds Prune=false and IgnoreExtraneous options

common/common.go

@@ -81,6 +81,10 @@ const (
 	// LabelValueSecretTypeCluster indicates a secret type of cluster
 	LabelValueSecretTypeCluster = "cluster"
 
+	// AnnotationCompareOptions is a comma-separated list of options for comparison
+	AnnotationCompareOptions = "argocd.argoproj.io/compare-options"
+	// AnnotationSyncOptions is a comma-separated list of options for syncing
+	AnnotationSyncOptions = "argocd.argoproj.io/sync-options"
 	// AnnotationSyncWave indicates which wave of the sync the resource or hook should be in
 	AnnotationSyncWave = "argocd.argoproj.io/sync-wave"
 	// AnnotationKeyHook contains the hook type of a resource

controller/state.go

@@ -297,10 +297,11 @@ func (m *appStateManager) CompareAppState(app *v1alpha1.Application, revision st
 	syncCode := v1alpha1.SyncStatusCodeSynced
 	managedResources := make([]managedResource, len(targetObjs))
 	resourceSummaries := make([]v1alpha1.ResourceStatus, len(targetObjs))
-	for i := 0; i < len(targetObjs); i++ {
-		obj := managedLiveObj[i]
+	for i, targetObj := range targetObjs {
+		liveObj := managedLiveObj[i]
+		obj := liveObj
 		if obj == nil {
-			obj = targetObjs[i]
+			obj = targetObj
 		}
 		if obj == nil {
 			continue
@@ -319,13 +320,17 @@ func (m *appStateManager) CompareAppState(app *v1alpha1.Application, revision st
 		diffResult := diffResults.Diffs[i]
 		if resState.Hook || resource.Ignore(obj) {
 			// 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 {
+		} else if diffResult.Modified || targetObj == nil || liveObj == nil {
 			// Set resource state to OutOfSync since one of the following is true:
 			// * target and live resource are different
 			// * 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
+			needsPruning := targetObj == nil && liveObj != nil
+			if !(needsPruning && resource.HasAnnotationOption(obj, common.AnnotationCompareOptions, "IgnoreNeedsPruning")) {
+				syncCode = v1alpha1.SyncStatusCodeOutOfSync
+			}
 		} else {
 			resState.Status = v1alpha1.SyncStatusCodeSynced
 		}
@@ -335,8 +340,8 @@ func (m *appStateManager) CompareAppState(app *v1alpha1.Application, revision st
 			Group:     resState.Group,
 			Kind:      resState.Kind,
 			Version:   resState.Version,
-			Live:      managedLiveObj[i],
-			Target:    targetObjs[i],
+			Live:      liveObj,
+			Target:    targetObj,
 			Diff:      diffResult,
 			Hook:      resState.Hook,
 		}

controller/state_test.go

@@ -117,6 +117,33 @@ func TestCompareAppStateHook(t *testing.T) {
 	assert.Equal(t, 0, len(compRes.conditions))
 }
 
+// checks that ignore resources are detected, but excluded from status
+func TestCompareAppStateCompareOptionIgnoreNeedsPruning(t *testing.T) {
+	pod := test.NewPod()
+	pod.SetAnnotations(map[string]string{common.AnnotationCompareOptions: "IgnoreNeedsPruning"})
+	app := newFakeApp()
+	data := fakeData{
+		apps: []runtime.Object{app},
+		manifestResponse: &repository.ManifestResponse{
+			Manifests: []string{},
+			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.Len(t, compRes.resources, 0)
+	assert.Len(t, compRes.managedResources, 0)
+	assert.Len(t, compRes.conditions, 0)
+}
+
 // TestCompareAppStateExtraHook tests when there is an extra _hook_ object in live but not defined in git
 func TestCompareAppStateExtraHook(t *testing.T) {
 	pod := test.NewPod()

controller/sync.go

@@ -16,13 +16,15 @@ import (
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/rest"
 
+	"github.com/argoproj/argo-cd/common"
 	"github.com/argoproj/argo-cd/controller/metrics"
 	"github.com/argoproj/argo-cd/pkg/apis/application/v1alpha1"
 	listersv1alpha1 "github.com/argoproj/argo-cd/pkg/client/listers/application/v1alpha1"
 	"github.com/argoproj/argo-cd/util/argo"
 	"github.com/argoproj/argo-cd/util/health"
 	"github.com/argoproj/argo-cd/util/hook"
 	"github.com/argoproj/argo-cd/util/kube"
+	"github.com/argoproj/argo-cd/util/resource"
 )
 
 type syncContext struct {
@@ -473,7 +475,11 @@ func (sc *syncContext) applyObject(targetObj *unstructured.Unstructured, dryRun
 
 // pruneObject deletes the object if both prune is true and dryRun is false. Otherwise appropriate message
 func (sc *syncContext) pruneObject(liveObj *unstructured.Unstructured, prune, dryRun bool) (v1alpha1.ResultCode, string) {
-	if prune {
+	if !prune {
+		return v1alpha1.ResultCodePruneSkipped, "ignored (requires pruning)"
+	} else if resource.HasAnnotationOption(liveObj, common.AnnotationSyncOptions, "NoPrune") {
+		return v1alpha1.ResultCodePruneSkipped, "ignored (no prune)"
+	} else {
 		if dryRun {
 			return v1alpha1.ResultCodePruned, "pruned (dry run)"
 		} else {
@@ -487,8 +493,6 @@ func (sc *syncContext) pruneObject(liveObj *unstructured.Unstructured, prune, dr
 			}
 			return v1alpha1.ResultCodePruned, "pruned"
 		}
-	} else {
-		return v1alpha1.ResultCodePruneSkipped, "ignored (requires pruning)"
 	}
 }
 

controller/sync_test.go

@@ -305,6 +305,26 @@ func TestDontSyncOrPruneHooks(t *testing.T) {
 	assert.Equal(t, v1alpha1.OperationSucceeded, syncCtx.opState.Phase)
 }
 
+// make sure that we do not prune resources with NoPrune
+func TestDontPruneNoPrune(t *testing.T) {
+	syncCtx := newTestSyncCtx()
+	pod := test.NewPod()
+	pod.SetAnnotations(map[string]string{common.AnnotationSyncOptions: "NoPrune"})
+	pod.SetNamespace(test.FakeArgoCDNamespace)
+	syncCtx.compareResult = &comparisonResult{managedResources: []managedResource{{Live: pod}}}
+
+	syncCtx.sync()
+
+	assert.Equal(t, v1alpha1.OperationRunning, syncCtx.opState.Phase)
+	assert.Len(t, syncCtx.syncRes.Resources, 1)
+	assert.Equal(t, v1alpha1.ResultCodePruneSkipped, syncCtx.syncRes.Resources[0].Status)
+	assert.Equal(t, "ignored (no prune)", syncCtx.syncRes.Resources[0].Message)
+
+	syncCtx.sync()
+
+	assert.Equal(t, v1alpha1.OperationSucceeded, syncCtx.opState.Phase)
+}
+
 func TestSelectiveSyncOnly(t *testing.T) {
 	syncCtx := newTestSyncCtx()
 	pod1 := test.NewPod()

docs/user-guide/compare-options.md

@@ -0,0 +1,32 @@
+# Compare Options
+
+## Ignoring Resources That Needs Pruning
+
+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/compare-options: IgnoreNeedsPruning
+```
+
+![compare option needs pruning](../assets/compare-option-ignore-needs-pruning.png)
+
+!!! 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 ([read more  ⧉](https://github.com/kubernetes-sigs/kustomize/blob/master/examples/configGeneration.md)). 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/compare-options: IgnoreNeedsPruning
+kind: Kustomization
+``` 
+
+!!! note
+    `generatorOptions` adds annotations to both config maps and secrets ([read more ⧉](https://github.com/kubernetes-sigs/kustomize/blob/master/examples/generatorOptions.md)).

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-options.md

@@ -0,0 +1,24 @@
+# Sync Options
+
+## No Prune Resources
+
+You may wish to prevent an object from being pruned:
+
+```yaml
+metadata:
+  annotations:
+    argocd.argoproj.io/sync-options: NoPrune
+```
+
+In the UI, the pod will simply appear as out-of-sync:
+
+![sync option no prune](../assets/sync-option-no-prune.png)
+
+
+The sync-status panel shows that pruning was skipped, and why:
+
+![sync option no prune](../assets/sync-option-no-prune-sync-status.png)
+
+!!! note
+    The app will be out of sync if Argo CD expects a resource to be pruned. You may wish to use this along with [compare options](compare-options.md).
+

mkdocs.yml

@@ -46,6 +46,8 @@ nav:
     - user-guide/private-repositories.md
     - user-guide/auto_sync.md
     - user-guide/diffing.md
+    - user-guide/compare-options.md
+    - user-guide/sync-options.md
     - user-guide/parameters.md
     - user-guide/tracking_strategies.md
     - user-guide/resource_hooks.md

test/e2e/app_management_test.go

@@ -306,15 +306,19 @@ func TestResourceDiffing(t *testing.T) {
 }
 
 func TestDeprecatedExtensions(t *testing.T) {
-	testEdgeCasesApplicationResources(t, "deprecated-extensions")
+	testEdgeCasesApplicationResources(t, "deprecated-extensions", OperationRunning, HealthStatusProgressing)
 }
 
 func TestCRDs(t *testing.T) {
-	testEdgeCasesApplicationResources(t, "crd-creation")
+	testEdgeCasesApplicationResources(t, "crd-creation", OperationSucceeded, HealthStatusHealthy)
 }
 
 func TestDuplicatedResources(t *testing.T) {
-	testEdgeCasesApplicationResources(t, "duplicated-resources")
+	testEdgeCasesApplicationResources(t, "duplicated-resources", OperationSucceeded, HealthStatusHealthy)
+}
+
+func TestConfigMap(t *testing.T) {
+	testEdgeCasesApplicationResources(t, "config-map", OperationSucceeded, HealthStatusHealthy)
 }
 
 func TestFailedConversion(t *testing.T) {
@@ -323,17 +327,19 @@ func TestFailedConversion(t *testing.T) {
 		errors.FailOnErr(fixture.Run("", "kubectl", "delete", "apiservice", "v1beta1.metrics.k8s.io"))
 	}()
 
-	testEdgeCasesApplicationResources(t, "failed-conversion")
+	testEdgeCasesApplicationResources(t, "failed-conversion", OperationSucceeded, HealthStatusHealthy)
 }
 
-func testEdgeCasesApplicationResources(t *testing.T, appPath string) {
+func testEdgeCasesApplicationResources(t *testing.T, appPath string, phase OperationPhase, statusCode HealthStatusCode) {
 	Given(t).
 		Path(appPath).
 		When().
 		Create().
 		Sync().
 		Then().
+		Expect(OperationPhaseIs(phase)).
 		Expect(SyncStatusIs(SyncStatusCodeSynced)).
+		Expect(HealthIs(statusCode)).
 		And(func(app *Application) {
 			diffOutput, err := fixture.RunCli("app", "diff", app.Name, "--local", path.Join("testdata", appPath))
 			assert.Empty(t, diffOutput)
@@ -504,3 +510,51 @@ func TestPermissions(t *testing.T) {
 	assert.True(t, destinationErrorExist)
 	assert.True(t, sourceErrorExist)
 }
+
+// make sure that if we deleted a resource from the app, it is not pruned if annotated with NoPrune
+func TestSyncOptionNoPrune(t *testing.T) {
+	Given(t).
+		Path("two-nice-pods").
+		When().
+		PatchFile("pod-1.yaml", `[{"op": "add", "path": "/metadata/annotations", "value": {"argocd.argoproj.io/sync-options": "NoPrune"}}]`).
+		Create().
+		Sync().
+		Then().
+		Expect(OperationPhaseIs(OperationSucceeded)).
+		Expect(SyncStatusIs(SyncStatusCodeSynced)).
+		When().
+		DeleteFile("pod-1.yaml").
+		Refresh(RefreshTypeHard).
+		Sync().
+		Then().
+		Expect(OperationPhaseIs(OperationSucceeded)).
+		Expect(SyncStatusIs(SyncStatusCodeOutOfSync)).
+		Expect(ResourceSyncStatusIs("Pod", "pod-1", SyncStatusCodeOutOfSync))
+}
+
+// make sure that, if we have a resource that needs pruning, but we're ignoring it, the app is in-sync
+func TestCompareOptionIgnoreNeedsPruning(t *testing.T) {
+	Given(t).
+		Path("two-nice-pods").
+		When().
+		PatchFile("pod-1.yaml", `[{"op": "add", "path": "/metadata/annotations", "value": {"argocd.argoproj.io/compare-options": "IgnoreNeedsPruning"}}]`).
+		Create().
+		Sync().
+		Then().
+		Expect(OperationPhaseIs(OperationSucceeded)).
+		Expect(SyncStatusIs(SyncStatusCodeSynced)).
+		When().
+		DeleteFile("pod-1.yaml").
+		Refresh(RefreshTypeHard).
+		Then().
+		Expect(SyncStatusIs(SyncStatusCodeSynced)).
+		And(func(app *Application) {
+			assert.Len(t, app.Status.Resources, 2)
+			assert.Equal(t, SyncStatusCodeOutOfSync, app.Status.Resources[1].Status)
+		}).
+		When().
+		Sync().
+		Then().
+		Expect(OperationPhaseIs(OperationSucceeded)).
+		Expect(SyncStatusIs(SyncStatusCodeSynced))
+}

test/e2e/fixture/app/context.go

@@ -61,6 +61,11 @@ func (c *Context) NamePrefix(namePrefix string) *Context {
 	return c
 }
 
+func (c *Context) Prune(prune bool) *Context {
+	c.prune = prune
+	return c
+}
+
 func (c *Context) And(block func()) *Context {
 	block()
 	return c
@@ -69,8 +74,3 @@ func (c *Context) And(block func()) *Context {
 func (c *Context) When() *Actions {
 	return &Actions{context: c}
 }
-
-func (c *Context) Prune(prune bool) *Context {
-	c.prune = prune
-	return c
-}

test/e2e/fixture/fixture.go

@@ -170,7 +170,7 @@ func EnsureCleanState() {
 
 	// new random ID
 	id = strings.ToLower(rand.RandString(5))
-	repoUrl = fmt.Sprintf("file:///%s", repoDirectory())
+	repoUrl = fmt.Sprintf("file://%s", repoDirectory())
 
 	// create tmp dir
 	FailOnErr(Run("", "mkdir", "-p", tmpDir))