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

Retain and expose helm template for argocd applications #4733

Open
jsoref opened this issue Nov 2, 2020 · 9 comments
Open

Retain and expose helm template for argocd applications #4733

jsoref opened this issue Nov 2, 2020 · 9 comments
Labels
enhancement New feature or request

Comments

@jsoref
Copy link
Member

jsoref commented Nov 2, 2020

Summary

helm template when run will print out the results of templating the NOTES.txt file which can have valuable information.

Motivation

The bitnami/postgresql-ha helm chart NOTES.txt includes commands for connecting / getting the password, but since we used argocd to deploy it, I didn't get to see the results.

Proposal

Expose this either on the Summary tab or in a new tab of the Application view

@jsoref jsoref added the enhancement New feature or request label Nov 2, 2020
@jessesuen
Copy link
Member

How does helm template produce the output of notes since it's only supposed to produce apply-able YAML? As comments?

@jsoref
Copy link
Member Author

jsoref commented Nov 3, 2020

Sorry, it might be helm get notes -- I really haven't figured this stuff out, but it seems important.

@jsoref
Copy link
Member Author

jsoref commented Dec 30, 2020

In addition to wanting NOTES.txt, we also want the general helm template output (and the command that was run to generate it -- especially for when it fails). Currently, we have to search through logs for the helm template command and then run it locally for debugging.

@jsoref
Copy link
Member Author

jsoref commented Jan 8, 2021

For my reference,

helm status -n some-namespace generated-name

seemed to get me the notes content corresponding to a chart installed using

helm install -n some-namespace --generate-name .

@jsoref
Copy link
Member Author

jsoref commented Jan 18, 2021

#4733 (comment) seems to be #5225

@timvol
Copy link

timvol commented Jun 11, 2021

I would be also very glad if we can show the NOTES.txt on the summary. It would help to find important information like generated passwords and so on.

@abdennour
Copy link

abdennour commented Nov 16, 2021

NOTES.txt is my friend
While implementing helm charts for delivery teams, i intentionally don't provide 2 documentations. I kept always NOTES.txt as my single source of documentation truth.

I would like to present it in argocd app, and why not can't be retrieved thru CLI

@abdennour
Copy link

Any activities on this great feature ?
Do you want some ideas/acceptance criteria ?

Acceptance Criteria ( Proposal)

  • [UI] adding button with icon whether notes icon, or doc icon or info icon.
  • [UI] adding this button in the right place : it can be with the same group of "Sync", "Refresh".. or another place . I am not UX guy :)
  • [Plugin] ArgoCD Plugin should not only support "init" & "generate" phases, but also "generate-docs" as 3rd phase.
  • [CLI] argocd app docs my-app or argocd app notes my-app to be available .. default to empty string.
  • Ideally, ability to parse it as MARKDOWN

@abdennour
Copy link

@jessesuen please check my proposed acceptance criteria above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants