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

Improve documentation of unsupported helm functions #14943

Open
rowi1de opened this issue Aug 7, 2023 · 2 comments
Open

Improve documentation of unsupported helm functions #14943

rowi1de opened this issue Aug 7, 2023 · 2 comments
Labels
enhancement New feature or request type:docs Missing or incomplete documentation

Comments

@rowi1de
Copy link
Contributor

rowi1de commented Aug 7, 2023

Summary

The Helm section doesn’t clearly list all unsupported functions that would require native helm support https://argo-cd.readthedocs.io/en/stable/user-guide/helm/#random-data

Motivation

#7759 (reply in thread)

Currently it requires debugging to find out which part of a helm chart might not work in ArgoCD.

Proposal

The helm section of ArgoCD should list all helm functions like lookup or random data generation etc. that won’t work as expected.
In addition it could be considered to have a section with charts that have known issues and how the workaround look like.
If the list is in a parseable format, it could even be used to build a UI feature on top #14944

@rowi1de rowi1de added the enhancement New feature or request label Aug 7, 2023
@crenshaw-dev
Copy link
Collaborator

There are several things in the FAQ page that could probably be duplicated/linked/moved to the Helm page.

@acelinkio
Copy link

I think it would be useful to have a specific page documenting any unsupported resources. Adding a brief description, symptoms, workarounds, comments (suggestions/references/wont fix/feature in progress/etc). Example:

Helm Hook Support

  • Description: Helm releases offer simple orchestration using hooks. These hooks are not built into the core Kubernetes api. ArgoCD does offer some compatibility, but unable to differentiate between an install or upgrade. Read more: https://argo-cd.readthedocs.io/en/stable/user-guide/helm/#helm-hooks
  • Symptoms: When installing an ArgoCD application leveraging a helm chart pre-upgrade job, the job could be missing required resources to run and hang.
  • Workarounds:
    • Depends on what actions the hook is performing. One option is to equivalent command helm template | kubectl apply -f to avoid hooks.
  • Comments:
    • Helm hooks should be avoided when possible. Any complex logic is best moved into an operator or controller.
    • No plans to reach parity support + link to architectural decision record
    • Add ability to ArgoCD Application to ignore specific annotations (not sure if there is a feature request)
    • Create GitHub action that other projects can use for validation (not sure if there is a feature request)
    • Links to relevant issues:

Not sure if this is the most desired format for FAQ, but would help tracking. There are a lot of philosophy missing in the docs. Akuity's white paper reminded me of this https://akuity.io/blog/argo-cd-flux-comparison/

@christianh814 christianh814 added the type:docs Missing or incomplete documentation label Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request type:docs Missing or incomplete documentation
Projects
None yet
Development

No branches or pull requests

4 participants