.. _helm:

Helm Charts
===========

Get started by adding this Helm repo

``helm repo add polus https://polusai.github.io/notebooks-hub/_static/charts``

.. _jupyterhub:

JupyterHub
----------

Install the chart: ``helm install polus/polus-jupyterhub --generate-name``

.. include:: helm/jupyterhub.rst

.. _notebooks-hub-api:

Notebooks Hub API
-----------------

Install the chart: ``helm install polus/notebooks-hub-api --generate-name``

.. include:: helm/notebooks-hub-api.rst

.. _notebooks-hub-ui:

Notebooks Hub UI
----------------

Install the chart: ``helm install polus/notebooks-hub-ui --generate-name``

.. include:: helm/notebooks-hub-ui.rst

.. _minimal-test-deployment:

Minimal Test Deployment of JupyterHub
-------------------------------------

To test the basic functionality of the application (for example in Docker Desktop K8s cluster or a separate namespace in the cloud cluster) you can select the minimal viable configuration without auth, persistent database and any other integrations enabled.

1. Create `local-values.yaml` with the following content

   .. code-block:: yaml

      hub:
        storage:
          storageClass: aws-efs
          storagePerUser: 1Gi
          sharedNotebooksStorage: 1Gi
          modulesStorage: 1Gi

        service:
          type: NodePort

      postgresql:
        enabled: false

2. Install chart dependencies

   .. code-block:: bash

      helm repo add bitnami https://charts.bitnami.com/bitnami
      helm dependency update
      helm dependency build

3. Deploy the application

   .. code-block:: bash

      helm upgrade --install --generate-name deploy/Helm/jupyterhub --values local-values.yaml --namespace ${KUBERNETES_NAMESPACE}