-
Notifications
You must be signed in to change notification settings - Fork 16.3k
Improve Helm Chart Git-Sync documentation #15937
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
Conversation
Mounting DAGs from a private Github repo using Git-Sync sidecar is quite complex because of the several steps required and the many other moving parts. The PR aims to ameliorate some of these pain points so that users can have a smoother experience when mounting their DAGs from private repos on Github.
potiuk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love it. I think it's very much needed.
But I think you need to fix the license indentation :)
|
The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease. |
Oh yeah! Thanks, Jarek. |
| .. code-block:: bash | ||
| helm install airflow --namespace <your-airflow-namespace> . -f override-values.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This would likely change when the chart is released?.
Supposing the user added the released chart to helm with:
helm repo add apache-airflow-chart path/to/chart.
The install should be:
helm install airflow --namespace <your-airflow-namespace> apache-airflow-chart/airflow -f override-values.yaml
I don't know the best way to add it to this doc, maybe we should merge this and update the doc when the Chart is released? @kaxil
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, yes.
I will create a PR while releasing the chart to make sure we are consistent everywhere in the Helm Chart docs.
kaxil
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done @Dr-Denzy 👏 -- As a follow up to this we could generalize this to any "private git repo" and the point raised by @ephraimbuddy which I will cover as part of releasing Helm Chart.
Mounting DAGs from a private Github repo using Git-Sync sidecar is
quite complex because of the several steps required and the many
other moving parts.
The PR aims to ameliorate some of these pain points so that users can
have a smoother experience when mounting their DAGs from private repos
on Github.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.