feat: add Prune and Delete as application level sync option #23370

MrFreezeex · 2025-06-12T12:39:01Z

Checklist:

DO NOT MERGE AS IS, depends on: argoproj/gitops-engine#734

My goal was mainly to add Prune/Delete=confirm as a sync option as the deletion confirmation acts on the whole Application already and it's way more convenient in our env to add it on the application level than as annotation on the resources actually deployed.

For consistency I also added Prune/Delete=false support there (separate commit).

And the UI option in when editing the sync policy for the Prune and Delete sync options

Closes #23380

bunnyshell · 2025-06-12T12:39:05Z

❗ Preview Environment deployment failed on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

🚀 /bns:deploy to redeploy the environment
❌ /bns:delete to remove the environment

codecov · 2025-06-12T13:31:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.15%. Comparing base (a3ef471) to head (38e4817).
Report is 5 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #23370   +/-   ##
=======================================
  Coverage   60.15%   60.15%           
=======================================
  Files         343      343           
  Lines       59004    59041   +37     
=======================================
+ Hits        35494    35517   +23     
- Misses      20657    20661    +4     
- Partials     2853     2863   +10

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pjiang-dev

Could you create an issue describing what the issue/enhancement is and why this change is needed and link it to this PR and your gitops-engine PR?

MrFreezeex · 2025-06-13T08:23:36Z

Could you create an issue describing what the issue/enhancement is and why this change is needed and link it to this PR and your gitops-engine PR?

Sure! I just did that here: #23380

pjiang-dev · 2025-06-13T22:38:28Z

The deletion part LGTM. Maybe helpful to add a screenshot or video of the sync option working. Thanks

pjiang-dev · 2025-06-13T22:46:05Z

docs/user-guide/sync-options.md

