You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/05/25 15:31:01 UTC
[GitHub] [airflow] Dr-Denzy opened a new pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Dr-Denzy opened a new pull request #16059:
URL: https://github.com/apache/airflow/pull/16059
This PR aims to further improve Airflow Helm chart documentation.
It illustrates how connections, secrets, and environment variables can
be passed into Airflow using Helm chart.
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #16059:
URL: https://github.com/apache/airflow/pull/16059#discussion_r639234353
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,85 @@
+ .. 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.
+
+
+Adding Connections, Variables and Environment Variables
+=======================================================
+
+You can programmatically add Connections, Variables and arbitrary Environment Variables to your
+Airflow deployment using the Helm chart.
+
+
+Connections and Sensitive Environment Variables
+-----------------------------------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and sensitive
+environment variables into Airflow using the Helm chart. To illustrate, lets create a yaml file called ``override.yaml``
+to override values under these sections of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ # override.yaml
+
+ secret:
+ - envName: "AIRFLOW_CONN_GCP"
+ secretName: "my-airflow-connections"
+ secretKey: "AIRFLOW_CONN_GCP"
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+ extraSecrets:
+ my-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ my-secret-name: |
+ stringData: |
+ my-secret-key: my-secret
+
+
+Variables
+---------
+Airflow supports Variables which enable users to craft dynamic DAGs. You can set Variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See :doc:`/howto/variable` for more.
Review comment:
```suggestion
cli, and within your DAG file. See :doc:`apache-airflow:howto/variable` for more.
```
Should fix the spelling and link issue.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #16059:
URL: https://github.com/apache/airflow/pull/16059#discussion_r639183192
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,87 @@
+ .. 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.
+
+
+Adding Connections, Variables and Environment Variables
+=======================================================
+
+You can programmatically add Connections, Variables and arbitrary Environment Variables to your
+Airflow deployment using the Helm chart.
+
+
+Connections and Sensitive Environment Variables
+-----------------------------------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and sensitive
+environment variables into Airflow using the Helm chart. To illustrate, lets create a yaml file called ``override.yaml``
+to override values under these sections of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ # override.yaml
+
+ secret:
+ - envName: "AIRFLOW_CONN_GCP"
+ secretName: "my-airflow-connections"
+ secretKey: "AIRFLOW_CONN_GCP"
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+ extraSecrets:
+ my-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ my-secret-name: |
+ stringData: |
+ my-secret-key: my-secret
+
+
+Variables
+---------
+Airflow supports Variables which enable users to craft dynamic DAGs. You can set Variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See :doc:`/howto/variable` for more.
+
+With the Helm chart, you can also inject environment variables into Airflow. So in the example ``override.yaml`` file,
+we can override values of interest in the ``env`` section of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ env:
+ - name: "AIRFLOW_VAR_KEY"
+ value: "value_1"
+ - name: "AIRFLOW_VAR_ANOTHER_KEY"
+ value: "value_2"
+
+
+You can also utilize the ``extraEnv`` and ``extraEnvFrom`` to set more possibly "templatable" values for your airflow
+deployment.
+
+.. code-block:: yaml
+
+ extraEnv: |
+ - name: AIRFLOW_VAR_HELM_RELEASE_NAME
+ value: '{{ .Release.Name }}'
+
Review comment:
```suggestion
```
Less vertical space.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #16059:
URL: https://github.com/apache/airflow/pull/16059#discussion_r638918590
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
Review comment:
```suggestion
You can programmatically add Connections, Variables and arbitrary Environment Variables to your
Airflow deployment using the Helm chart.
```
I'd probably leave the k8s secret piece out of the mix here, personally.
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See:doc:`/howto/variable`.` for more.
+
+With Helm chart, you can also inject environment variables into airflow. For example, in a yaml file to
Review comment:
```suggestion
With the Helm chart, you can also inject environment variables into Airflow. For example, in a yaml file to
```
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
Review comment:
```suggestion
Airflow supports Variables which enable users to craft dynamic DAGs. You can set Variables in Airflow in three ways - UI,
```
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See:doc:`/howto/variable`.` for more.
Review comment:
```suggestion
commandline, and within your DAG file. See :doc:`/howto/variable` for more.
```
I think this is the right format for the link?
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
Review comment:
```suggestion
Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and sensitive environemt variables
into Airflow using the Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
```
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See:doc:`/howto/variable`.` for more.
+
+With Helm chart, you can also inject environment variables into airflow. For example, in a yaml file to
+override values of interest in the ``env`` section of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ env:
+ - name: "AIRFLOW_VAR_KEY"
+ value: "value_1"
+
+ - name: "AIRFLOW_VAR_ANOTHER_KEY"
+ value: "value_2"
+
+
+You can also utilize the ``extraEnv`` and ``extraEnvFrom`` to set more possibly "templatable" values for your airflow
+deployment.
+
+.. code-block:: yaml
+
+ extraEnv: |
+ - name: AIRFLOW__CORE__LOAD_EXAMPLES
+ value: 'True'
Review comment:
```suggestion
- name: AIRFLOW_VAR_HELM_RELEASE_NAME
value: '{{ .Release.Name }}'
```
Might as well have an example that uses templating.
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See:doc:`/howto/variable`.` for more.
+
+With Helm chart, you can also inject environment variables into airflow. For example, in a yaml file to
+override values of interest in the ``env`` section of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ env:
+ - name: "AIRFLOW_VAR_KEY"
+ value: "value_1"
+
+ - name: "AIRFLOW_VAR_ANOTHER_KEY"
+ value: "value_2"
+
+
+You can also utilize the ``extraEnv`` and ``extraEnvFrom`` to set more possibly "templatable" values for your airflow
+deployment.
Review comment:
```suggestion
You can also utilize ``extraEnv`` and ``extraEnvFrom`` if you need the name or value to be templated.
```
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
Review comment:
```suggestion
secret:
- envName: "AIRFLOW_CONN_GCP"
secretName: "my-airflow-connections"
secretKey: "AIRFLOW_CONN_GCP"
- envName: "my-env"
secretName: "my-secret-name"
secretKey: "my-secret-key"
extraSecrets:
my-airflow-connections:
data: |
AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
my-secret-name: |
stringData: |
my-secret-key: my-secret
```
Have it be a working example, and show both an env var and a connection.
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See:doc:`/howto/variable`.` for more.
+
+With Helm chart, you can also inject environment variables into airflow. For example, in a yaml file to
+override values of interest in the ``env`` section of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ env:
+ - name: "AIRFLOW_VAR_KEY"
+ value: "value_1"
+
+ - name: "AIRFLOW_VAR_ANOTHER_KEY"
+ value: "value_2"
+
+
+You can also utilize the ``extraEnv`` and ``extraEnvFrom`` to set more possibly "templatable" values for your airflow
+deployment.
+
+.. code-block:: yaml
+
+ extraEnv: |
+ - name: AIRFLOW__CORE__LOAD_EXAMPLES
+ value: 'True'
+
+
+ extraEnvFrom: |
+ - secretRef:
+ name: '{{ .Release.Name }}-airflow-connections'
+ - configMapRef:
+ name: '{{ .Release.Name }}-airflow-variables'
Review comment:
```suggestion
extraEnvFrom: |
- configMapRef:
name: '{{ .Release.Name }}-airflow-variables'
extraConfigMaps:
'{{ .Release.Name }}-airflow-variables':
data: |
AIRFLOW_VAR_HELLO_MESSAGE: "Hi!"
```
Might as well be a complete working example.
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
Review comment:
```suggestion
Connections and Sensitive Environment Variables
```
Maybe?
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
Review comment:
```suggestion
Adding Connections, Variables and Environment Variables
```
I wouldn't consider `Secrets` to be core concept 🤷♂️
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See:doc:`/howto/variable`.` for more.
+
+With Helm chart, you can also inject environment variables into airflow. For example, in a yaml file to
+override values of interest in the ``env`` section of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ env:
+ - name: "AIRFLOW_VAR_KEY"
+ value: "value_1"
+
Review comment:
```suggestion
```
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil merged pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Posted by GitBox <gi...@apache.org>.
kaxil merged pull request #16059:
URL: https://github.com/apache/airflow/pull/16059
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #16059:
URL: https://github.com/apache/airflow/pull/16059#issuecomment-848267311
The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jedcunningham commented on a change in pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on a change in pull request #16059:
URL: https://github.com/apache/airflow/pull/16059#discussion_r639184064
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
+
+You can programmatically add Connections, Secrets and Environment Variables to your
+airflow deployment using Helm chart.
+
+
+Connections and Secrets
+-----------------------
+Under the ``secret`` and ``extraSecret`` sections of the ``values.yaml`` you can pass connection strings and secrets
+into Airflow using Helm chart. To illustrate, lets create a yaml file to override values under these sections of the
+``values.yaml`` file.
+
+.. code-block:: yaml
+
+ secret:
+ - envName: "my-env"
+ secretName: "my-secret-name"
+ secretKey: "my-secret-key"
+
+
+ extraSecrets:
+ {{ .Release.Name }}-airflow-connections:
+ data: |
+ AIRFLOW_CONN_GCP: 'base64_encoded_gcp_conn_string'
+ AIRFLOW_CONN_AWS: 'base64_encoded_aws_conn_string'
+ stringData: |
+ AIRFLOW_CONN_OTHER: 'other_conn'
+ {{ .Release.Name }}-other-secret-name-suffix: |
+ data: |
+
+
+Variables
+---------
+Airflow supports Variables which enable users craft dynamic DAGs. You can set variables in Airflow in three ways - UI,
+commandline, and within your DAG file. See:doc:`/howto/variable`.` for more.
+
+With Helm chart, you can also inject environment variables into airflow. For example, in a yaml file to
+override values of interest in the ``env`` section of the ``values.yaml`` file.
+
+.. code-block:: yaml
+
+ env:
+ - name: "AIRFLOW_VAR_KEY"
+ value: "value_1"
+
+ - name: "AIRFLOW_VAR_ANOTHER_KEY"
+ value: "value_2"
+
+
+You can also utilize the ``extraEnv`` and ``extraEnvFrom`` to set more possibly "templatable" values for your airflow
+deployment.
Review comment:
Bump, was this accidentally missed?
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #16059: Add Connections, Secrets and Variables to Airflow Helm Chart documentation
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #16059:
URL: https://github.com/apache/airflow/pull/16059#discussion_r638923941
##########
File path: docs/helm-chart/adding-connections-and-variables.rst
##########
@@ -0,0 +1,83 @@
+ .. 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.
+
+
+Adding Connections, Secrets and Environment Variables
+==================================================
Review comment:
```suggestion
Adding Connections, Secrets and Environment Variables
=====================================================
```
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org