Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Review and Improve Current Documentation for Helm Chart

See original GitHub issue

Comments from https://github.com/apache/airflow/issues/10752#issuecomment-777813401:

the values.yaml file is missing comments for most values
more general explanations are pretty sparse (it seems we currently only have short paragraphs in the README)
examples of common environments are missing (GKE, EKS, On-Prem)
provide upgrade guides for major/minor version bumps of the chart

All of this should be initially included in README.md and ideally we should have some sort of documentation for Helm Chart here: https://airflow.apache.org/docs/ (maybe https://airflow.apache.org/docs/helm-chart/stable)

We can also autogenerate some docs based on values.schema.json as mentioned in https://github.com/apache/airflow/issues/11077

Issue Analytics

State:
Created 3 years ago
Comments:6 (5 by maintainers)

Top GitHub Comments

1reaction

mik-lajcommented, Mar 7, 2021

I think it is worth focusing on the following so that users can set up a minimal production environment:

Images - What images are used by this Helm Chart and what is their purpose? How to set up secrets to be able to pull images?
Logging - How to configure logging for tasks? A short section to remind the user that by default this doesn’t work because we have a distributed environment.
Database - How to configure a connection to the SQL database? So that users do not try to use the default configuration as it is intended for testing only. It is worth mention that in addition to PostgresSQL, we also support MySQL. Additional points can be obtained for the description of the configuration of a mutual-SSL connection.
PG Bouncer -How and Why to use it?
Network - How to make the service available to the end user? Short description with links to relevant Kubernetes documentation.

I think it’s worth describing other things as well, but it’s not necessary to publish the Helm Chart:

How to use Kerberos and how we protect the keytab from user code.
how to set up elasticsearch logging?
How to ensure an identity for the environment in major cloud providers eg. on GCP, we will use Workload Identiity.
StatsD - How and Why to use it?

1reaction

mik-lajcommented, Mar 6, 2021

@kaxil I. I will create a documentation package in docs/helm-chart so that it is easy to publish that documentation on a website.

Top Results From Across the Web

Helm Chart Development Guide - Medium

In this guide, I will describe the fastest way to create a basic chart, present useful commands and show best practices to make...

Developer Guide - Helm

Instructions for setting up your environment for developing Helm. ... docs: Change documentation; test: Improve testing; ref: refactor existing code.

Steering Straight with Helm Charts Best Practices - JFrog

When building your Helm charts repository, these are some good practices to follow when steering your Kubernetes deployment through the ...

Helm charts in the Package Registry - GitLab Docs

To update the Helm client with the most currently available charts. ... Docs. Edit this page to fix an error or add an...

Install with Helm - Istio

See Advanced Helm Chart Customization 13 for in-depth documentation on how to use Helm post-renderer to customize the Helm charts. Verifying the installation....