feat: add support for Prune/Delete=confirm sync option

As deletion confirmation acts on the whole Application it could makes
sense to add it as a sync option rather than a resource annotation. It
also could be more convenient to integrate in certain workflows for
users.

Signed-off-by: Arthur Outhenin-Chalandre <[email protected]>

Author: MrFreezeex

controller/appcontroller.go

@@ -1217,6 +1217,11 @@ func (ctrl *ApplicationController) finalizeApplicationDeletion(app *appv1.Applic
 			return err
 		}
 
+		if app.Spec.SyncPolicy != nil && app.Spec.SyncPolicy.SyncOptions.HasOption(synccommon.SyncOptionDeleteRequireConfirm) && !deletionApproved {
+			logCtx.Infof("Application requires manual confirmation to be deleted")
+			return nil
+		}
+
 		for k := range objsMap {
 			// Wait for objects pending deletion to complete before proceeding with next sync wave
 			if objsMap[k].GetDeletionTimestamp() != nil {

controller/sync.go

@@ -377,6 +377,7 @@ func (m *appStateManager) SyncAppState(app *v1alpha1.Application, state *v1alpha
 		sync.WithServerSideApply(syncOp.SyncOptions.HasOption(common.SyncOptionServerSideApply)),
 		sync.WithServerSideApplyManager(cdcommon.ArgoCDSSAManager),
 		sync.WithPruneConfirmed(app.IsDeletionConfirmed(state.StartedAt.Time)),
+		sync.WithRequiresPruneConfirmation(syncOp.SyncOptions.HasOption(common.SyncOptionPruneRequireConfirm)),
 		sync.WithSkipDryRunOnMissingResource(syncOp.SyncOptions.HasOption(common.SyncOptionSkipDryRunOnMissingResource)),
 	}
 

docs/user-guide/sync-options.md

@@ -34,6 +34,20 @@ metadata:
 To confirm the pruning you can use Argo CD UI, CLI or manually apply the `argocd.argoproj.io/deletion-approved: <ISO formatted timestamp>`
 annotation to the application.
 
+It also can be enabled at the application level like in the example below:
+
+```yaml
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+spec:
+  syncPolicy:
+    syncOptions:
+    - Prune=confirm
+```
+
+Note that setting a Prune sync option on the application level will not override
+the same sync option set on a specific resource, both will still be applied.
+
 ## Disable Kubectl Validation
 
 For a certain class of objects, it is necessary to `kubectl apply` them using the `--validate=false` flag. Examples of this are Kubernetes types which uses `RawExtension`, such as [ServiceCatalog](https://github.com/kubernetes-incubator/service-catalog/blob/master/pkg/apis/servicecatalog/v1beta1/types.go#L497). You can do that using this annotation:
@@ -101,6 +115,20 @@ metadata:
 To confirm the deletion you can use Argo CD UI, CLI or manually apply the `argocd.argoproj.io/deletion-approved: <ISO formatted timestamp>`
 annotation to the application.
 
+It also can be enabled at the application level like in the example below:
+
+```yaml
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+spec:
+  syncPolicy:
+    syncOptions:
+    - Delete=confirm
+```
+
+Note that setting a Delete sync option on the application level will not override
+the same sync option set on a specific resource, both will still be applied.
+
 ## Selective Sync
 
 Currently, when syncing using auto sync Argo CD applies every object in the application.

test/e2e/app_management_test.go

@@ -3030,6 +3030,42 @@ func TestDeletionConfirmation(t *testing.T) {
 		Then().Expect(DoesNotExist())
 }
 
+func TestDeletionConfirmationSyncOption(t *testing.T) {
+	ctx := Given(t)
+	ctx.
+		And(func() {
+			_, err := fixture.KubeClientset.CoreV1().ConfigMaps(fixture.DeploymentNamespace()).Create(
+				t.Context(), &corev1.ConfigMap{
+					ObjectMeta: metav1.ObjectMeta{
+						Name: "test-configmap",
+						Labels: map[string]string{
+							common.LabelKeyAppInstance: ctx.AppName(),
+						},
+					},
+				}, metav1.CreateOptions{})
+			require.NoError(t, err)
+		}).
+		Path(guestbookPath).
+		Async(true).
+		When().
+		CreateApp().Then().When().
+		PatchApp(`[{
+			"op": "add",
+			"path": "/spec/syncPolicy",
+			"value": { "syncOptions": ["Delete=confirm", "Prune=confirm"] }
+			}]`).Sync().
+		Then().Expect(OperationPhaseIs(OperationRunning)).
+		When().ConfirmDeletion().
+		Then().Expect(OperationPhaseIs(OperationSucceeded)).
+		When().Delete(true).
+		Then().
+		And(func(app *Application) {
+			assert.NotNil(t, app.DeletionTimestamp)
+		}).
+		When().ConfirmDeletion().
+		Then().Expect(DoesNotExist())
+}
+
 func TestLastTransitionTimeUnchangedError(t *testing.T) {
 	// Ensure that, if the health status hasn't changed, the lastTransitionTime is not updated.
 

ui/src/app/applications/components/application-details/application-details.tsx

@@ -1039,6 +1039,19 @@ export class ApplicationDetails extends React.Component<RouteComponentProps<{app
             iconClassName: ext.iconClassName
         };
     }
+
+    private requiresDeletionConfirmation(app: appModels.Application): boolean {
+        if (app.status.resources.find(r => r.requiresDeletionConfirmation)) {
+            return true;
+        }
+
+        if (app.spec.syncPolicy?.syncOptions?.includes('Delete=confirm') || app.spec.syncPolicy?.syncOptions?.includes('Prune=confirm')) {
+            return true;
+        }
+
+        return false;
+    }
+
     private getApplicationActionMenu(app: appModels.Application, needOverlapLabelOnNarrowScreen: boolean) {
         const refreshing = app.metadata.annotations && app.metadata.annotations[appModels.AnnotationRefreshKey];
         const fullName = AppUtils.nodeKey({group: 'argoproj.io', kind: app.kind, name: app.metadata.name, namespace: app.metadata.namespace});
@@ -1064,7 +1077,7 @@ export class ApplicationDetails extends React.Component<RouteComponentProps<{app
                 action: () => AppUtils.showDeploy('all', null, this.appContext.apis),
                 disabled: !app.spec.source && (!app.spec.sources || app.spec.sources.length === 0) && !app.spec.sourceHydrator
             },
-            ...(app.status?.operationState?.phase === 'Running' && app.status.resources.find(r => r.requiresDeletionConfirmation)
+            ...(app.status?.operationState?.phase === 'Running' && this.requiresDeletionConfirmation(app)
                 ? [
                       {
                           iconClassName: 'fa fa-check',
@@ -1087,9 +1100,7 @@ export class ApplicationDetails extends React.Component<RouteComponentProps<{app
                 },
                 disabled: !app.status.operationState
             },
-            app.metadata.deletionTimestamp &&
-            app.status.resources.find(r => r.requiresDeletionConfirmation) &&
-            !((app.metadata.annotations || {})[appModels.AppDeletionConfirmedAnnotation] == 'true')
+            app.metadata.deletionTimestamp && this.requiresDeletionConfirmation(app) && !((app.metadata.annotations || {})[appModels.AppDeletionConfirmedAnnotation] == 'true')
                 ? {
                       iconClassName: 'fa fa-check',
                       title: <ActionMenuItem actionLabel='Confirm Deletion' />,