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/05 06:01:29 UTC
[airflow] branch master updated: Updating documentation to specify
sensitive config options (#12820)
This is an automated email from the ASF dual-hosted git repository.
kamilbregula 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 c85f494 Updating documentation to specify sensitive config options (#12820)
c85f494 is described below
commit c85f49454de63f5857bf477a240229a71f0e78ff
Author: Sam Wheating <sa...@shopify.com>
AuthorDate: Sat Dec 5 01:00:18 2020 -0500
Updating documentation to specify sensitive config options (#12820)
---
airflow/config_templates/config.yml | 8 ++++++++
docs/apache-airflow/configurations-ref.rst | 9 +++++++++
2 files changed, 17 insertions(+)
diff --git a/airflow/config_templates/config.yml b/airflow/config_templates/config.yml
index a70ddec..8e6ff97 100644
--- a/airflow/config_templates/config.yml
+++ b/airflow/config_templates/config.yml
@@ -67,6 +67,7 @@
their website
version_added: ~
type: string
+ sensitive: true
example: ~
default: "sqlite:///{AIRFLOW_HOME}/airflow.db"
- name: sql_engine_encoding
@@ -225,6 +226,7 @@
Secret key to save connection passwords in the db
version_added: ~
type: string
+ sensitive: true
example: ~
default: "{FERNET_KEY}"
- name: donot_pickle
@@ -770,6 +772,7 @@
description: ~
version_added: ~
type: string
+ sensitive: true
example: ~
default: ""
- name: operators
@@ -929,6 +932,7 @@
It should be as random as possible
version_added: ~
type: string
+ sensitive: true
example: ~
default: "{SECRET_KEY}"
- name: workers
@@ -1241,6 +1245,7 @@
description: ~
version_added: ~
type: string
+ sensitive: true
example: "airflow"
default: ~
- name: smtp_port
@@ -1374,6 +1379,7 @@
a sqlalchemy database. Refer to the Celery documentation for more information.
version_added: ~
type: string
+ sensitive: true
example: ~
default: "redis://redis:6379/0"
- name: result_backend
@@ -1386,6 +1392,7 @@
http://docs.celeryproject.org/en/latest/userguide/configuration.html#task-result-backend-settings
version_added: ~
type: string
+ sensitive: true
example: ~
default: "db+postgresql://postgres:airflow@postgres/airflow"
- name: flower_host
@@ -1416,6 +1423,7 @@
Accepts user:password pairs separated by a comma
version_added: 1.10.2
type: string
+ sensitive: true
example: "user1:password1,user2:password2"
default: ""
- name: default_queue
diff --git a/docs/apache-airflow/configurations-ref.rst b/docs/apache-airflow/configurations-ref.rst
index abdae2d..c92a205 100644
--- a/docs/apache-airflow/configurations-ref.rst
+++ b/docs/apache-airflow/configurations-ref.rst
@@ -63,7 +63,16 @@ can set in ``airflow.cfg`` file or using environment variables.
:Type: {{ option["type"] }}
:Default: ``{{ "''" if option["default"] == "" else option["default"] }}``
+ {% if option.get("sensitive") %}
+ :Environment Variables:
+ ``AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }}``
+
+ ``AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }}_CMD``
+
+ ``AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }}_SECRET``
+ {% else %}
:Environment Variable: ``AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }}``
+ {% endif %}
{% if option["example"] %}
:Example:
``{{ option["example"] }}``