chore: update gitops engine for force sync option (#5882)

[kkk777-7]

Update gitops-engine for enable force sync option. Also, add e2e and docs.
Ref: argoproj/gitops-engine#560

Related Issue number
Closes #5882
Closes #7459
Closes #9163

Checklist:

• Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
• The title of the PR states what changed and the related issues number (used for the release note).
• The title of the PR conforms to the Toolchain Guide
• I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
• I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
• Does this PR require documentation updates?
• I've updated documentation as required by this PR.
• I have signed off all my commits as required by DCO
• I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
• My build is green (troubleshooting builds).
• My new feature complies with the feature status guidelines.
• I have added a brief description of why this PR is necessary and/or what this PR solves.
• Optional. My organization is added to USERS.md.
• Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

[kkk777-7]

@pasha-codefresh , Could you please review when you have some time?

[pasha-codefresh]

@CodiumAI-Agent /review

[CodiumAI-Agent]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and localized to specific files, involving updates to tests, documentation, and dependency versions.
🧪 Relevant tests	Yes
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

---

relevant file	test/e2e/sync_options_test.go
suggestion	Consider adding a negative test case to ensure that the Force=true,Replace=true options do not apply incorrectly or affect other resources. This will help in maintaining robustness and catching potential regressions. [important]
relevant line	PatchFile("guestbook-ui-deployment.yaml", `[{ "op": "add", "path": "/metadata/annotations", "value": { "argocd.argoproj.io/sync-options": "Force=true,Replace=true" }}]`).

---

relevant file	test/e2e/sync_options_test.go
suggestion	Add verification steps after the Sync() operation to check the state of the deployment or other resources to ensure that the Force=true,Replace=true options have the intended effect. This can be done by querying the Kubernetes API or using assertions on expected resource states. [important]
relevant line	Sync().

---

relevant file	docs/user-guide/sync-options.md
suggestion	Include a warning or note about potential risks or considerations when using Force=true,Replace=true, such as possible disruptions or side effects on running applications. This is important for operational safety and user awareness. [medium]
relevant line	argocd.argoproj.io/sync-options: Force=true,Replace=true

---

relevant file	go.mod
suggestion	Ensure that the updated version of github.com/argoproj/gitops-engine is thoroughly tested in different environments as it might contain significant changes. Consider setting up a canary deployment or feature flag to mitigate potential risks. [important]
relevant line	github.com/argoproj/gitops-engine v0.7.1-0.20240416142647-fbecbb86e412

---

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

• With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[pasha-codefresh]

I would also add warning about risks to use replace option, like here

[kkk777-7]

@pasha-codefresh
thank you comment !
I added warning description of force sync options.

[pasha-codefresh]

LGTM, just small comment @kkk777-7

[tybook]

Thank you for implementing this! Could we please get this set up for release as part of v2.10.8? Not familiar with the release process for this repo.

[tybook]

Gentle nudge :) Could this be included in a patch release soon? This is the last piece needed for ArgoCD to handle jobs for us well. @pasha-codefresh

[eitan-papaya]

Same, looks like it didn't make it into the 2.11.0 release, was really waiting for this change. Any status update on when should we expect this?

[pasha-codefresh]

We need cherry-pick it, let me see if i can help here @eitan-papaya

[pasha-codefresh]

/cherry-pick release-2.10

[gcp-cherry-pick-bot]

Cherry-pick failed with Merge error db615ed1c55dde361287726eb2748b4a3fb2d0b1 into temp-cherry-pick-8f3a2d-release-2.10

[pasha-codefresh]

@eitan-papaya @tybook going to cherry-pick it into 2.10, 2.11, let me know if you need it for 2.8 or 2.9

[eitan-papaya]

@pasha-codefresh
For me 2.10+2.11 is great, don't need for 2.8/2.9. Thank you very much! :)

[digitalyuki]

@pasha-codefresh , I just found this thread, is there any chance you could also cherry-pick it into the 2.9 release? I've seen your 2 PRs to the 2.10 and 2.11 release branches, it looks straightforward and I could give it a shot if you prefer, but as a non-contributor I suspect it would take me longer to get it all approved / merged in, etc.

[pasha-codefresh]

@digitalyuki could you please just cherry-pick it? i will make sure that it is reviewed and merged. Let me know if you meed any issues

[digitalyuki]

@pasha-codefresh here's my attempt to cherry-pick it to for 2.9... Not sure why it failed the CI but committing to this repo is new for me.
#18259

[eitan-papaya]

@pasha-codefresh Thanks again for the quick response. When could we expect a release including this (either 2.10/2.11)? I saw in the docs:

Argo CD patch releases occur on an as-needed basis.

So wanted to understand better if it's expected in the upcoming days or that it can happen sooner given a request.

[pasha-codefresh]

I will do release during next week, approximately Tuesday

[ishaan-tf]

@pasha-codefresh Wanted to know, if we included this in a patch release for 2.10/2.11?