Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up API server config and cli args #47083

Merged
merged 2 commits into from
Feb 27, 2025

Conversation

jedcunningham
Copy link
Member

@jedcunningham jedcunningham commented Feb 25, 2025

This included renaming the following args to better match
fastapi/uvicorn:

  • --hostname -> --host
  • --debug -> --dev

The following config options were removed (there isn't an equivalent
currently):

  • [webserver] error_logfile
  • [webserver] access_logformat

The following config options were moved/renamed to the api section.

  • [webserver] web_server_host has been moved to [api] host
  • [webserver] web_server_port has been moved to [api] port
  • [webserver] workers has been moved to [api] workers
  • [webserver] web_server_worker_timeout has been moved to [api] worker_timeout
  • [webserver] web_server_ssl_cert has been moved to [api] ssl_cert
  • [webserver] web_server_ssl_key has been moved to [api] ssl_key
  • [webserver] access_logfile has been moved to [api] access_logfile

@jedcunningham jedcunningham added the full tests needed We need to run full set of tests for this PR to merge label Feb 25, 2025
@boring-cyborg boring-cyborg bot added area:API Airflow's REST/HTTP API area:CLI area:dev-tools area:helm-chart Airflow Helm Chart area:webserver Webserver related Issues kind:documentation provider:amazon AWS/Amazon - related issues provider:fab labels Feb 25, 2025
This included renaming the following args to better match
fastapi/uvicorn:
  - `--hostname` -> `--host`
  - `--debug` -> `--dev`

The following config options were removed (there isn't an equivalent
currently):
  - `[webserver] error_logfile`
  - `[webserver] access_logformat`

The following config options were moved/renamed to the `api` section.
  - `[webserver] web_server_host` has been moved to `[api] host`
  - `[webserver] web_server_port` has been moved to `[api] port`
  - `[webserver] workers` has been moved to `[api] workers`
  - `[webserver] web_server_worker_timeout` has been moved to `[api] worker_timeout`
  - `[webserver] web_server_ssl_cert` has been moved to `[api] ssl_cert`
  - `[webserver] web_server_ssl_key` has been moved to `[api] ssl_key`
  - `[webserver] access_logfile` has been moved to `[api] access_logfile`
@jedcunningham jedcunningham changed the title Remove the webserver command and point people at the new api-server Clean up API server config and cli args Feb 27, 2025
Copy link
Member

@ashb ashb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a mechanism in airflow/config.py to tel users about the use of deprecated config options. Did you purposefully not use them here cos 2.x to 3.x?

@jedcunningham
Copy link
Member Author

Hmm, it wasn't a conscious choice, I didn't think to do it. In fact, I think there are some others I should go do retroactively too...

@jedcunningham
Copy link
Member Author

Good call. Pushed.

@jedcunningham jedcunningham requested a review from ashb February 27, 2025 15:48
@jedcunningham jedcunningham merged commit f016470 into apache:main Feb 27, 2025
89 checks passed
@jedcunningham jedcunningham deleted the break_webserver branch February 27, 2025 16:39
Sharashchandra pushed a commit to Sharashchandra/airflow that referenced this pull request Feb 28, 2025
This included renaming the following args to better match
fastapi/uvicorn:
  - `--hostname` -> `--host`
  - `--debug` -> `--dev`

The following config options were removed (there isn't an equivalent
currently):
  - `[webserver] error_logfile`
  - `[webserver] access_logformat`

The following config options were moved/renamed to the `api` section.
  - `[webserver] web_server_host` has been moved to `[api] host`
  - `[webserver] web_server_port` has been moved to `[api] port`
  - `[webserver] workers` has been moved to `[api] workers`
  - `[webserver] web_server_worker_timeout` has been moved to `[api] worker_timeout`
  - `[webserver] web_server_ssl_cert` has been moved to `[api] ssl_cert`
  - `[webserver] web_server_ssl_key` has been moved to `[api] ssl_key`
  - `[webserver] access_logfile` has been moved to `[api] access_logfile`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:API Airflow's REST/HTTP API area:CLI area:dev-tools area:helm-chart Airflow Helm Chart area:webserver Webserver related Issues full tests needed We need to run full set of tests for this PR to merge kind:documentation provider:amazon AWS/Amazon - related issues provider:fab
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants