Skip to content
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

config-management-plugins.md does not describe the input and output of a plugin #9471

Closed
3 tasks done
MikeSpreitzer opened this issue May 20, 2022 · 0 comments · Fixed by #14295
Closed
3 tasks done
Labels
bug Something isn't working component:cmp Config Management Plugin related issues

Comments

@MikeSpreitzer
Copy link

Checklist:

  • I've searched in the docs and FAQ for my answer: https://bit.ly/argocd-faq.
  • I've included steps to reproduce the bug.
  • I've pasted the output of argocd version.

Describe the bug

I wanted to understand plugins, so I went looking through the documentation. Somewhere I found a statement that the output of a plugin should be JSON or YAML, but no details on what that JSON or YAML is. I think the missing statement is something along the lines of saying that the output should be JSON or YAML that defines the kube API objects that the plugin is saying should go to the kube cluster.

I did eventually find a page focused on plugins, https://github.com/argoproj/argo-cd/blob/master/docs/user-guide/config-management-plugins.md . The statement about output belongs on that page. BTW, that page should be easier to find (linked from other places that reference it). Also, I did not find anywhere a statement about what the input to a plugin is. I think that also belongs on this page. If I understand correctly, the input is the contents of the current working directory, which is set to the path of the Application, relative to a git checkout of the commit referenced by the Application.

To Reproduce

Read the docs.

Expected behavior

Easily finding a clear statement of what are the inputs and outputs of a plugin.

Screenshots

N/A

Version

The master branch.

Logs

N/A

@MikeSpreitzer MikeSpreitzer added the bug Something isn't working label May 20, 2022
@jannfis jannfis added type:docs component:cmp Config Management Plugin related issues labels May 23, 2022
crenshaw-dev pushed a commit that referenced this issue Jun 30, 2023
gcp-cherry-pick-bot bot pushed a commit that referenced this issue Jun 30, 2023
gcp-cherry-pick-bot bot pushed a commit that referenced this issue Jun 30, 2023
gcp-cherry-pick-bot bot pushed a commit that referenced this issue Jun 30, 2023
crenshaw-dev pushed a commit that referenced this issue Jun 30, 2023
…ject) (#9471) (#14295) (#14301)

Signed-off-by: Christian Hernandez <[email protected]>
Co-authored-by: Christian Hernandez <[email protected]>
crenshaw-dev pushed a commit that referenced this issue Jun 30, 2023
…ject) (#9471) (#14295) (#14302)

Signed-off-by: Christian Hernandez <[email protected]>
Co-authored-by: Christian Hernandez <[email protected]>
crenshaw-dev pushed a commit that referenced this issue Jun 30, 2023
…ject) (#9471) (#14295) (#14303)

Signed-off-by: Christian Hernandez <[email protected]>
Co-authored-by: Christian Hernandez <[email protected]>
schakrad pushed a commit to schakrad/argo-cd that referenced this issue Jul 24, 2023
…ject) (argoproj#9471) (argoproj#14295) (argoproj#14302)

Signed-off-by: Christian Hernandez <[email protected]>
Co-authored-by: Christian Hernandez <[email protected]>
Signed-off-by: schakrad <[email protected]>
yyzxw pushed a commit to yyzxw/argo-cd that referenced this issue Aug 9, 2023
tesla59 pushed a commit to tesla59/argo-cd that referenced this issue Dec 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working component:cmp Config Management Plugin related issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants