dask · jacobtomlinson · Aug 26, 2020 · Aug 15, 2020 · Aug 18, 2020 · Aug 20, 2020
diff --git a/.github/workflows/frigate.yml b/.github/workflows/frigate.yml
@@ -17,7 +17,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install frigate
-      - name: Check README is up to date
+      - name: Check that dask README is up to date
         run: |
           frigate gen dask > dask/README.md
           if git status --porcelain dask/README.md | grep .; then
@@ -26,3 +26,12 @@ jobs:
               echo "In both cases please run `frigate gen dask > dask/README.md`."
               exit 1
           fi
+      - name: Check that daskhub README is up to date
+        run: |
+          frigate gen daskhub > daskhub/README.md
+          if git status --porcelain daskhub/README.md | grep .; then
+              echo "README is out of date. Either you have modified README.md directly or you've modified values.yaml or Chart.yaml without generating the README."
+              echo "If you have modified with README.md please make those changes in daskhub/.frigate."
+              echo "In both cases please run `frigate gen daskhub > daskhub/README.md`."
+              exit 1
+          fi
diff --git a/.travis.yml b/.travis.yml
@@ -5,12 +5,13 @@ python:
   - "3.6"
 
 install:
-  - curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash
-  - helm init --client-only
+  - curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get-helm-3 | bash
   - pip install chartpress==0.4.2
 
 script:
   - helm lint dask
+  - helm lint daskhub --set 'dask-gateway.gateway.auth.jupyterhub.apiToken=foo' --set 'jupyterhub.proxy.secretToken=foo'
+
 
 deploy:
   - provider: script

diff --git a/README.md b/README.md
diff --git a/README.md b/README.md
@@ -0,0 +1,38 @@
+[![Travis Build Status](https://travis-ci.com/dask/helm-chart.svg?branch=master)](https://travis-ci.com/dask/helm-chart)
+[![Dask Chart version](https://img.shields.io/badge/dynamic/yaml?url=https://helm.dask.org/index.yaml&label=chart&query=$.entries.dask[:1].version&color=277A9F)](https://helm.dask.org/)
+[![DaskHub Chart version](https://img.shields.io/badge/dynamic/yaml?url=https://helm.dask.org/index.yaml&label=chart&query=$.entries.daskhub[:1].version&color=277A9F)](https://helm.dask.org/)
+[![Dask version](https://img.shields.io/badge/dynamic/yaml?url=https://helm.dask.org/index.yaml&label=Dask&query=$.entries.daskhub[:1].appVersion&color=D67548)](https://helm.dask.org/)
+
+
+
+Dask Helm Charts
+================
+
+This repository contains Dask's two helm charts.
+
+- [dask](./dask/README.md): Install Dask on Kubernetes for a single user with Jupyter and dask-kubernetes.
+- [daskhub](./daskhub/README.md): Install Dask on Kubernetes for multiple users with JupyterHub and Dask Gateway.
+
+## Single-user Quickstart
+
+Users deploying Dask for a single user should use the `dask/dask` helm chart.
+
+```
+helm repo add dask https://helm.dask.org/
+helm repo update
+helm install --name my-release dask/dask
+```
+
+See [dask](./dask/README.md) for more.
+
+## Multi-user Quickstart
+
+Users deploying Dask for multiple users should use the `dask/daskhub` helm chart.
+
+```
+helm repo add dask https://helm.dask.org/
+helm repo update
+helm install --name my-release dask/daskhub
+```
+
+See [daskhub](./daskhub/README.md) for more.
diff --git a/chartpress.yaml b/chartpress.yaml
@@ -3,3 +3,7 @@ charts:
     repo:
       git: dask/helm-chart
       published: https://helm.dask.org
+  - name: daskhub
+    repo:
+      git: dask/helm-chart
+      published: https://helm.dask.org
diff --git a/daskhub/.frigate b/daskhub/.frigate
@@ -0,0 +1,167 @@
+{% extends "markdown.jinja2" %}
+
+{% block description -%}
+[![Travis Build Status](https://travis-ci.com/dask/helm-chart.svg?branch=master)](https://travis-ci.com/dask/helm-chart)
+[![Chart version](https://img.shields.io/badge/dynamic/yaml?url=https://helm.dask.org/index.yaml&label=chart&query=$.entries.daskhub[:1].version&color=277A9F)](https://helm.dask.org/)
+[![Dask version](https://img.shields.io/badge/dynamic/yaml?url=https://helm.dask.org/index.yaml&label=Dask&query=$.entries.daskhub[:1].appVersion&color=D67548)](https://helm.dask.org/)
+
+This chart provides a multi-user, Dask-Gateway enabled JupyterHub.
+It combines the [JupyterHub](https://jupyterhub.readthedocs.io/en/stable/)
+and [Dask Gateway](https://gateway.dask.org/) helm charts.
+
+For single users, a simpler setup is supported by the `dask` helm chart.
+
+## Chart Details
+
+This chart will deploy the following
+
+- A standard Dask Gateway deployment using the Dask Gateway helm chart,
+  configured to use JupyterHub for authentication.
+- A standard JupyterHub deployment using the JupyterHub helm chart,
+  configured proxy Dask Gateway requests and set Dask Gateway-related
+  environment variables.
+
+## Prepare Configuration File
+
+In this step, we'll prepare a YAML configuration file with the fields
+required by the DaskHub helm chart. It will contain some secret
+keys, which should not be checked into version control in plaintext.
+
+We need two random hex strings that will be used as keys, one for
+JupyterHub and one for Dask Gateway.
+
+Run the following command, and copy the output. This is our `token-1`.
+
+```console
+openssl rand -hex 32  # generate token-1
+```
+
+Run command again and copy the output. This is our `token-2`.
+
+```console
+openssl rand -hex 32  # generate token-2
+```
+
+Now substitute those two values for `<token-1>` and `<token-2>` below.
+Note that `<token-2>` is used twice, once for `jupyterhub.hub.services.dask-gateway.apiToken`, and a second time for `dask-gateway.gateway.auth.jupyterhub.apiToken`.
+
+
+```yaml
+# file: secrets.yaml
+jupyterhub:
+  proxy:
+    secretToken: "<token-1>"
+  hub:
+    services:
+      dask-gateway:
+        apiToken: "<token-2>"
+
+dask-gateway:
+  gateway:
+    auth:
+      jupyterhub:
+        apiToken: "<token-2>"
+```
+
+## Install DaskHub
+
+This example installs into the namespace `dhub`. Make sure you're
+in the same directory as the `secrets.yaml` file.
+
+```console
+$ helm upgrade --wait --install --render-subchart-notes \
+    dhub dask/daskhub \
+    --namespace=dhub \
+    --version=0.0.1 \
+    --values=secrets.yaml \
+    --values=config.yaml
+```
+
+The output explains how to find the IPs for your JupyterHub and Dask Gateway.
+
+```console
+NAME           TYPE           CLUSTER-IP      EXTERNAL-IP      PORT(S)                      AGE
+proxy-public   LoadBalancer   10.43.249.239   35.202.158.223   443:31587/TCP,80:30500/TCP   2m40s
+```
+
+JupyterHub is available at the `proxy-public` external ip (35.202.158.223 in this example).
+Note, that this value needs to be set as the `jupyterhub.proxy.service.loadBalancerIP`.
+
+```yaml
+# file: config.yaml
+jupyterhub:
+  proxy:
+    service:
+      loadBalancerIP: "35.202.158.223"
+```
+
+Be sure to (re)deploy with helm with this value set to enable the Dask dashboard.
+
+## Creating a Dask Cluster
+
+To create a Dask cluster, connect to the Dask Gateway
+
+```python
+>>> from dask_gateway import Gateway
+>>> gateway = dask_gateway.Gateway()
+>>> gateway.list_clusters()
+[]
+```
+
+Once connected to the gateway, create a cluster and connect a client.
+
+```python
+>>> cluster = gateway.new_cluster()
+>>> client = cluster.get_client()
+```
+
+## Matching the user environment
+
+Dask Clients will be running the JupyterHub's singleuser environment. To ensure
+that the same environment is used for the scheduler and workers, you can provide
+it as a Gateway option.
+
+```yaml
+# config.yaml
+dask-gateway:
+  extraConfig:
+    optionHandler: |
+      from dask_gateway_server.options import Options, Integer, Float, String
+      def option_handler(options):
+          if ":" not in options.image:
+              raise ValueError("When specifying an image you must also provide a tag")
+          return {
+              "image": options.image,
+          }
+      c.Backend.cluster_options = Options(
+          String("image", default="pangeo/base-notebook:2020.07.28", label="Image"),
+          handler=option_handler,
+      )
+```
+
+The user environment will need to include `dask-gateway`.
+
+## Using dask-kubernetes instead of Dask Gateway
+
+Users who don't need Dask Gateway can use dask-kubernetes to manage creating Dask Clusters. To use dask-kubernetes, you should set
+
+```
+# config.yaml
+daskhub:
+  jupyterhub:
+    singleuser:
+      servieAccountName: daskkubernetes
+
+  dask-gateway:
+    enabled: false
+
+  dask-kubernetes:
+    enabled: true
+```
+
+When deploying, helm will create a Kubernetes ServiceAccount, Role, and RoleBinding. This ensures that the pods serving JupyterHub singleusers have the eleveated permissions for starting and stopping pods.
+
+{%- endblock %}
+
+{% block credits -%}
+{%- endblock %}
diff --git a/daskhub/.gitignore b/daskhub/.gitignore
@@ -0,0 +1,2 @@
+*.lock
+charts
diff --git a/daskhub/.helmignore b/daskhub/.helmignore
@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
diff --git a/daskhub/Chart.yaml b/daskhub/Chart.yaml
@@ -0,0 +1,26 @@
+apiVersion: v2
+name: daskhub
+icon: https://avatars3.githubusercontent.com/u/17131925?v=3&s=200
+version: 0.0.1-set.by.chartpress
+description: Multi-user JupyterHub and Dask deployment.
+dependencies:
+  - name: jupyterhub
+    version: "0.9.1"
+    repository: 'https://jupyterhub.github.io/helm-chart/'
+    import-values:
+      - child: rbac
+        parent: rbac
+  - name: dask-gateway
+    version: "0.8.0"
+    repository: 'https://dask.org/dask-gateway-helm-repo/'
+maintainers:
+  - name: Jacob Tomlinson (Nvidia)
+    email: jtomlinson@nvidia.com
+  - name: Joe Hamman (NCAR)
+    email: jhamman@ucar.edu
+  - name: Guillaume Eynard-Bontemps (CNES)
+    email: guillaume.eynard-bontemps@cnes.fr
+  - name: Erik Sundell
+    email: erik.i.sundell@gmail.com
+  - name: Tom Augspurger
+    email: tom.w.augspurger@gmail.com