Deploy NeMo Auditor Using Parent Helm Chart#

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

By default, this deployment enables only Auditor microservice and PostgreSQL. All other microservices are explicitly disabled.

Tip

Alternatively, to deploy Auditor as part of the entire platform, refer to Install NeMo Microservices Helm Chart and add the --set tags.auditor=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

  • Optional: External services if not using the chart-provided dependencies:

    • PostgreSQL: The persistent data store for NeMo Auditor.

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 Auditor.

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 values.yaml file to enable only NeMo Auditor:

    auditor:
  auditorApiKeysSecretName: "auditor-api-keys"
tags:
  platform: false
  auditor: true

    As an alternative to creating a values.yaml file and continuing with these steps, you can perform a tag-based installation with Helm.

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

  3. Create the namespace:

    $ kubectl create namespace nemo-auditor

  4. Create an image pull secret in the namespace:

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

  5. Create a auditor-api-keys secret for access to models from build.nvidia.com. This secret is required even if you plan to access locally-deployed models.

    $ kubectl create secret \
    -n nemo-auditor \
    generic auditor-api-keys \
    --from-literal=NIM_API_KEY=$NVIDIA_API_KEY

    You can get an API key from https://build.nvidia.com/explore/discover.

  6. Install the chart with your custom values file:

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

Post-Installation#

  1. Port-forward the service:

    $ kubectl -n nemo-auditor \
    port-forward \
    service/nemo-auditor \
    5000:5000

  2. Verify the deployment: