From c09f30cd369d3e74b8c8951372ca62fadbdffc89 Mon Sep 17 00:00:00 2001 From: LIU ZHE YOU Date: Sat, 8 Feb 2025 20:37:02 +0800 Subject: [PATCH] Update k8s test description for non LocalExecutor --- contributing-docs/testing/k8s_tests.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/contributing-docs/testing/k8s_tests.rst b/contributing-docs/testing/k8s_tests.rst index 4891182f69923..7e01b1807a342 100644 --- a/contributing-docs/testing/k8s_tests.rst +++ b/contributing-docs/testing/k8s_tests.rst @@ -89,9 +89,12 @@ In order to deploy Airflow, the PROD image of Airflow need to be extended and ex template files should be added to the image. This is done via ``build-k8s-image``, ``upload-k8s-image``. This can also be done for all/selected images/clusters in parallel via ``--run-in-parallel`` flag. +Deploy Airflow to Kubernetes Cluster +------------------------------------ + Then Airflow (by using Helm Chart) can be deployed to the cluster via ``deploy-airflow`` command. This can also be done for all/selected images/clusters in parallel via ``--run-in-parallel`` flag. You can -pass extra options when deploying airflow to configure your depliyment. +pass extra options when deploying airflow to configure your deployment. You can check the status, dump logs and finally delete cluster via ``status``, ``logs``, ``delete-cluster`` commands. This can also be done for all created clusters in parallel via ``--all`` flag. @@ -102,6 +105,22 @@ You can run set of k8s tests via ``tests`` command. You can also run tests in pa clusters by ``--run-in-parallel`` flag. +**Note**: + +If you want to run tests with a non-``LocalExecutor``, you need to deploy Airflow with the corresponding ``executor`` flags. +For example, if you want to run tests with ``KubernetesExecutor`` + +.. code-block:: bash + + breeze k8s tests --executor KubernetesExecutor + +you need to deploy Airflow with the ``--executor KubernetesExecutor`` flag. + +.. code-block:: bash + + breeze k8s deploy-airflow --executor KubernetesExecutor + + Running tests with Kubernetes Cluster -------------------------------------