You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ka...@apache.org on 2020/12/04 00:59:25 UTC

[airflow] branch master updated: Add documentation on AIRFLOW__{SECTION}__{KEY}_SECRET config (#12797)

This is an automated email from the ASF dual-hosted git repository.

kaxilnaik pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/master by this push:
     new 292118e  Add documentation on AIRFLOW__{SECTION}__{KEY}_SECRET config (#12797)
292118e is described below

commit 292118e33971dfd68cb32a404a85c0d46d225b40
Author: Sam Wheating <sa...@shopify.com>
AuthorDate: Thu Dec 3 19:58:17 2020 -0500

    Add documentation on AIRFLOW__{SECTION}__{KEY}_SECRET config (#12797)
    
    closes #12774
---
 CONTRIBUTING.rst                                  |  4 ++--
 docs/apache-airflow/cli-and-env-variables-ref.rst | 21 +++++++++++++++++++++
 2 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 2c7cbc1..5bddad0 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -719,9 +719,9 @@ jobs for each python version.
 Documentation
 =============
 
-Documentation for ``apache-airflow`` package and other packages that are closely related to it ie. providers packages are in ``/docs/`` directory. For detailed information on documentation development, see: `docs/README.md <docs/README.md>`_
+Documentation for ``apache-airflow`` package and other packages that are closely related to it ie. providers packages are in ``/docs/`` directory. For detailed information on documentation development, see: `docs/README.rst <docs/README.rst>`_
 
-For Helm Chart documentation, see: `/chart/README.md <../chart/READMe.md>`__
+For Helm Chart documentation, see: `/chart/README.md <../chart/README.md>`__
 
 Static code checks
 ==================
diff --git a/docs/apache-airflow/cli-and-env-variables-ref.rst b/docs/apache-airflow/cli-and-env-variables-ref.rst
index bdc51e4..7ecd562 100644
--- a/docs/apache-airflow/cli-and-env-variables-ref.rst
+++ b/docs/apache-airflow/cli-and-env-variables-ref.rst
@@ -59,6 +59,27 @@ Environment Variables
   For any specific key in a section in Airflow, execute the command the key is pointing to.
   The result of the command is used as a value of the ``AIRFLOW__{SECTION}__{KEY}`` environment variable.
 
+  This is only supported by the following config options:
+
+* ``sql_alchemy_conn`` in ``[core]`` section
+* ``fernet_key`` in ``[core]`` section
+* ``broker_url`` in ``[celery]`` section
+* ``flower_basic_auth`` in ``[celery]`` section
+* ``result_backend`` in ``[celery]`` section
+* ``password`` in ``[atlas]`` section
+* ``smtp_password`` in ``[smtp]`` section
+* ``git_password`` in ``[kubernetes]`` section
+* ``secret_key`` in ``[webserver]`` section
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}_SECRET
+
+  For any specific key in a section in Airflow, retrieve the secret from the configured secrets backend.
+  The returned value will be used as the value of the ``AIRFLOW__{SECTION}__{KEY}`` environment variable.
+
+  See :ref:`Secrets Backends<secrets_backend_configuration>` for more information on available secrets backends.
+
+  This form of environment variable configuration is only supported for the same subset of config options as ``AIRFLOW__{SECTION}__{KEY}_CMD``
+
 .. envvar:: AIRFLOW_CONFIG
 
   The path to the Airflow configuration file.