shohamy7 commented on code in PR #36331: URL: https://github.com/apache/airflow/pull/36331#discussion_r1433135592
########## docs/helm-chart/extending-the-chart.rst: ########## @@ -0,0 +1,124 @@ + .. 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. + +Extending the Chart +------------------- + +In some cases, you will want to deploy your custom templates (e.g. maintenance CronJobs you want to add) +together with the Airflow chart installation. +However, sometimes those templates are not directly related to the Airflow chart, +thus should not be added to the chart. + +Instead, you can easily extend the chart and create a custom chart with your custom templates that +depends on the Airflow chart. +When you'll install your custom chart, the Airflow chart will also be installed. + +You can extend the official Airflow chart by applying the following steps. + +Create your custom Chart +''''''''''''''''''''''''' + +First, you will need to create you own chart directory. You can do it by running the following command: + +.. code-block:: bash + + helm create my-custom-chart + + +This command will create a directory called ``my-custom-chart`` with the following structure: + +.. code-block:: + + my-custom-chart/ + ├── .helmignore + ├── Chart.yaml + ├── values.yaml + ├── charts/ + └── templates/ + └── tests/ + +Add Airflow chart as dependency +''''''''''''''''''''''''''''''' + +Second, you will need to add the Airflow chart as dependency to your chart. +This will give you the ability to add your custom templates without the need to modify the Airflow chart itself. +In order to add the Airflow chart as a dependency (often called ``subcharts``) to your chart, +add the following lines to your ``Chart.yaml`` file: + +.. code-block:: + + dependencies: + - name: airflow + version: 1.11.0 + repository: https://airflow.apache.org + +.. note:: + + Make sure you already added the Airflow repo locally by running: ``helm repo add apache-airflow https://airflow.apache.org``. + +.. tip:: + + You can also use the name of the repo instead the URL by replacing + ``https://airflow.apache.org`` with ``"@apache-airflow"``. + +Adding the Airflow chart as a dependency means that it will be deploy together with your custom chart. Review Comment: fixed ########## docs/helm-chart/extending-the-chart.rst: ########## @@ -0,0 +1,124 @@ + .. 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. + +Extending the Chart +------------------- + +In some cases, you will want to deploy your custom templates (e.g. maintenance CronJobs you want to add) +together with the Airflow chart installation. +However, sometimes those templates are not directly related to the Airflow chart, +thus should not be added to the chart. + +Instead, you can easily extend the chart and create a custom chart with your custom templates that +depends on the Airflow chart. +When you'll install your custom chart, the Airflow chart will also be installed. + +You can extend the official Airflow chart by applying the following steps. + +Create your custom Chart +''''''''''''''''''''''''' + +First, you will need to create you own chart directory. You can do it by running the following command: + +.. code-block:: bash + + helm create my-custom-chart + + +This command will create a directory called ``my-custom-chart`` with the following structure: + +.. code-block:: + + my-custom-chart/ + ├── .helmignore + ├── Chart.yaml + ├── values.yaml + ├── charts/ + └── templates/ + └── tests/ + +Add Airflow chart as dependency +''''''''''''''''''''''''''''''' + +Second, you will need to add the Airflow chart as dependency to your chart. +This will give you the ability to add your custom templates without the need to modify the Airflow chart itself. +In order to add the Airflow chart as a dependency (often called ``subcharts``) to your chart, +add the following lines to your ``Chart.yaml`` file: + +.. code-block:: + + dependencies: + - name: airflow + version: 1.11.0 + repository: https://airflow.apache.org + +.. note:: + + Make sure you already added the Airflow repo locally by running: ``helm repo add apache-airflow https://airflow.apache.org``. + +.. tip:: + + You can also use the name of the repo instead the URL by replacing + ``https://airflow.apache.org`` with ``"@apache-airflow"``. + +Adding the Airflow chart as a dependency means that it will be deploy together with your custom chart. +You can disable the installation of the Airflow by adding the ``condition`` field to the ``dependencies`` section. +For example: + +.. code-block:: + + dependencies: + - name: airflow + version: 1.11.0 + repository: https://airflow.apache.org + condition: airflow.enabled + +This will check if the value of ``airflow.enabled`` inside your ``values.yaml`` is ``true``. +If it is, the Airflow chart will be deployed together with your custom chart. +Otherwise, only your templates will be deployed. + +Download the Airflow Chart +'''''''''''''''''''''''''' + +Third, after you specified the Airflow chart inside the ``dependencies`` section in ``Chart.yaml`` file, Review Comment: fixed -- 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. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
