Skip to content

docs: clarify that sync and terminate operations are allowed on autonomous apps from the hub#1002

Merged
jannfis merged 1 commit into
argoproj-labs:mainfrom
mikeshng:doc-fix
Jun 17, 2026
Merged

docs: clarify that sync and terminate operations are allowed on autonomous apps from the hub#1002
jannfis merged 1 commit into
argoproj-labs:mainfrom
mikeshng:doc-fix

Conversation

@mikeshng

@mikeshng mikeshng commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do / why we need it:

I was reviewing a backup/restore design doc authored by someone and he didn't realize you can sync/terminate from the hub even in autonomous mode. This PR clarifies that sync and terminate operations are allowed on autonomous apps from the hub.

Which issue(s) this PR fixes:

Fixes #

How to test changes / Special notes to the reviewer:

Checklist

  • Documentation update is required by this PR (and has been updated) OR no documentation update is required.

Summary by CodeRabbit

Documentation

  • Clarified autonomous mode behavior: users can inspect but not modify application configuration specs
  • Configuration spec changes are automatically reverted to match agent versions
  • Updated guidance on how sync and terminate operations are forwarded from the principal to the agent
  • Emphasized that workload clusters operate fully autonomously with the control plane serving as an observation tool

…omous apps from the hub

Signed-off-by: Mike Ng <ming@redhat.com>
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Two documentation files are updated to clarify autonomous agent mode behavior: principal spec changes on the control plane are automatically reverted, sync and terminate operations are forwarded from the principal to the agent, and the control plane's role is described as primarily observational.

Changes

Autonomous Mode Documentation Clarification

Layer / File(s) Summary
Autonomous mode principal interaction contract
docs/concepts/agent-modes/autonomous.md, docs/user-guide/applications.md
Both files are updated to describe that principal spec-level changes are automatically reverted to match the agent's version, sync and terminate operations are forwarded from the principal to the agent, and the control plane acts mainly as an observation tool for workload clusters.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 The agent knows best, so the spec stays its own,
No principal edits shall stick to the stone.
Sync and terminate — yes, those may pass through,
But config reverts keep the workload cluster true.
The control plane watches, it mirrors, it sees —
Autonomous hops along, doing just as it pleases! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: clarifying that sync and terminate operations are allowed on autonomous apps from the hub, which matches the documented changes in both autonomous.md and applications.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/concepts/agent-modes/autonomous.md (1)

7-7: 💤 Low value

Minor grammar suggestion: use "cannot" instead of "not able to."

The static analysis tool flags "are not able to" as verbose. Simplifying to "cannot" improves brevity and readability.

- Users can use the Argo CD UI, CLI or API to inspect the status of the configuration, but they are not able to modify
+ Users can use the Argo CD UI, CLI or API to inspect the status of the configuration, but they cannot modify

This is a minor stylistic improvement and entirely optional.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/concepts/agent-modes/autonomous.md` at line 7, Replace the phrase "are
not able to" with "cannot" in the sentence about user permissions for modifying
configuration. Specifically, change "they are not able to modify the
configuration spec or delete it" to "they cannot modify the configuration spec
or delete it" to improve brevity and readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/concepts/agent-modes/autonomous.md`:
- Line 7: Replace the phrase "are not able to" with "cannot" in the sentence
about user permissions for modifying configuration. Specifically, change "they
are not able to modify the configuration spec or delete it" to "they cannot
modify the configuration spec or delete it" to improve brevity and readability.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5226485c-f21f-4ea8-9b1a-84685fe8ac2f

📥 Commits

Reviewing files that changed from the base of the PR and between c37e3bf and 909bbdc.

📒 Files selected for processing (2)
  • docs/concepts/agent-modes/autonomous.md
  • docs/user-guide/applications.md

@jannfis jannfis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks a lot @mikeshng

@jannfis jannfis merged commit 1bf8d9f into argoproj-labs:main Jun 17, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants