(Optional) Deploy Jupyter#

This documentation is part of NVIDIA DGX BasePOD: Deployment Guide Featuring NVIDIA DGX A100 Systems.

Base Command Manager (BCM) provides a robust and popular Jupyter integration. Because the Jupyter integration distributes the kernel across the cluster through the HPC workload management system or Kubernetes, Jupyter is generally installed on the head node or on a login node.

Note

Before you complete the steps in this documentation, complete Deploy Slurm.

Warning

The # prompt indicates commands that you execute as the root user on a head node. The % prompt indicates commands that you execute within cmsh.

Install Jupyter by Using the CLI Wizard#

  1. Run the cm-jupyter-setup CLI wizard on the head node as the root user.

    1# cm-jupyter-setup

  2. Choose Deploy to continue.

    _images/jupyter-2.png

  3. Specify the overlay name and priority for the JupyterHub login nodes. By default, the Jupyter wizard will create a configuration overlay named jupyterhub with a priority of 500. Use the defaults unless there is an existing jupyterhub overlay.

    _images/jupyter-3.png

  4. Select bcm10-headnode and then Ok. After HA is configured, the cm-jupyterhub service will be set to always run on the active head node.

  1. Select the default ports of 8000, 8901, and 8902 and select Ok. Users will access it on the active head node on port 8000.

    _images/jupyter-5.png

  2. Select Save config & deploy and then Ok.

    _images/jupyter-6.png

  3. Select Ok to start the installation. By default, the Jupyter wizard will save the deployment configuration in /root/cm jupyter setup.conf. This configuration file can be used to redeploy Jupyter in the future.

    _images/jupyter-7.png

  4. When the installation completes, the cm-jupyter service will automatically be started on the selected node. All users in the cluster (except the root user) will be able to login to Jupyterhub using a web browser at http://<head-node-ip or FQDN>:8000. Example: http://10.227.52.254:8000.

    _images/jupyter-8.png

  5. If needed, a test user can be created with the following command:

    1# cmsh -c "user; add jupyterhubuser; set password jupyterhubuser; commit"

  6. Add the user to Kubernetes.

    1# cm-kubernetes-setup --add-user jupyterhubuser --operators cm-jupyter-kernel-operator

Next Steps#

After you complete the steps on this page, you can configure High Availability.

On this page