Skip to content

docs: Adding Argo CD CLI plugin support proposal #19624

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Feb 28, 2025
Merged

docs: Adding Argo CD CLI plugin support proposal #19624

merged 2 commits into from
Feb 28, 2025

Conversation

christianh814
Copy link
Member

@christianh814 christianh814 commented Aug 21, 2024 •
edited by blakepettersson
Loading

Enhancement Proposal to add support for plugins for the argocd CLI, similar to kubectl.

cc: @nitishfy @alexmt

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

@christianh814
docs: Adding Argo CD CLI support proposal
d1c6bf8 
Signed-off-by: Christian Hernandez <christian@chernand.io>
@christianh814 christianh814 requested review from a team as code owners August 21, 2024 19:15
@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Aug 21, 2024 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Aug 21, 2024 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

blakepettersson
blakepettersson reviewed Sep 4, 2024
View reviewed changes
docs/proposals/argocd-cli-pluin.md

Things to consider:

* Should it act exactly like `kubectl` and just look in `$PATH` or be more stringent and have users store plugins in `~/.config/argocd/plugins`? Similar to [Tekton plugins](https://tekton.dev/vault/cli-main/tkn-plugins/#location)
Copy link
Member

Choose a reason for hiding this comment

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

IMO it should do the latter (have users store plugins in ~/.config/argocd/plugins)

blakepettersson
blakepettersson reviewed Sep 4, 2024
View reviewed changes
docs/proposals/argocd-cli-pluin.md

* Should it act exactly like `kubectl` and just look in `$PATH` or be more stringent and have users store plugins in `~/.config/argocd/plugins`? Similar to [Tekton plugins](https://tekton.dev/vault/cli-main/tkn-plugins/#location)
* Is there a way to integrate this with [Krew](https://krew.sigs.k8s.io/) for installing plugins?
* Should we let each plugin manage its own configuration settings or make plugins use `~/.config/argocd/config` and provide a new field called `.pluginConfigs`? For example the `argocd-mytool` plugin's config will be under `.pluginConfigs.mytool` Should we even care/have an opinion?
Copy link
Member

Choose a reason for hiding this comment

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

Can you provide examples of configuration settings that would be required by a plugin?

Copy link
Member

Choose a reason for hiding this comment

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

cc @christianh814 ^^

Copy link
Member Author

Choose a reason for hiding this comment

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

I can't think of one. Was thinking for about "in the future". Probably not needed for a first draft

@nitishfy nitishfy mentioned this pull request Sep 24, 2024
Merged
14 tasks
todaywasawesome
todaywasawesome approved these changes Oct 16, 2024
View reviewed changes
Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

I think this is probably ready to start work.

@nitishfy
Copy link
Member

I think this is probably ready to start work.

We are already working on this.

@agaudreault agaudreault changed the title docs: Adding Argo CD CLI support proposal docs: Adding Argo CD CLI plugin support proposal Dec 4, 2024
@blakepettersson
Copy link
Member

@nitishfy @christianh814 does this docs PR need updating, to reflect the status of the PR in #20074?

@nitishfy
Copy link
Member

@nitishfy @christianh814 does this docs PR need updating, to reflect the status of the PR in #20074?

I don't think so.

leoluz
leoluz approved these changes Feb 28, 2025
View reviewed changes
Copy link
Collaborator

@leoluz leoluz left a comment

Choose a reason for hiding this comment

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

LGTM

@leoluz leoluz merged commit 3f74b24 into argoproj:master Feb 28, 2025
23 checks passed
chzar pushed a commit to chzar/argo-cd that referenced this pull request Mar 3, 2025
@christianh814 @blakepettersson @chzar
docs: Adding Argo CD CLI plugin support proposal (argoproj#19624)
34b5c15 
Signed-off-by: Christian Hernandez <christian@chernand.io>
Co-authored-by: Blake Pettersson <blake.pettersson@gmail.com>
kingbj940429 pushed a commit to kingbj940429/argo-cd that referenced this pull request Mar 4, 2025
@christianh814 @blakepettersson @kingbj940429
docs: Adding Argo CD CLI plugin support proposal (argoproj#19624)
589b33d 
Signed-off-by: Christian Hernandez <christian@chernand.io>
Co-authored-by: Blake Pettersson <blake.pettersson@gmail.com>
Signed-off-by: kingbj0429 <kingbj0429@lunit.io>
Hapshanko pushed a commit to Hapshanko/argo-cd that referenced this pull request Apr 29, 2025
@christianh814 @blakepettersson @Hapshanko
docs: Adding Argo CD CLI plugin support proposal (argoproj#19624)
2b6647d 
Signed-off-by: Christian Hernandez <christian@chernand.io>
Co-authored-by: Blake Pettersson <blake.pettersson@gmail.com>
Signed-off-by: Hapshanko <adamgaming391100@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blakepettersson blakepettersson blakepettersson left review comments

@nitishfy nitishfy nitishfy left review comments

@leoluz leoluz leoluz approved these changes

@todaywasawesome todaywasawesome todaywasawesome approved these changes

+1 more reviewer

@wanghong230 wanghong230 wanghong230 approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@christianh814 @nitishfy @blakepettersson @leoluz @wanghong230 @todaywasawesome