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

Create a helm chart style guide #2

Open
mattmceuen opened this issue Mar 11, 2021 · 1 comment
Open

Create a helm chart style guide #2

mattmceuen opened this issue Mar 11, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@mattmceuen
Copy link
Contributor

This issue is twofold:

First, to lay the groundwork for a helm chart style guide, as a .md document in the airship charts project. Over time this can grow into a comprehensive set of recommendations for Airship's opinions around when to use charts, where charts should live, how charts should be written, and how they should behave.

Second, to specifically add content around one pressing concern: we need to make sure that any CRDs that are applied via a helm chart are not deleted when the chart is deleted. Otherwise, we run the risk of impacting running workloads during operational activities. Helm v2 and v3 have different mechanisms to solve for this problem, and this style guide should document (and/or link to documentation for) both:

  • for Helm v2, there is a hook that allows CRDs to be deployed separately from resources
  • for Helm v3, there is a crds/ folder that allows CRDs to be deployed separately from resources

Any related information that would be helpful to chart developers should be included in this guide.

@mattmceuen mattmceuen added the documentation Improvements or additions to documentation label Mar 11, 2021
@mattmceuen
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant