Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add Git-Sync to GitDagBundle migration guide for the Helm chart - #73082

Open
developer-rpai wants to merge 1 commit into
apache:mainfrom
developer-rpai:docs/gitsync-to-gitdagbundle-migration
Open

Add Git-Sync to GitDagBundle migration guide for the Helm chart#73082
developer-rpai wants to merge 1 commit into
apache:mainfrom
developer-rpai:docs/gitsync-to-gitdagbundle-migration

Conversation

@developer-rpai

Copy link
Copy Markdown

Adds a migration guide for Helm chart users moving from the Git-Sync sidecar (dags.gitSync) to the Airflow-native GitDagBundle, as requested in #42918.

The guide covers:

  • What is changing: sync moves into the Dag Processor, no sidecar containers or shared ReadWriteMany volume needed.
  • A value-mapping table: every dags.gitSync.* key to its dagProcessor.dagBundleConfigList[].kwargs equivalent (repo -> repo_url, branch/ref/rev -> tracking_ref, subPath -> subdir, period -> refresh_interval, credentialsSecret -> git_conn_id, SSH secrets -> connection extras), with keys that have no equivalent explicitly marked.
  • Auth patterns for public repos, private HTTPS repos (via AIRFLOW_CONN_* from extraSecrets), and SSH key pointers.
  • A 4-step migration (translate values, disable dags.gitSync/dags.persistence, helm upgrade, verify), a multi-repo example, and the SHA-pinning restart caveat.

Accuracy was checked against the provider source (GitDagBundle kwargs, hook auth semantics) and the chart's values.yaml/_helpers.yaml on main. Git-Sync removal is framed as planned for Chart 2.0, not already done.

The Git-Sync sidecar (dags.gitSync) is planned for removal in Helm
Chart 2.0 in favour of the Airflow-native GitDagBundle. This adds a
chart docs page mapping the old dags.gitSync values to their
dagProcessor.dagBundleConfigList equivalents, with authentication
patterns and a step-by-step migration.
@boring-cyborg

boring-cyborg Bot commented Sep 13, 2026

Copy link
Copy Markdown

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example Dag that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@shahar1 shahar1 added the area:dag-bundles AIP-66 label Sep 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants