vincbeck commented on code in PR #36211: URL: https://github.com/apache/airflow/pull/36211#discussion_r1425786315
########## docs/apache-airflow/core-concepts/auth-manager.rst: ########## @@ -0,0 +1,174 @@ + .. 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. + +Auth manager +============ + +Auth manager is the component in Airflow to handle user authentication and user authorization. They have a common +API and are "pluggable", meaning you can swap auth managers based on your installation needs. + +Airflow can only have one auth manager configured at a time; this is set by the ``auth_manager`` option in the +``[core]`` section of :doc:`the configuration file </howto/set-config>`. + +.. note:: + For more information on Airflow's configuration, see :doc:`/howto/set-config`. + +If you want to check which auth manager is currently set, you can use the +``airflow config get-value core auth_manager`` command: + +.. code-block:: bash + + $ airflow config get-value core auth_manager + airflow.providers.fab.auth_manager.fab_auth_manager.FabAuthManager + + +Why different auth managers? +---------------------------- + +Airflow is used by a lot of different users with a lot of different configurations. Some Airflow environment might be +used by only one user and some might be used by thousand of users. An Airflow environment with only one (or very few) +users does not need the same user management as an environment used by thousand of them. + +This is why the whole user management (user authentication and user authorization) is packaged in one component +called auth manager. So that it is easy to plug-and-play an auth manager that suits your specific needs. + +By default, Airflow comes with the :doc:`apache-airflow-providers-fab:auth-manager`. + +.. note:: + Switching to a different auth manager is a heavy operation and should be considered as such. It will + impact users of the environment. The sign-in and sign-off experience will very likely change and disturb them if + they are not advised. Plus, all current users and permissions will have to be copied over from the previous auth + manager to the next. + +Writing Your Own Executor Review Comment: I like it better non all caps, having all words capitalized look weird to me. But I guess this is just personal opinion -- 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: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
