You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/12/18 16:47:51 UTC
[GitHub] [airflow] AmarEL opened a new pull request #13155: Add documentation about webserver_config.py
AmarEL opened a new pull request #13155:
URL: https://github.com/apache/airflow/pull/13155
A quick reference about how to configure other authentication methods
closes: #12827
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] mik-laj merged pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
mik-laj merged pull request #13155:
URL: https://github.com/apache/airflow/pull/13155
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #13155:
URL: https://github.com/apache/airflow/pull/13155#issuecomment-748199050
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/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) 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](https://github.com/apache/airflow/blob/master/docs/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) 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](https://www.apache.org/foundation/policies/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]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
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
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] mik-laj commented on a change in pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #13155:
URL: https://github.com/apache/airflow/pull/13155#discussion_r546257365
##########
File path: docs/apache-airflow/security/webserver.rst
##########
@@ -85,9 +85,41 @@ Please use command line interface ``airflow users create`` to create accounts, o
Other Methods
'''''''''''''
-Standing on the shoulder of underlying framework Flask-AppBuilder, Airflow also supports authentication methods like
-OAuth, OpenID, LDAP, REMOTE_USER. You can configure in ``$AIRFLOW_HOME/webserver_config.py``.
-For details, please refer to
+Since the Airflow 2.0, the default UI is the Flask App Builder RBAC. A ``webserver_config.py`` configuration file
+it's automatically generated and can be used to configure the Airflow to support authentication
+methods like OAuth, OpenID, LDAP, REMOTE_USER.
+
+For previous versions from Airflow, the ``$AIRFLOW_HOME/airflow.cfg`` following entry needs to be set to enable
+the Flask App Builder RBAC UI.
+
+.. code-block:: ini
+
+ rbac = True
+
+The default authentication option is the AUTH_DB, and a new user can be created through a CLI command or by the
+UI modifying the ``$AIRFLOW_HOME/webserver_config.py`` with the following options:
Review comment:
I have the impression that this sentence is not completely correct. Why should the user edit this file? To add a new user?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13155:
URL: https://github.com/apache/airflow/pull/13155#issuecomment-748226561
[The Workflow run](https://github.com/apache/airflow/actions/runs/431017972) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] AmarEL commented on a change in pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
AmarEL commented on a change in pull request #13155:
URL: https://github.com/apache/airflow/pull/13155#discussion_r546259423
##########
File path: docs/apache-airflow/security/webserver.rst
##########
@@ -85,9 +85,41 @@ Please use command line interface ``airflow users create`` to create accounts, o
Other Methods
'''''''''''''
-Standing on the shoulder of underlying framework Flask-AppBuilder, Airflow also supports authentication methods like
-OAuth, OpenID, LDAP, REMOTE_USER. You can configure in ``$AIRFLOW_HOME/webserver_config.py``.
-For details, please refer to
+Since the Airflow 2.0, the default UI is the Flask App Builder RBAC. A ``webserver_config.py`` configuration file
+it's automatically generated and can be used to configure the Airflow to support authentication
+methods like OAuth, OpenID, LDAP, REMOTE_USER.
+
+For previous versions from Airflow, the ``$AIRFLOW_HOME/airflow.cfg`` following entry needs to be set to enable
+the Flask App Builder RBAC UI.
+
+.. code-block:: ini
+
+ rbac = True
+
+The default authentication option is the AUTH_DB, and a new user can be created through a CLI command or by the
+UI modifying the ``$AIRFLOW_HOME/webserver_config.py`` with the following options:
Review comment:
Edit this file as the code example I wrote will allow user self registration.
I will edit this section to make it clear
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13155:
URL: https://github.com/apache/airflow/pull/13155#issuecomment-748548710
The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest master at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13155:
URL: https://github.com/apache/airflow/pull/13155#issuecomment-748506238
[The Workflow run](https://github.com/apache/airflow/actions/runs/432754088) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #13155: Add documentation about webserver_config.py
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #13155:
URL: https://github.com/apache/airflow/pull/13155#issuecomment-748548749
Awesome work, congrats on your first merged pull request!
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org