sunank200 opened a new pull request, #48403:
URL: https://github.com/apache/airflow/pull/48403
<!--
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.
-->
This PR introduces the `airflow config update` ALI command to help users
transition smoothly from Airflow 2.x to 3. This command scans the current
`airflow.cfg` file and env variables, then updates configuration parameters
that have been removed, renamed, or had their default values changed. In
addition, it cleans out deprecated configuration values (as updated in
[[#47761](https://github.com/apache/airflow/pull/47761/files)](https://github.com/apache/airflow/pull/47761/files))
that have been emitting warnings in Airflow 2.x.
This command also creates the backup of old `airflow.cfg` file if configs
have to be updated.
**Examples of `airflow config update` scenarios:**
- **Renamed Options:**
A legacy key defined in the `[admin]` section, for example:
```ini
hide_sensitive_variable_fields = True
```
is automatically moved and renamed to:
```ini
hide_sensitive_var_conn_fields = True
```
in the `[core]` section.
- **Removed Options:**
Deprecated options such as:
```ini
check_slas = True
```
in the `[core]` section are removed from the configuration file.
- **Default Value Changes:**
If a configuration (e.g. `catchup_by_default` in `[scheduler]`) was set to
“True” in Airflow 2.x, it will be updated to the new default “False” in Airflow
3.0:
```ini
catchup_by_default = False
```
**Usage Examples:**
- **Update the Entire Configuration:**
```bash
airflow config update
```
- **Update Specific Sections:**
```bash
airflow config update --section core,database
```
- **Update Specific Options:**
```bash
airflow config update --option sql_alchemy_conn,catchup_by_default
```
- **Ignore Specific Sections/Options:**
```bash
airflow config update --ignore-section webserver --ignore-option check_slas
```
- **Verbose Mode for Detailed Output:**
```bash
airflow config update --verbose
```
<!--
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/
-->
I have tested it locally using breeze shell and following are screenshots
- Default value changed:
Before:
<img width="1027" alt="Screenshot 2025-03-26 at 7 47 45 PM"
src="https://github.com/user-attachments/assets/bcdab5e0-4b15-483e-bf67-1cc49e0502e3";
/>
After:
<img width="809" alt="Screenshot 2025-03-26 at 8 02 20 PM"
src="https://github.com/user-attachments/assets/bd5cd26b-89fd-4a0e-a42f-10a9b3625adf";
/>
- Removed and renamed
Before:
<img width="813" alt="Screenshot 2025-03-26 at 7 48 21 PM"
src="https://github.com/user-attachments/assets/55013746-9e70-4044-a1e7-f132a3ed2fab";
/>
After:
<img width="816" alt="Screenshot 2025-03-26 at 7 54 45 PM"
src="https://github.com/user-attachments/assets/46eb29d9-65f9-453f-a7a0-3c249eafabce";
/>
closes: [#48376](https://github.com/apache/airflow/issues/48376)
<!-- Please keep an empty line above the dashes. -->
---
**^ 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]
