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

fix(standalone): remove hardcoded webserver-port #20429

Merged
merged 3 commits into from Dec 21, 2021
Merged

fix(standalone): remove hardcoded webserver-port #20429

merged 3 commits into from Dec 21, 2021

Conversation

boredland
Copy link
Contributor

@boredland boredland commented Dec 20, 2021

Port 8080 is the default port for webserver (https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html?highlight=webserver#webserver). By setting it here again explicitly, we forbid users to override it using AIRFLOW__WEBSERVER__WEB_SERVER_PORT. Removing it IMO is not a breaking change, since it will still default to 8080.

I tested locally if it still spins up the web server at port 8080. It did.

TODO:

  • add to docs how to override port

Port 8080 is the default port for webserver (https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html?highlight=webserver#webserver). By setting it here again explicitly, we forbid users to override it using AIRFLOW__WEBSERVER__WEB_SERVER_PORT. Removing it IMO is not a breaking change, since it will still default to 8080.
@boring-cyborg
Copy link

boring-cyborg bot commented Dec 20, 2021

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 Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, mypy and type annotations). Our pre-commits 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 Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment 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 for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    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

@boredland boredland marked this pull request as draft December 20, 2021 17:38
@boredland boredland marked this pull request as ready for review December 20, 2021 18:35
@boredland
Copy link
Contributor Author

boredland commented Dec 20, 2021

add to docs how to override port

as we spoke about what I as a user would have expected: I found the configuration variables page and expected them to "just work". So from my perspective a hint to that page is even more than enough. Let me know if you'd like me to add more.

For people stumbling upon this as long as it isn't merged/released and like me are using standalone in a docker context, you can extend from the image and apply this tiny patch:

FROM apache/airflow:2.2.2-python3.9

## All airflow.cfg options can be set via environment variables
## See: https://airflow.apache.org/docs/apache-airflow/stable/configurations-ref.html
ENV AIRFLOW__WEBSERVER__WEB_SERVER_PORT=${PORT:-5000}

COPY app.json ./

# TODO: remove when https://github.com/apache/airflow/pull/20429 is merged and released
RUN sed -i -e 's/, "--port", "8080"//g' /home/airflow/.local/lib/python3.9/site-packages/airflow/cli/commands/standalone_command.py

CMD ["airflow", "standalone"]

@github-actions
Copy link

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Dec 20, 2021
@kaxil kaxil merged commit 9d36b1f into apache:main Dec 21, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Dec 21, 2021

Awesome work, congrats on your first merged pull request!

@jedcunningham jedcunningham added this to the Airflow 2.2.4 milestone Dec 21, 2021
@jedcunningham jedcunningham added the type:bug-fix Changelog: Bug Fixes label Dec 21, 2021
jedcunningham pushed a commit that referenced this pull request Jan 21, 2022
Port 8080 is the default port for webserver (https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html?highlight=webserver#webserver). By setting it here again explicitly, we forbid users to override it using AIRFLOW__WEBSERVER__WEB_SERVER_PORT. Removing it IMO is not a breaking change, since it will still default to 8080.

(cherry picked from commit 9d36b1f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:CLI okay to merge It's ok to merge this PR as it does not require more tests type:bug-fix Changelog: Bug Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants