recordsansible/ara
Code Issues Proposed changes

Add docs for external_auth configuration

Browse Source 
Related: https://github.com/ansible-community/ara/issues/124

Change-Id: Ibad626c45b83a0333875d7e743ca090fcb1ea6fe
This commit is contained in:
Michal Arbet 2020-08-17 16:15:19 +02:00
parent 52a85e808a
commit ddaed97ad1
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/api-configuration.rst
View File

@ -54,6 +54,8 @@ For more details, click on the configuration parameters.
+----------------------------------+--------------------------------------------------------+------------------------------------------------------------+
| ARA_ENV_ | ``default`` | Environment to load configuration for |
+----------------------------------+--------------------------------------------------------+------------------------------------------------------------+
| ARA_EXTERNAL_AUTH_ | ``False`` | Whether or not to enable external authentication |
+----------------------------------+--------------------------------------------------------+------------------------------------------------------------+
| ARA_LOGGING_ | See ARA_LOGGING_ | Logging configuration |
+----------------------------------+--------------------------------------------------------+------------------------------------------------------------+
| ARA_LOG_LEVEL_ | ``INFO`` | Log level of the different components |
@ -418,6 +420,17 @@ or ``prod.yaml`` instead.
This lets users override only the parameters they are interested in for
specific environments.
ARA_EXTERNAL_AUTH
~~~~~~~~~~~~~~~~~
- **Environment variable**: ``ARA_EXTERNAL_AUTH``
- **Configuration file variable**: ``EXTERNAL_AUTH``
- **Type**: ``bool``
- **Default**: ``False``
- **Provided by**: django-rest-framework `authentication <https://www.django-rest-framework.org/api-guide/authentication/>`_
Whether or not to enable external authentication.
ARA_LOGGING
~~~~~~~~~~~

10
doc/source/api-security.rst
View File

@ -93,6 +93,16 @@ This is done with the two following configuration options:
These settings are global and are effective for all API endpoints.
Enabling external authentication
------------------------------------------------
Once you you have enabled authentication against the API, you can enable external
authentication. This is usefull especially in production environments.
This is done with the following configuration option:
- :ref:`api-configuration:ARA_EXTERNAL_AUTH` for external authentication
Setting up authentication for the Ansible plugins
-------------------------------------------------