Helm Dashboard Helm Chart

Basic Introduction

This is a Helm chart package to manage Helm Dashboard deployment on your Kubernetes cluster.

Prerequisites

• Image pull secret

  • Create a secret to pull images from the NGC registry in the same namespace as the pod that uses it:
    kubectl create secret docker-registry <secret-name> --docker-server=nvcr.io '--docker-username=$oauthtoken' --docker-password=<API-KEY> --docker-email=<your-email> -n <your-namespace>
    

    where:
    • <secret-name> is a short name like alice-ngc-secret to be used on your local system when deploying applications
    • <API-KEY> is your NGC API Key
    • <your-email> is the e-mail address you used to sign up for NGC
    • <your-namespace> is the Kubernetes namespace in which you are going to deploy applications, often just default when you're getting started

• Persistent storage (optional)

  • Install a persistent storage plugin such as Longhorn (installed by the production cluster configuration automation, and optionally included in the local developer setup)

Installation

Using NGC CLI and NGC Web UI

Please see the NGC Helm Charts documentation for general guidance.

Using Helm

1. Login to the NGC registry

   helm registry login nvcr.io
   

2. Add repo on your local system

   helm repo add <your-repo-name> https://helm.ngc.nvidia.com/nvidia/holoscan-for-media/ '--username=$oauthtoken' --password=<API-KEY>
   

   where:

   • <your-repo-name> is a short name like holoscan-for-media to be used on your local system to indicate the chart repository on NGC specified by the URL
   • <API-KEY> is your NGC API Key

3. Update the repo or fetch particular chart

   helm repo update
   

   or

   helm pull <your-repo-name>/helm-dashboard
   

   where:

   • <your-repo-name> is the short name you used in the helm repo add command above

4. Now you can see all the charts available

   helm search repo
   

5. You are ready to install Helm Dashboard using its Helm chart

   Install using below command if the image pull secret was created beforehand as mentioned in prerequisites

   helm install --set imagePullSecrets[0].name=<secret-name>,service.nodePort=<port>,dashboard.persistence.enabled=<persistent> <release-name> <your-repo-name>/helm-dashboard
   

   else

   helm install --set imageCredentials.password=<API-KEY>,service.nodePort=<port>,dashboard.persistence.enabled=<persistent> <release-name> <your-repo-name>/helm-dashboard
   

   where:

   • <secret-name> is the short name you used in the kubectl create secret command above
   • <API-KEY> is your NGC API Key
   • <port> is a node port to expose the service on each of the nodes in the cluster, described in more detail below
   • <persistent> is true to enable persistent storage (default: false). Enabling persistent storage is optional, but it ensures Helm configuration persists even after pod restart.
   • <release-name> is a short name, like helm-dashboard, which should be unique on your local system, to indicate this particular installation of this application
   • <your-repo-name> is the short name you used in the helm repo add command above

   The allowed range for node ports is 30000-32767 by default. The service.nodePort=<port> can also be omitted. If you don't set this field, the default port is 32033. If the node port is set empty, Kubernetes will randomly assign the port number.

6. After installation you can check the status

   kubectl get all -o wide
   

7. Once the pod is running you can use Helm Dashboard

   Access it through the node port (http://<node-ip>:<port>) where:

   • <node-ip> is an IP address of a node in your cluster
   • <port> is the node port used in the helm install command above

8. Other commands to manage the installed application

   helm status <release-name>
   helm get all <release-name>
   helm uninstall <release-name>
   

   where:

   • <release-name> is the short name you used in the helm install command above