You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "developer-rpai (via GitHub)" <gi...@apache.org> on 2026/09/13 13:49:04 UTC
[PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
developer-rpai opened a new pull request, #73082:
URL: https://github.com/apache/airflow/pull/73082
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "veyu (via GitHub)" <gi...@apache.org>.
veyu commented on code in PR #73082:
URL: https://github.com/apache/airflow/pull/73082#discussion_r4006987358
##########
chart/docs/migrate-to-git-dag-bundle.rst:
##########
@@ -0,0 +1,222 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _git_sync_to_git_dag_bundle:
+
+Migrating from Git-Sync to GitDagBundle
+=======================================
+
+This guide is for users of the Git-Sync sidecar (``dags.gitSync``) in Helm Chart 1.x.
+The Git-Sync sidecar is planned for removal in Helm Chart 2.0 in favour of the
+Airflow-native :class:`~airflow.providers.git.bundles.git.GitDagBundle`.
+
+What is changing
+----------------
+
+With Git-Sync, a ``git-sync`` container ran as a sidecar (or init container) on the
+scheduler, dag processor, worker and triggerer pods, keeping a shared DAG folder up
+to date from a git repository.
+
+With ``GitDagBundle``, syncing moves into Airflow itself. The Dag Processor clones
+the repository once into a local bare repository and refreshes it every
+``refresh_interval`` seconds. Task execution resolves DAG code from versioned
+bundles, so workers always run the code version the Dag Processor recorded. No
+sidecar containers and no shared ``ReadWriteMany`` volume are needed for syncing.
+
+Differences to be aware of before migrating:
+
+* Git-Sync synced a single repository per deployment (multiple repositories required
+ an "umbrella" repository with submodules). ``dagProcessor.dagBundleConfigList``
+ accepts multiple bundles, so each repository simply becomes its own bundle.
+* Git-Sync always checked out the latest commit. ``GitDagBundle`` supports
Review Comment:
> Git-Sync always checked out the latest commit
This is not true. I would advise to remove it (preferred) or change it.
Git-Sync could checkout any commit you want using `rev` (for usage with `branch`) or `ref` (to choose any reference available in git repository).
Refer to parameters `dags.gitSync.ref` or `dags.gitSync.rev` here: https://airflow.apache.org/docs/helm-chart/stable/parameters-ref.html#airflow
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "developer-rpai (via GitHub) via commits" <co...@airflow.apache.org>.
developer-rpai commented on PR #73082:
URL: https://github.com/apache/airflow/pull/73082#issuecomment-6624086360
Thanks Miretpl, appreciate the review and the merge. Happy to help with any follow-up.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "developer-rpai (via GitHub)" <gi...@apache.org>.
developer-rpai commented on PR #73082:
URL: https://github.com/apache/airflow/pull/73082#issuecomment-6032848652
Hi Miretpl, a heads-up that the September 25 revision addresses each of your five review comments: the shared DAG folder wording in What is changing, the Helm Chart 1.x prerequisite bullet, the credentialsSecret env var list in the mapping table, the clarification of what kwargs.git_conn_id refers to, and a new paragraph noting the git connection can also be created directly in the Airflow UI or with airflow connections add. Would you mind taking another look when you get a chance?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "Miretpl (via GitHub) via commits" <co...@airflow.apache.org>.
Miretpl merged PR #73082:
URL: https://github.com/apache/airflow/pull/73082
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "Miretpl (via GitHub)" <gi...@apache.org>.
Miretpl commented on code in PR #73082:
URL: https://github.com/apache/airflow/pull/73082#discussion_r4097925553
##########
chart/docs/migrate-to-git-dag-bundle.rst:
##########
@@ -0,0 +1,221 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _git_sync_to_git_dag_bundle:
+
+Migrating from Git-Sync to GitDagBundle
+=======================================
+
+This guide is for users of the Git-Sync sidecar (``dags.gitSync``) in Helm Chart 1.x.
+The Git-Sync sidecar is planned for removal in Helm Chart 2.0 in favour of the
+Airflow-native :class:`~airflow.providers.git.bundles.git.GitDagBundle`.
+
+What is changing
+----------------
+
+With Git-Sync, a ``git-sync`` container ran as a sidecar (or init container) on the
+scheduler, dag processor, worker and triggerer pods, keeping a shared DAG folder up
+to date from a git repository.
Review Comment:
```suggestion
Airflow components pods keep a shared DAG folder up to date from a git repository.
```
It depends on the persistence setting. Having it more general resolved the issues of being precise, but still it is true.
##########
chart/docs/migrate-to-git-dag-bundle.rst:
##########
@@ -0,0 +1,221 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _git_sync_to_git_dag_bundle:
+
+Migrating from Git-Sync to GitDagBundle
+=======================================
+
+This guide is for users of the Git-Sync sidecar (``dags.gitSync``) in Helm Chart 1.x.
+The Git-Sync sidecar is planned for removal in Helm Chart 2.0 in favour of the
+Airflow-native :class:`~airflow.providers.git.bundles.git.GitDagBundle`.
+
+What is changing
+----------------
+
+With Git-Sync, a ``git-sync`` container ran as a sidecar (or init container) on the
+scheduler, dag processor, worker and triggerer pods, keeping a shared DAG folder up
+to date from a git repository.
+
+With ``GitDagBundle``, syncing moves into Airflow itself. The Dag Processor clones
+the repository once into a local bare repository and refreshes it every
+``refresh_interval`` seconds. Task execution resolves DAG code from versioned
+bundles, so workers always run the code version the Dag Processor recorded. No
+sidecar containers and no shared ``ReadWriteMany`` volume are needed for syncing.
+
+Differences to be aware of before migrating:
+
+* Git-Sync synced a single repository per deployment (multiple repositories required
+ an "umbrella" repository with submodules). ``dagProcessor.dagBundleConfigList``
+ accepts multiple bundles, so each repository simply becomes its own bundle.
+* ``GitDagBundle`` supports versioning: changing a SHA-pinned ``tracking_ref`` is a configuration change and
+ only takes effect once the Dag Processor restarts and reloads its configuration.
+ Promoting to a *new* SHA can also require the bundle's local storage to be
+ cleared first (for example by letting the pod be recreated) — see
+ `GH-71388 <https://github.com/apache/airflow/issues/71388>`_.
+* ``dags.persistence`` was often enabled only to give Git-Sync a shared volume. It
+ is not needed for ``GitDagBundle`` and can be disabled if nothing else uses it.
+
+Prerequisites
+-------------
+
+* Helm Chart 1.x on Airflow 3 (DAG bundles are an Airflow 3 feature).
+* The ``apache-airflow-providers-git`` provider package must be installed in the
+ image you deploy, along with the ``git`` binary (the ``git`` binary is
+ pre-installed in the official ``apache/airflow`` images starting from Airflow
+ 3.0.2). If you build a custom slim image, add the provider to it.
+
+Value mapping
+-------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 40 60
+
+ * - Git-Sync (``dags.gitSync.*``)
+ - GitDagBundle (``dagProcessor.dagBundleConfigList[].kwargs``)
+ * - ``repo`` — the clone URL
+ - ``repo_url``. Alternatively, store the repository URL in the ``host`` field
+ of a ``git`` connection and reference it with ``git_conn_id``.
+ * - ``branch`` (git-sync v3) / ``ref`` (git-sync v4) — branch, tag or hash to
+ check out
+ - ``tracking_ref`` — accepts a branch, tag or full commit SHA.
+ * - ``rev`` (git-sync v3)
+ - ``tracking_ref``. To follow the tip of a branch, set ``tracking_ref`` to
+ the branch name.
+ * - ``subPath`` — subdirectory with DAGs
+ - ``subdir``
+ * - ``period`` — sync interval as a Go duration string (for example ``"5s"``)
+ - ``refresh_interval`` — sync interval in seconds (integer, for example
+ ``300``)
+ * - ``credentialsSecret`` (``GITSYNC_USERNAME`` / ``GITSYNC_PASSWORD``)
Review Comment:
```suggestion
* - ``credentialsSecret`` (``GITSYNC_USERNAME``, ``GIT_SYNC_USERNAME``, ``GITSYNC_PASSWORD``, ``GIT_SYNC_PASSWORD``)
```
##########
chart/docs/migrate-to-git-dag-bundle.rst:
##########
@@ -0,0 +1,221 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _git_sync_to_git_dag_bundle:
+
+Migrating from Git-Sync to GitDagBundle
+=======================================
+
+This guide is for users of the Git-Sync sidecar (``dags.gitSync``) in Helm Chart 1.x.
+The Git-Sync sidecar is planned for removal in Helm Chart 2.0 in favour of the
+Airflow-native :class:`~airflow.providers.git.bundles.git.GitDagBundle`.
+
+What is changing
+----------------
+
+With Git-Sync, a ``git-sync`` container ran as a sidecar (or init container) on the
+scheduler, dag processor, worker and triggerer pods, keeping a shared DAG folder up
+to date from a git repository.
+
+With ``GitDagBundle``, syncing moves into Airflow itself. The Dag Processor clones
+the repository once into a local bare repository and refreshes it every
+``refresh_interval`` seconds. Task execution resolves DAG code from versioned
+bundles, so workers always run the code version the Dag Processor recorded. No
+sidecar containers and no shared ``ReadWriteMany`` volume are needed for syncing.
+
+Differences to be aware of before migrating:
+
+* Git-Sync synced a single repository per deployment (multiple repositories required
+ an "umbrella" repository with submodules). ``dagProcessor.dagBundleConfigList``
+ accepts multiple bundles, so each repository simply becomes its own bundle.
+* ``GitDagBundle`` supports versioning: changing a SHA-pinned ``tracking_ref`` is a configuration change and
+ only takes effect once the Dag Processor restarts and reloads its configuration.
+ Promoting to a *new* SHA can also require the bundle's local storage to be
+ cleared first (for example by letting the pod be recreated) — see
+ `GH-71388 <https://github.com/apache/airflow/issues/71388>`_.
+* ``dags.persistence`` was often enabled only to give Git-Sync a shared volume. It
+ is not needed for ``GitDagBundle`` and can be disabled if nothing else uses it.
+
+Prerequisites
+-------------
+
+* Helm Chart 1.x on Airflow 3 (DAG bundles are an Airflow 3 feature).
Review Comment:
```suggestion
* Latest Helm Chart 1.x release with Airflow 3 (DAG bundles are an Airflow 3 feature).
```
##########
chart/docs/migrate-to-git-dag-bundle.rst:
##########
@@ -0,0 +1,221 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _git_sync_to_git_dag_bundle:
+
+Migrating from Git-Sync to GitDagBundle
+=======================================
+
+This guide is for users of the Git-Sync sidecar (``dags.gitSync``) in Helm Chart 1.x.
+The Git-Sync sidecar is planned for removal in Helm Chart 2.0 in favour of the
+Airflow-native :class:`~airflow.providers.git.bundles.git.GitDagBundle`.
+
+What is changing
+----------------
+
+With Git-Sync, a ``git-sync`` container ran as a sidecar (or init container) on the
+scheduler, dag processor, worker and triggerer pods, keeping a shared DAG folder up
+to date from a git repository.
+
+With ``GitDagBundle``, syncing moves into Airflow itself. The Dag Processor clones
+the repository once into a local bare repository and refreshes it every
+``refresh_interval`` seconds. Task execution resolves DAG code from versioned
+bundles, so workers always run the code version the Dag Processor recorded. No
+sidecar containers and no shared ``ReadWriteMany`` volume are needed for syncing.
+
+Differences to be aware of before migrating:
+
+* Git-Sync synced a single repository per deployment (multiple repositories required
+ an "umbrella" repository with submodules). ``dagProcessor.dagBundleConfigList``
+ accepts multiple bundles, so each repository simply becomes its own bundle.
+* ``GitDagBundle`` supports versioning: changing a SHA-pinned ``tracking_ref`` is a configuration change and
+ only takes effect once the Dag Processor restarts and reloads its configuration.
+ Promoting to a *new* SHA can also require the bundle's local storage to be
+ cleared first (for example by letting the pod be recreated) — see
+ `GH-71388 <https://github.com/apache/airflow/issues/71388>`_.
+* ``dags.persistence`` was often enabled only to give Git-Sync a shared volume. It
+ is not needed for ``GitDagBundle`` and can be disabled if nothing else uses it.
+
+Prerequisites
+-------------
+
+* Helm Chart 1.x on Airflow 3 (DAG bundles are an Airflow 3 feature).
+* The ``apache-airflow-providers-git`` provider package must be installed in the
+ image you deploy, along with the ``git`` binary (the ``git`` binary is
+ pre-installed in the official ``apache/airflow`` images starting from Airflow
+ 3.0.2). If you build a custom slim image, add the provider to it.
+
+Value mapping
+-------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 40 60
+
+ * - Git-Sync (``dags.gitSync.*``)
+ - GitDagBundle (``dagProcessor.dagBundleConfigList[].kwargs``)
+ * - ``repo`` — the clone URL
+ - ``repo_url``. Alternatively, store the repository URL in the ``host`` field
+ of a ``git`` connection and reference it with ``git_conn_id``.
+ * - ``branch`` (git-sync v3) / ``ref`` (git-sync v4) — branch, tag or hash to
+ check out
+ - ``tracking_ref`` — accepts a branch, tag or full commit SHA.
+ * - ``rev`` (git-sync v3)
+ - ``tracking_ref``. To follow the tip of a branch, set ``tracking_ref`` to
+ the branch name.
+ * - ``subPath`` — subdirectory with DAGs
+ - ``subdir``
+ * - ``period`` — sync interval as a Go duration string (for example ``"5s"``)
+ - ``refresh_interval`` — sync interval in seconds (integer, for example
+ ``300``)
+ * - ``credentialsSecret`` (``GITSYNC_USERNAME`` / ``GITSYNC_PASSWORD``)
+ - ``git_conn_id`` — an Airflow ``git`` connection whose login/password hold
+ the username and access token. See :ref:`git_sync_to_git_dag_bundle:auth`
+ below.
+ * - ``sshKeySecret`` / ``sshKey`` (``gitSshKey``)
+ - ``git_conn_id`` — a ``git`` connection with the SSH private key in the
+ ``private_key`` extra (inline key) or ``key_file`` extra (path to a key
+ file).
+ * - ``knownHosts``
+ - ``git_conn_id`` — a ``git`` connection with the ``known_hosts_file`` and
+ ``strict_host_key_checking`` extras.
+ * - ``depth``, ``maxFailures``, probes, ``resources``, ``env``
+ - No equivalent. There are no sidecar containers to tune: ``GitDagBundle``
+ keeps one full bare clone and fetches from it, and refresh failures are
+ retried internally.
+
+.. _git_sync_to_git_dag_bundle:auth:
+
+Authentication
+--------------
+
+``GitDagBundle`` authenticates through a standard Airflow connection of type
+``git`` (``kwargs.git_conn_id``), or needs no connection at all for public
+repositories when ``repo_url`` is given directly.
+
+For a private repository over HTTPS with a personal access token, create the
+connection from a Kubernetes secret managed by the chart:
Review Comment:
Can't it be done via Airflow Connection?
##########
chart/docs/migrate-to-git-dag-bundle.rst:
##########
@@ -0,0 +1,221 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _git_sync_to_git_dag_bundle:
+
+Migrating from Git-Sync to GitDagBundle
+=======================================
+
+This guide is for users of the Git-Sync sidecar (``dags.gitSync``) in Helm Chart 1.x.
+The Git-Sync sidecar is planned for removal in Helm Chart 2.0 in favour of the
+Airflow-native :class:`~airflow.providers.git.bundles.git.GitDagBundle`.
+
+What is changing
+----------------
+
+With Git-Sync, a ``git-sync`` container ran as a sidecar (or init container) on the
+scheduler, dag processor, worker and triggerer pods, keeping a shared DAG folder up
+to date from a git repository.
+
+With ``GitDagBundle``, syncing moves into Airflow itself. The Dag Processor clones
+the repository once into a local bare repository and refreshes it every
+``refresh_interval`` seconds. Task execution resolves DAG code from versioned
+bundles, so workers always run the code version the Dag Processor recorded. No
+sidecar containers and no shared ``ReadWriteMany`` volume are needed for syncing.
+
+Differences to be aware of before migrating:
+
+* Git-Sync synced a single repository per deployment (multiple repositories required
+ an "umbrella" repository with submodules). ``dagProcessor.dagBundleConfigList``
+ accepts multiple bundles, so each repository simply becomes its own bundle.
+* ``GitDagBundle`` supports versioning: changing a SHA-pinned ``tracking_ref`` is a configuration change and
+ only takes effect once the Dag Processor restarts and reloads its configuration.
+ Promoting to a *new* SHA can also require the bundle's local storage to be
+ cleared first (for example by letting the pod be recreated) — see
+ `GH-71388 <https://github.com/apache/airflow/issues/71388>`_.
+* ``dags.persistence`` was often enabled only to give Git-Sync a shared volume. It
+ is not needed for ``GitDagBundle`` and can be disabled if nothing else uses it.
+
+Prerequisites
+-------------
+
+* Helm Chart 1.x on Airflow 3 (DAG bundles are an Airflow 3 feature).
+* The ``apache-airflow-providers-git`` provider package must be installed in the
+ image you deploy, along with the ``git`` binary (the ``git`` binary is
+ pre-installed in the official ``apache/airflow`` images starting from Airflow
+ 3.0.2). If you build a custom slim image, add the provider to it.
+
+Value mapping
+-------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 40 60
+
+ * - Git-Sync (``dags.gitSync.*``)
+ - GitDagBundle (``dagProcessor.dagBundleConfigList[].kwargs``)
+ * - ``repo`` — the clone URL
+ - ``repo_url``. Alternatively, store the repository URL in the ``host`` field
+ of a ``git`` connection and reference it with ``git_conn_id``.
+ * - ``branch`` (git-sync v3) / ``ref`` (git-sync v4) — branch, tag or hash to
+ check out
+ - ``tracking_ref`` — accepts a branch, tag or full commit SHA.
+ * - ``rev`` (git-sync v3)
+ - ``tracking_ref``. To follow the tip of a branch, set ``tracking_ref`` to
+ the branch name.
+ * - ``subPath`` — subdirectory with DAGs
+ - ``subdir``
+ * - ``period`` — sync interval as a Go duration string (for example ``"5s"``)
+ - ``refresh_interval`` — sync interval in seconds (integer, for example
+ ``300``)
+ * - ``credentialsSecret`` (``GITSYNC_USERNAME`` / ``GITSYNC_PASSWORD``)
+ - ``git_conn_id`` — an Airflow ``git`` connection whose login/password hold
+ the username and access token. See :ref:`git_sync_to_git_dag_bundle:auth`
+ below.
+ * - ``sshKeySecret`` / ``sshKey`` (``gitSshKey``)
+ - ``git_conn_id`` — a ``git`` connection with the SSH private key in the
+ ``private_key`` extra (inline key) or ``key_file`` extra (path to a key
+ file).
+ * - ``knownHosts``
+ - ``git_conn_id`` — a ``git`` connection with the ``known_hosts_file`` and
+ ``strict_host_key_checking`` extras.
+ * - ``depth``, ``maxFailures``, probes, ``resources``, ``env``
+ - No equivalent. There are no sidecar containers to tune: ``GitDagBundle``
+ keeps one full bare clone and fetches from it, and refresh failures are
+ retried internally.
+
+.. _git_sync_to_git_dag_bundle:auth:
+
+Authentication
+--------------
+
+``GitDagBundle`` authenticates through a standard Airflow connection of type
+``git`` (``kwargs.git_conn_id``), or needs no connection at all for public
Review Comment:
It is not clear what `(``kwargs.git_conn_id``)` means.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #73082:
URL: https://github.com/apache/airflow/pull/73082#issuecomment-5653674884
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](https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:
- Pay attention to the quality of your code (ruff, mypy and type annotations). Our [prek-hooks]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-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](https://github.com/apache/airflow/blob/main/airflow-core/docs/howto/custom-operator.rst) Consider adding an example Dag that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst) 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](https://www.apache.org/foundation/policies/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]( https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#coding-style-and-best-practices).
- 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: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "developer-rpai (via GitHub)" <gi...@apache.org>.
developer-rpai commented on code in PR #73082:
URL: https://github.com/apache/airflow/pull/73082#discussion_r4012091842
##########
chart/docs/migrate-to-git-dag-bundle.rst:
##########
@@ -0,0 +1,222 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _git_sync_to_git_dag_bundle:
+
+Migrating from Git-Sync to GitDagBundle
+=======================================
+
+This guide is for users of the Git-Sync sidecar (``dags.gitSync``) in Helm Chart 1.x.
+The Git-Sync sidecar is planned for removal in Helm Chart 2.0 in favour of the
+Airflow-native :class:`~airflow.providers.git.bundles.git.GitDagBundle`.
+
+What is changing
+----------------
+
+With Git-Sync, a ``git-sync`` container ran as a sidecar (or init container) on the
+scheduler, dag processor, worker and triggerer pods, keeping a shared DAG folder up
+to date from a git repository.
+
+With ``GitDagBundle``, syncing moves into Airflow itself. The Dag Processor clones
+the repository once into a local bare repository and refreshes it every
+``refresh_interval`` seconds. Task execution resolves DAG code from versioned
+bundles, so workers always run the code version the Dag Processor recorded. No
+sidecar containers and no shared ``ReadWriteMany`` volume are needed for syncing.
+
+Differences to be aware of before migrating:
+
+* Git-Sync synced a single repository per deployment (multiple repositories required
+ an "umbrella" repository with submodules). ``dagProcessor.dagBundleConfigList``
+ accepts multiple bundles, so each repository simply becomes its own bundle.
+* Git-Sync always checked out the latest commit. ``GitDagBundle`` supports
Review Comment:
Good catch, thanks. Removed that sentence as suggested. The bullet now covers only the GitDagBundle versioning behavior.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add Git-Sync to GitDagBundle migration guide for the Helm chart [airflow]
Posted by "github-actions[bot] (via GitHub) via commits" <co...@airflow.apache.org>.
github-actions[bot] commented on PR #73082:
URL: https://github.com/apache/airflow/pull/73082#issuecomment-6613681337
### Backport successfully created: chart/v1-2x-test
Note: As of [Merging PRs targeted for Airflow 3.X](https://github.com/apache/airflow/blob/main/dev/README_AIRFLOW3_DEV.md#merging-prs-targeted-for-airflow-3x)
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.
In matter of doubt please ask in [#release-management](https://apache-airflow.slack.com/archives/C03G9H97MM2) Slack channel.
<table>
<tr>
<th>Status</th>
<th>Branch</th>
<th>Result</th>
</tr>
<tr>
<td>✅</td>
<td>chart/v1-2x-test</td>
<td><a href="https://github.com/apache/airflow/pull/76392"><img src="https://img.shields.io/badge/PR-76392-blue" alt="PR Link"></a></td>
</tr>
</table>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org