Kubernetes
==========

.. toctree::
   :maxdepth: 1
   :hidden:

   Helm <deploying-kubernetes-helm.rst>
   Native <deploying-kubernetes-native.rst>

Kubernetes_ is a popular system for deploying distributed applications on clusters,
particularly in the cloud.  You can use Kubernetes to launch Dask workers in the
following two ways:

1.  **Helm**:

    You can deploy Dask and (optionally) Jupyter or JupyterHub on Kubernetes
    easily using Helm_

    .. code-block:: bash

       helm repo add dask https://helm.dask.org/    # add the Dask Helm chart repository
       helm repo update                             # get latest Helm charts
       # For single-user deployments, use dask/dask
       helm install my-dask dask/dask               # deploy standard Dask chart
       # For multi-user deployments, use dask/daskhub
       helm install my-dask dask/daskhub            # deploy JupyterHub & Dask

    This is a good choice if you want to do the following:

    1.  Run a managed Dask cluster for a long period of time
    2.  Also deploy a Jupyter / JupyterHub server from which to run code
    3.  Share the same Dask cluster between many automated services
    4.  Try out Dask for the first time on a cloud-based system
        like Amazon, Google, or Microsoft Azure where you already have
        a Kubernetes cluster. If you don't already have Kubernetes deployed,
        see our :doc:`Cloud documentation <deploying-cloud>`.

    You can also use the ``HelmCluster`` cluster manager from dask-kubernetes to manage your
    Helm Dask cluster from within your Python session.

    .. code-block:: python

       from dask_kubernetes import HelmCluster

       cluster = HelmCluster(release_name="myrelease")
       cluster.scale(10)

    .. note::

      For more information, see :doc:`Dask and Helm documentation <deploying-kubernetes-helm>`.

2.  **Native**:
    You can quickly deploy Dask workers on Kubernetes
    from within a Python script or interactive session using Dask-Kubernetes_

    .. code-block:: python

       from dask_kubernetes import KubeCluster
       cluster = KubeCluster.from_yaml('worker-template.yaml')
       cluster.scale(20)  # add 20 workers
       cluster.adapt()    # or create and destroy workers dynamically based on workload

       from dask.distributed import Client
       client = Client(cluster)

    This is a good choice if you want to do the following:

    1.  Dynamically create a personal and ephemeral deployment for interactive use
    2.  Allow many individuals the ability to launch their own custom dask deployments,
        rather than depend on a centralized system
    3.  Quickly adapt Dask cluster size to the current workload

    .. note::

      For more information, see Dask-Kubernetes_ documentation.

You may also want to see the documentation on using
:doc:`Dask with Docker containers <deploying-docker>`
to help you manage your software environments on Kubernetes.

.. _Kubernetes: https://kubernetes.io/
.. _Dask-Kubernetes: https://kubernetes.dask.org/
.. _Helm: https://helm.sh/