Helm Chart: Add gitConfig option for gitSync and upgrade NOTES.txt for Airflow v3 #50418
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
gitConfig
Option to Airflow Helm Chart for Custom Git ConfigurationThis pull request introduces the following changes:
gitConfig
Parameter:gitConfig
, to the Apache Airflow Helm chart. This allows users to specify custom Git configuration settings for thegit-sync
sidecar container, offering more flexibility in managing Git behavior during DAG synchronization.Airflow API Server Update:
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:
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.🧪 Testing and Validation
gitConfig
are correctly applied within thegit-sync
container.gitConfig
does not interfere with existinggit-sync
functionality or other Helm chart configurations..apiServer
setting is correctly used in Airflow v3 and does not affect backward compatibility with Airflow v2.📚 Documentation
gitConfig
parameter, with examples demonstrating its usage.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, thegit-sync
container will operate with its default Git configuration..web
to.apiServer
innotes.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 for more information.
In case of fundamental code changes, an 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 a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in airflow-core/newsfragments.