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 2be7f90 Update Helm Chart docs for 1.0.0 release (#15957)
2be7f90 is described below
commit 2be7f90a115cf4bed814ae5794be6f0aa579b1b3
Author: Kaxil Naik <[email protected]>
AuthorDate: Thu May 20 01:46:06 2021 +0100
Update Helm Chart docs for 1.0.0 release (#15957)
Updates repo name and chart name and some minor errors
---
docs/helm-chart/index.rst | 8 ++++----
docs/helm-chart/keda.rst | 4 ++--
docs/helm-chart/manage-dags-files.rst | 16 ++++++++--------
docs/helm-chart/manage-logs.rst | 10 +++++-----
docs/helm-chart/parameters-ref.rst | 2 +-
docs/helm-chart/quick-start.rst | 7 +++----
6 files changed, 23 insertions(+), 24 deletions(-)
diff --git a/docs/helm-chart/index.rst b/docs/helm-chart/index.rst
index 6b809fc..b3347a0 100644
--- a/docs/helm-chart/index.rst
+++ b/docs/helm-chart/index.rst
@@ -72,13 +72,13 @@ Features
Installing the Chart
--------------------
-To install this repository from source (using helm 3)
+To install this chart using helm 3, run the following commands:
.. code-block:: bash
kubectl create namespace airflow
- helm dep update
- helm install airflow . --namespace airflow
+ helm repo add apache-airflow https://airflow.apache.org
+ helm install airflow apache-airflow/airflow --namespace airflow
The command deploys Airflow on the Kubernetes cluster in the default
configuration. The :doc:`parameters-ref`
section lists the parameters that can be configured during installation.
@@ -93,7 +93,7 @@ To upgrade the chart with the release name ``airflow``:
.. code-block:: bash
- helm upgrade airflow . --namespace airflow
+ helm upgrade airflow apache-airflow/airflow --namespace airflow
Uninstalling the Chart
----------------------
diff --git a/docs/helm-chart/keda.rst b/docs/helm-chart/keda.rst
index 92f4afc..9d2e0e1 100644
--- a/docs/helm-chart/keda.rst
+++ b/docs/helm-chart/keda.rst
@@ -45,8 +45,8 @@ helm command or in the ``values.yaml``.
.. code-block:: bash
kubectl create namespace airflow
-
- helm install airflow . \
+ helm repo add apache-airflow https://airflow.apache.org
+ helm install airflow apache-airflow/airflow \
--namespace airflow \
--set executor=CeleryExecutor \
--set workers.keda.enabled=true \
diff --git a/docs/helm-chart/manage-dags-files.rst
b/docs/helm-chart/manage-dags-files.rst
index b2d0da0..d389d91 100644
--- a/docs/helm-chart/manage-dags-files.rst
+++ b/docs/helm-chart/manage-dags-files.rst
@@ -65,7 +65,7 @@ Finally, update the Airflow pods with that image:
.. code-block:: bash
- helm upgrade --install airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set images.airflow.repository=my-company/airflow \
--set images.airflow.tag=8a0da78
@@ -73,7 +73,7 @@ If you are deploying an image with a constant tag, you need
to make sure that th
.. code-block:: bash
- helm upgrade --install airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set images.airflow.repository=my-company/airflow \
--set images.airflow.tag=8a0da78 \
--set images.airflow.pullPolicy=Always
@@ -90,7 +90,7 @@ for details.
.. code-block:: bash
- helm upgrade --install airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set dags.persistence.enabled=true \
--set dags.gitSync.enabled=true
# you can also override the other persistence or gitSync values
@@ -99,7 +99,7 @@ for details.
.. code-block:: bash
- helm upgrade --install airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set dags.persistence.enabled=true \
--set dags.gitSync.enabled=true \
# you can also override the other persistence or gitSync values
@@ -116,7 +116,7 @@ seconds. If you are using the ``KubernetesExecutor``,
Git-sync will run as an in
.. code-block:: bash
- helm upgrade --install airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set dags.persistence.enabled=false \
--set dags.gitSync.enabled=true
# you can also override the other gitSync values
@@ -133,7 +133,7 @@ In this approach, Airflow will read the DAGs from a PVC
which has ``ReadOnlyMany
.. code-block:: bash
- helm upgrade --install airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set dags.persistence.enabled=true \
--set dags.persistence.existingClaim=my-volume-claim
--set dags.gitSync.enabled=false
@@ -181,10 +181,10 @@ Finally, from the context of your Airflow Helm chart
directory, you can install
.. code-block:: bash
- helm upgrade --install airflow . -f override-values.yaml
+ helm upgrade --install airflow apache-airflow/airflow -f
override-values.yaml
If you have done everything correctly, Git-Sync will pick up the changes you
make to the DAGs
in your private Github repo.
-You should take this a step further and set ``dags.gitSycn.knownHosts`` so you
are not susceptible to man-in-the-middle
+You should take this a step further and set ``dags.gitSync.knownHosts`` so you
are not susceptible to man-in-the-middle
attacks. This process is documented in the :ref:`production guide
<production-guide:knownhosts>`.
diff --git a/docs/helm-chart/manage-logs.rst b/docs/helm-chart/manage-logs.rst
index a9987fb..79c0be1 100644
--- a/docs/helm-chart/manage-logs.rst
+++ b/docs/helm-chart/manage-logs.rst
@@ -27,7 +27,7 @@ With this option, Airflow will log locally to each pod. As
such, the logs will o
.. code-block:: bash
- helm upgrade airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set logs.persistence.enabled=false
# --set workers.persistence.enabled=false (also needed if using
``CeleryExecutor``)
@@ -40,7 +40,7 @@ You can modify the template:
.. code-block:: bash
- helm upgrade airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set executor=CeleryExecutor \
--set workers.persistence.size=10Gi
@@ -58,7 +58,7 @@ for details.
.. code-block:: bash
- helm upgrade airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set logs.persistence.enabled=true
# you can also override the other persistence
# by setting the logs.persistence.* values
@@ -71,7 +71,7 @@ In this approach, Airflow will log to an existing
``ReadWriteMany`` PVC. You pas
.. code-block:: bash
- helm upgrade airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set logs.persistence.enabled=true \
--set logs.persistence.existingClaim=my-volume-claim
@@ -83,7 +83,7 @@ See the :doc:`Elasticsearch providers guide
<apache-airflow-providers-elasticsea
.. code-block:: bash
- helm upgrade airflow . \
+ helm upgrade --install airflow apache-airflow/airflow \
--set elasticsearch.enabled=true \
--set elasticsearch.secretName=my-es-secret
# Other choices exist. Please refer to values.yaml for details.
diff --git a/docs/helm-chart/parameters-ref.rst
b/docs/helm-chart/parameters-ref.rst
index f950296..19b67ef 100644
--- a/docs/helm-chart/parameters-ref.rst
+++ b/docs/helm-chart/parameters-ref.rst
@@ -62,6 +62,6 @@ Specify each parameter using the ``--set
key=value[,key=value]`` argument to ``h
.. code-block:: bash
- helm install --name my-release \
+ helm install my-release apache-airflow/airflow \
--set executor=CeleryExecutor \
--set enablePodLaunching=false .
diff --git a/docs/helm-chart/quick-start.rst b/docs/helm-chart/quick-start.rst
index b5f0846..7be24f8 100644
--- a/docs/helm-chart/quick-start.rst
+++ b/docs/helm-chart/quick-start.rst
@@ -35,8 +35,8 @@ Confirm it’s up:
kubectl cluster-info --context kind-kind
-Add Airflow Stable Repo
------------------------
+Add Airflow Helm Stable Repo
+----------------------------
.. code-block:: bash
@@ -97,7 +97,6 @@ Build a Docker image from your DAGs
.. code-block:: bash
- # from airflow chart directory
- helm upgrade $RELEASE_NAME --namespace $NAMESPACE \
+ helm upgrade $RELEASE_NAME apache-airflow/airflow --namespace $NAMESPACE
\
--set images.airflow.repository=my-dags \
--set images.airflow.tag=0.0.1
