-
Notifications
You must be signed in to change notification settings - Fork 50
docs: add proposal for Argo CD Agent Visibility UI #613
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: jiwlee <[email protected]>
280379d to
e910483
Compare
Jack-R-lantern
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be great if I could see the config of the agent connected to the principal through ui at once
docs/proposals/agent-ui.md
Outdated
| ## Summary | ||
|
|
||
| This proposal introduces a new **Agent Visibility UI** for Argo CD Agent. | ||
| Its purpose is to provide a clear and intuitive way to visualize the **connection and synchronization status** of multiple **Agents** within the Argo CD web interface. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be better to provide the ui from the principal side first than the ui of the argo-cd.
And if the corresponding argocd-agent is promoted, it would be nice to integrate into the ui of the argo-cd at that time
docs/proposals/agent-ui.md
Outdated
|
|
||
| ## Goals | ||
|
|
||
| - Introduce a new **“Agents”** navigation item in the Argo CD sidebar. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
Signed-off-by: jiwlee <[email protected]>
mikeshng
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My general concern about this proposal is that argocd-agent is an optional component to Argo CD but this proposal doesn't explicitly state that. This is an important point to state because it impacts how the UI display this new "Agents" section.
An always visible "Agents" section in the UI would be confusing for users who don't deploy the argocd-agent (might not even know the project exist yet). Please state explicitly early on that argocd-agent is an optional component of Argo CD.
Should the UI be conditional? (However, it might be good for this project's visibility to always have it, something we can also discuss.) The section only render when the it discovers the principal component (or toggle via flags/envs etc). The proposal currently doesn't describe any discovery or enablement path. Documenting a clear mechanism to toggle this UI section might be a good idea or list out all the alternatives (always show, partial show, hide when not available. What if the "Agent" UI feature is enabled but no Principal exist?
|
Currently, agent connection status is exposed through the cluster list view and in the cluster info page in the Argo CD UI. I do think that a lot of the information that this proposal calls for to be exposed (JWT and TLS secrets, just to name a few) is a downright security fiasco. This kind of information neither should nor needs to be exposed anywhere through the Argo CD API or the Argo CD UI. To be honest, I would start exploring the possibility of an Argo CD UI extension instead of asking Argo CD to implement Agent related functionality in the core UI. |
I wasn’t aware that Argo CD UI extensions existed — thank you for letting me know. |
Thanks for the feedback! I completely agree — since the argocd-agent is optional, it makes more sense to handle this as a UI extension rather than building it into the core UI. I’ll update the proposal in that direction. |
What does this PR do / why we need it:
Adds a new proposal document: Agent Visibility UI for Argo CD Agent.
This proposal introduces a simple, visibility-focused UI to visualize the connection and synchronization status of multiple Agents and their Principal within the Argo CD web interface.
Which issue(s) this PR fixes:
Fixes #612
How to test changes / Special notes to the reviewer:
Please review the proposal content under
/docs/proposals/agent-visibility-ui.mdFigma design reference (Tile/List/Tree/Detail mockups with prototype interactions):
View in Figma
Checklist