@@ -14,6 +14,17 @@ metadata:
    argocd.argoproj.io/sync-options: Prune=false
 ```

+It also can be enabled at the application level like in the example below:


Also just one question, if an application's resource has prune=true enabled, but the application has prune=false, which one takes priority? I am assuming resource level should take priority ? Same with the other options.
If not documented somewhere already i think its worth mentioning in the docs

The Prune/Delete=true are not an actual thing, it's just something added in the UI that can act as a default option. Prune=helloworld would be similarly handled technically :p.

For the rest of the options there is not really a priority thing currently, both behavior will apply. For instance if you have Delete=confirm and Delete=false on some resources it will ask you for confirmation and do not delete the resource marked as delete=false (and similarly with prune). I will add clarification for that in docs, thanks!

Done! Let me know if the new doc is more clear!

MrFreezeex · 2025-06-16T11:18:37Z

Maybe helpful to add a screenshot or video of the sync option working. Thanks

Sure, will try to provide a video later today!

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

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]>

MrFreezeex · 2025-06-17T13:13:06Z

(rebasing for the go.mod conflict below and bumping the gitops-engine fork, no other code change)

MrFreezeex · 2025-06-17T13:42:12Z

@pjiang-dev here is the video (I had to fix a dumb typo https://github.com/argoproj/gitops-engine/compare/13f9343d366f59f29905dda9c8ef4e6257a67c67..03789b820ebec73de41af43a35493983c1832e01 in the gitops-engine so thanks for making me double check 🙈)

recording.mp4

MrFreezeex · 2025-06-17T13:45:41Z

FYI here is the yaml that I am using in the video above:

---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: test-prune-confirm
  finalizers:
    - resources-finalizer.argocd.argoproj.io
spec:
  project: default
  source:
    repoURL: https://github.com/MrFreezeex/test-argocd-confirm.git
    targetRevision: "testsyncopt"
    path: test-prune
    # path: test-empty
  destination:
    name: in-cluster
    namespace: test-prune-confirm
  syncPolicy:
    automated: {}
    syncOptions:
      - Prune=confirm
---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: test-prune-false
  finalizers:
    - resources-finalizer.argocd.argoproj.io
spec:
  project: default
  source:
    repoURL: https://github.com/MrFreezeex/test-argocd-confirm.git
    targetRevision: "testsyncopt"
    path: test-prune
    # path: test-empty
  destination:
    name: in-cluster
    namespace: test-prune-false
  syncPolicy:
    automated: {}
    syncOptions:
      - Prune=false
---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: test-delete-confirm
  finalizers:
    - resources-finalizer.argocd.argoproj.io
spec:
  project: default
  source:
    repoURL: https://github.com/MrFreezeex/test-argocd-confirm.git
    targetRevision: "testsyncopt"
    path: test-delete
  destination:
    name: in-cluster
    namespace: test-delete-confirm
  syncPolicy:
    automated: {}
    syncOptions:
      - Delete=confirm
---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: test-delete-false
  finalizers:
    - resources-finalizer.argocd.argoproj.io
spec:
  project: default
  source:
    repoURL: https://github.com/MrFreezeex/test-argocd-confirm.git
    targetRevision: "testsyncopt"
    path: test-delete
  destination:
    name: in-cluster
    namespace: test-delete-false
  syncPolicy:
    automated: {}
    syncOptions:
      - Delete=false

agaudreault · 2025-06-17T14:23:06Z

docs/user-guide/sync-options.md

+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.


Which one has the precedence? What happens if prune=false on the application level, but prune=confirm on the resource?

It will apply both, in this case you will get a confirmation prompt and no resources will be pruned

(This is the current behavior proposed by this PR but I can definitely take a look at figuring out some precedence policy if you want resource overriding app level or the other way around)

agaudreault · 2025-06-17T14:23:58Z

docs/user-guide/sync-options.md

+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.
+


Instead of repeating the doc, specify that the same value can be use either through the annotation or the sync option.

I don't mind doing that but IIUC adding both like that is consistent with the current doc, for instance ServerSideApply: https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#server-side-apply

ui/src/app/applications/components/application-sync-options/application-sync-options.tsx

agaudreault · 2025-06-17T14:28:40Z

go.mod

@@ -338,3 +338,5 @@ replace (
 	k8s.io/sample-cli-plugin => k8s.io/sample-cli-plugin v0.33.1
 	k8s.io/sample-controller => k8s.io/sample-controller v0.33.1
 )
+
+replace github.com/argoproj/gitops-engine => github.com/MrFreezeex/gitops-engine v0.0.0-20250617130229-7f8ccfc83e5f


Remove when ready to merge

test/e2e/app_management_test.go

For consistency with Prune/Delete=confirm that are now present as application level sync option add Prune/Delete=false as sync option too. Signed-off-by: Arthur Outhenin-Chalandre <[email protected]>

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

MrFreezeex force-pushed the sync-option-confirm branch 2 times, most recently from f5381c1 to b2ca286 Compare June 12, 2025 12:50

MrFreezeex marked this pull request as ready for review June 12, 2025 15:07

MrFreezeex requested review from a team as code owners June 12, 2025 15:07

MrFreezeex force-pushed the sync-option-confirm branch from b2ca286 to 5d5a4c3 Compare June 12, 2025 15:16

pjiang-dev reviewed Jun 13, 2025

View reviewed changes

MrFreezeex mentioned this pull request Jun 13, 2025

feat: add Prune as application level sync option argoproj/gitops-engine#734

Open

MrFreezeex requested a review from pjiang-dev June 13, 2025 08:23

pjiang-dev added the ready-for-review label Jun 13, 2025

github-project-automation bot moved this to Ready for final review in Argo CD Review Jun 13, 2025

github-project-automation bot added this to Argo CD Review Jun 13, 2025

pjiang-dev reviewed Jun 13, 2025

View reviewed changes

MrFreezeex force-pushed the sync-option-confirm branch from 5d5a4c3 to 5ab9a2b Compare June 16, 2025 11:13

MrFreezeex added 2 commits June 17, 2025 15:06

chore: bump gitops-engine

45e1d9a

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

MrFreezeex force-pushed the sync-option-confirm branch 2 times, most recently from 98975a0 to 12498ec Compare June 17, 2025 13:38

agaudreault requested changes Jun 17, 2025

View reviewed changes

github-project-automation bot moved this from Ready for final review to Changes Requested in Argo CD Review Jun 17, 2025

agaudreault added this to the v3.2 milestone Jun 17, 2025

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

e7b9e17

For consistency with Prune/Delete=confirm that are now present as application level sync option add Prune/Delete=false as sync option too. Signed-off-by: Arthur Outhenin-Chalandre <[email protected]>

feat: add Prune and delete sync option edit on UI

38e4817

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

MrFreezeex force-pushed the sync-option-confirm branch from 12498ec to 38e4817 Compare June 17, 2025 14:58

MrFreezeex requested a review from agaudreault June 19, 2025 20:48

		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.

feat: add Prune and Delete as application level sync option #23370

Are you sure you want to change the base?

feat: add Prune and Delete as application level sync option #23370

Conversation

MrFreezeex commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bunnyshell bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❗ Preview Environment deployment failed on Bunnyshell

Uh oh!

codecov bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pjiang-dev left a comment

Choose a reason for hiding this comment

Uh oh!

MrFreezeex commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pjiang-dev commented Jun 13, 2025

Uh oh!

pjiang-dev Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MrFreezeex Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MrFreezeex Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

MrFreezeex commented Jun 16, 2025

Uh oh!

MrFreezeex commented Jun 17, 2025

Uh oh!

MrFreezeex commented Jun 17, 2025

Uh oh!

MrFreezeex commented Jun 17, 2025

Uh oh!

agaudreault Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

MrFreezeex Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

MrFreezeex Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

agaudreault Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

MrFreezeex Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

agaudreault Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MrFreezeex commented Jun 12, 2025 •

edited

Loading

bunnyshell bot commented Jun 12, 2025 •

edited

Loading

codecov bot commented Jun 12, 2025 •

edited

Loading

MrFreezeex commented Jun 13, 2025 •

edited

Loading

pjiang-dev Jun 13, 2025 •

edited

Loading

MrFreezeex Jun 16, 2025 •

edited

Loading