mvfc opened a new pull request, #50418:
URL: https://github.com/apache/airflow/pull/50418
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
### Add `gitConfig` Option to Airflow Helm Chart for Custom Git Configuration
This pull request introduces the following changes:
1. **`gitConfig` Parameter**:
- Added a new parameter, `gitConfig`, to the Apache Airflow Helm chart.
This allows users to specify custom Git configuration settings for the
`git-sync` sidecar container, offering more flexibility in managing Git
behavior during DAG synchronization.
2. **Airflow API Server Update**:
- Updated the `NOTES.txt` to reflect the usage of `.apiServer` instead of
`.web` for Airflow v3 deployments, aligning with the updated configuration
style for Airflow v3 and improving compatibility with newer versions of the
platform.
#### ๐ง Changes Introduced
- **New Configuration Field**:
- `dags.gitSync.gitConfig`: Accepts a list of Git configuration entries,
enabling users to set custom Git configurations such as user identity,
credential helpers, and other Git settings.
- **Airflow Web to API Server Update**:
- Modified `NOTES.txt` to replace `.web` with `.apiServer`, which is the
correct configuration for Airflow v3, ensuring the Helm chart is aligned with
the latest Airflow version.
This addition aligns with the existing `git-sync` capabilities and allows
for more tailored Git interactions within Airflow deployments. This also
enables git-sync to be used with Azure DevOps repos since that one needs
hardcoded organization name on the URL to work, and it conflicts when you pass
the credentials username and password saying the username is already coded in
the URL.
To use Azure DevOps as a source now simply pass the organization as username
and PAT as password, and remove the organization from the URL, then add to your
dags.gitsync:
dags:
gitSync:
credentialsSecret: airflow-git-creds
gitConfig:
- name: credential.useHttpPath
value: "true"
#### ๐งช Testing and Validation
- Verified that custom Git configurations specified via `gitConfig` are
correctly applied within the `git-sync` container.
- Ensured that the addition of `gitConfig` does not interfere with existing
`git-sync` functionality or other Helm chart configurations.
- Confirmed that the `.apiServer` setting is correctly used in Airflow v3
and does not affect backward compatibility with Airflow v2.
#### ๐ Documentation
- Updated the Helm chart documentation to include the new `gitConfig`
parameter, with examples demonstrating its usage.
- Adjusted `NOTES.txt` to reflect the `.apiServer` setting for Airflow v3
deployments, ensuring correct configuration for Airflow v3 clusters.
#### ๐ Backward Compatibility
This change is backward compatible. If `gitConfig` is not specified, the
`git-sync` container will operate with its default Git configuration.
- The change from `.web` to `.apiServer` in `notes.txt` is only relevant for
Airflow v3 deployments and does not affect Airflow v2.
#### ๐ Related Issues
This enhancement addresses the need for more customizable Git configurations
within the Airflow Helm chart's `git-sync` setup so it is possible to use all
git providers, including Azure DevOps Repos.
---
By introducing the `gitConfig` parameter, this update provides users with
enhanced control over Git behavior in their Airflow deployments, facilitating
more complex and customized workflows.
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
