Add Helm Chart Development Guide#66659
Conversation
bugraoz93
changed the title
|
Please don't merge until Lazy Consensus has been reached. Keeping in Draft. |
| it. It is the contributor-facing guide for chart development; the full | ||
| alignment narrative lives on Confluence (`Helm Refurbish | ||
| <https://cwiki.apache.org/confluence/display/AIRFLOW/Helm+Refurbish>`__). |
There was a problem hiding this comment.
I would assume the document in Confluence is kind of "transitional" and after the project is completed we might move this to Archived/Compled AIP side? Not sure if we should reference here in the code as this is a longer staying artifact?
How about:
| it. It is the contributor-facing guide for chart development; the full | |
| alignment narrative lives on Confluence (`Helm Refurbish | |
| <https://cwiki.apache.org/confluence/display/AIRFLOW/Helm+Refurbish>`__). | |
| it. It is the contributor-facing guide for chart development; while the | |
| chart is in active rework please take a look to the full | |
| alignment narrative lives on Confluence (`Helm Refurbish | |
| <https://cwiki.apache.org/confluence/display/AIRFLOW/Helm+Refurbish>`__). |
| Decision tree | ||
| ------------- | ||
|
|
||
| Start here when adding or modifying a chart parameter or component. |
There was a problem hiding this comment.
Have you considered making this a flowchart visually in MarkDown e.g. via https://asciiflow.com/#/ ?
There was a problem hiding this comment.
https://mermaid.js.org/ could be also a good option for visualizing this flowchart in Markdown.
| ------------------- | ||
|
|
||
| Where each component currently lives. Use this when adding parameters or | ||
| templates that touch a specific component. |
There was a problem hiding this comment.
Should this add that the list is the target state and currently migration is WIP?
| - Service only; PgBouncer ingress is not part of the chart. | ||
| * - Jobs | ||
| - Chart | ||
| - Lives under the kubernetes section. |
There was a problem hiding this comment.
I think this is not 100% true for all jobs. The CreateUser Job for example is independent of K8s Executor.
I think we discussed about this only for K8s Executor specific Jobs.
| - Lives under the kubernetes section. | ||
| * - OpenTelemetry | ||
| - Chart | ||
| - Default telemetry path. |
There was a problem hiding this comment.
Wording
| - Default telemetry path. | |
| - OTel is the designated primary telemetry path and is to be supported by the chart. |
jscheffl
left a comment
jscheffl
left a comment
There was a problem hiding this comment.
Some wording not, otherwise great!
3 participants
Was generative AI tooling used to co-author this PR?
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.