[airflow] 01/05: Add a note in set-config.rst on using Secrets Backend (#15274)

[ka...@apache.org]

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

kaxilnaik pushed a commit to branch v2-0-test
in repository https://gitbox.apache.org/repos/asf/airflow.git

commit 1dacb83b5d63bfe4e0963a565c2a7a619523efb1
Author: Lauri Koobas <la...@users.noreply.github.com>
AuthorDate: Thu Apr 8 16:25:49 2021 +0300

    Add a note in set-config.rst on using Secrets Backend (#15274)
    
    Clarifying documentation that when using configuration options that are connections (sql_alchemy_conn for example) then they should still be defined as config options in secrets backend and not connection options.
    
    (cherry picked from commit 1e1f9afa99aace2fc692cffde1e71bd6d9873f24)
---
 docs/apache-airflow/howto/set-config.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/apache-airflow/howto/set-config.rst b/docs/apache-airflow/howto/set-config.rst
index f1aac87..d36a96f 100644
--- a/docs/apache-airflow/howto/set-config.rst
+++ b/docs/apache-airflow/howto/set-config.rst
@@ -85,6 +85,9 @@ For example:
 
     export AIRFLOW__CORE__SQL_ALCHEMY_CONN_SECRET=sql_alchemy_conn
 
+.. note::
+    The config options must follow the config prefix naming convention defined within the secrets backend. This means that ``sql_alchemy_conn`` is not defined with a connection prefix, but with config prefix. For example it should be named as ``airflow/config/sql_alchemy_conn``
+
 The idea behind this is to not store passwords on boxes in plain text files.
 
 The universal order of precedence for all configuration options is as follows: