From afa54dfd3d30f6cfc2597c944fb36c6a38372a96 Mon Sep 17 00:00:00 2001 From: Bernhard Stadlbauer Date: Mon, 12 Dec 2022 07:26:36 +0100 Subject: [PATCH] Add README.md for `dask` Signed-off-by: Bernhard Stadlbauer --- docs/source/plugins/index.rst | 2 ++ plugins/flytekit-dask/README.md | 18 ++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 plugins/flytekit-dask/README.md diff --git a/docs/source/plugins/index.rst b/docs/source/plugins/index.rst index dd1f59238d..af4f4c022c 100644 --- a/docs/source/plugins/index.rst +++ b/docs/source/plugins/index.rst @@ -9,6 +9,7 @@ Plugin API reference * :ref:`AWS Sagemaker ` - AWS Sagemaker plugin reference * :ref:`Google Bigquery ` - Google Bigquery plugin reference * :ref:`FS Spec ` - FS Spec API reference +* :ref:`Dask ` - Dask standard API reference * :ref:`Deck standard ` - Deck standard API reference * :ref:`Dolt standard ` - Dolt standard API reference * :ref:`Great expectations ` - Great expectations API reference @@ -38,6 +39,7 @@ Plugin API reference AWS Sagemaker Google Bigquery FS Spec + Dask Deck standard Dolt standard Great expectations diff --git a/plugins/flytekit-dask/README.md b/plugins/flytekit-dask/README.md new file mode 100644 index 0000000000..238e0e9267 --- /dev/null +++ b/plugins/flytekit-dask/README.md @@ -0,0 +1,18 @@ +# Flytekit Dask Plugin + +Flyte can execute `dask` jobs natively on a Kubernetes Cluster, which manages the virtual `dask` cluster's lifecycle +(spin-up and tear down). It leverages the open-source Kubernetes Dask Operator and can be enabled without signing up +for any service. This is like running a transient (ephemeral) `dask` cluster - a type of cluster spun up for a specific +task and torn down after completion. This helps in making sure that the Python environment is the same on the job-runner +(driver), scheduler and the workers. + +To install the plugin, run the following command: + +```bash +pip install flytekitplugins-dask +``` + +To configure Spark in the Flyte deployment's backed, follow [these steps](https://docs.flyte.org/projects/cookbook/en/latest/auto/integrations/flytekit_plugins/k8s_dask/index.html#deploy-dask-plugin-in-the-flyte-backend) + +An [example](https://docs.flyte.org/projects/cookbook/en/latest/auto/integrations/flytekit_plugins/k8s_dask/index.html) +can be found in the documentation.