NeMo Data Designer Deployment Guide

You can deploy NeMo Data Designer using the parent Helm chart. The chart manages all required dependencies automatically. Using the chart is the recommended approach for most users.

Tip

Alternatively, to deploy Data Designer as part of the entire platform, refer to Install NeMo Microservices Helm Chart and add the --set tags.data-designer=true argument to the helm install command.

Why Use the Parent Chart?

• Dependency Management: The parent chart ensures all required services are installed and networked correctly.

• Simplicity: One command, one values file, minimal manual configuration.

• Support: This is the officially supported and tested deployment method.

Prerequisites

Dependencies

• Kubernetes cluster with Helm installed

• NGC API key for pulling images

Kubernetes

• Create NGC Image pull credentials. This includes the following secrets:

  • A generic secret containing your NGC API key, referenced by existingSecret.

  • An image pull secret, referenced by existingImagePullSecret.

  Create these secrets in the same namespace that you plan to deploy NeMo Data Designer.

Installation

1. Add the NeMo Microservices Helm Chart helm repo:

   $ helm repo add nmp https://helm.ngc.nvidia.com/nvidia/nemo-microservices \
      --username='$oauthtoken' \
      --password=$NGC_API_KEY
   

   $ helm repo update
   

2. Create a secret for sensitive API keys:

   kubectl --namespace nemo-data-designer \
     create secret generic data-designer-api-keys \
     --from-literal=nvidiabuild=<build.nvidia.com-api-key>
   

3. Create a values.yaml file to enable only NeMo Data Designer:

   data-designer:
     env:
       NIM_API_KEY:
         valueFrom:
           secretKeyRef:
             name: data-designer-api-keys
             key: nvidiabuild
     config:
       model_provider_registry:
         default: "nvidiabuild"
         providers:
           - name: "nvidiabuild"
             endpoint: "https://integrate.api.nvidia.com/v1"
             api_key: "NIM_API_KEY"
   tags:
     platform: false
     data-designer: true
   

   As an alternative to creating a values.yaml file and continuing with these steps, you can perform a Tag-Based Helm Installation.

   For information about the values file, refer to NeMo Microservices Helm Chart.

4. Create the namespace:

   $ kubectl create namespace nemo-data-designer
   

5. Create an image pull secret in the namespace:

   $ kubectl --namespace nemo-data-designer \
       create secret docker-registry nvcrimagepullsecret \
       --docker-server=nvcr.io \
       --docker-username='$oauthtoken' \
       --docker-password=$NGC_API_KEY
   

6. Install the chart with your custom values file:

   $ helm --namespace nemo-data-designer \
       install nemo-data-designer \
       nmp/nemo-microservices-helm-chart \
       -f values.yaml
   

Post-Installation

1. Port-forward the service:

   $ kubectl -n nemo-data-designer \
       port-forward \
       service/nemo-data-designer \
       8000:8000
   

2. Verify the deployment:

   • Test the data designer endpoints using the NeMo Microservices SDK