OVDC: Deployment#

Configuration#

First follow the configuration guide to craft a values.yaml for your environment.

Deployment Steps#

Warning

Replace <ngc-api-key> in the following commands with your org’s access token or your NGC (NVIDIA’s container/Helm chart registry, nvcr.io) personal key with access to the nvidia/omniverse NGC repository.

1. Configure Helm#

If the chart repo nvidia/omniverse is not setup, execute the following to add the repo and update the local chart index.

To review your existing chart repositories run the following.

helm repo list

If https://helm.ngc.nvidia.com/nvidia/omniverse is not listed, run the following to setup the chart repository.

helm repo add omniverse https://helm.ngc.nvidia.com/nvidia/omniverse \
    --username '$oauthtoken' \
    --password "<ngc-api-key>"

helm repo update

2. Prepare Namespace#

Create the Kubernetes namespace where the service will be deployed, if it does not already exist. Skip this step if the target namespace already exists.

# Create the namespace if does not already exist.
kubectl create namespace ovdc

3. Create Required Secrets#

Image Pull Secret Create a secret to allow Kubernetes to access the NGC registry. The chart’s default image.pullSecrets entry is named regcred.
```
# Setup the docker-registry secret.
kubectl create secret docker-registry regcred \
   --namespace ovdc \
   --docker-server=nvcr.io \
   --docker-username='$oauthtoken' \
   --docker-password=<ngc-api-key>
```
Important

The secret name must match the one specified in your Helm values under image.pullSecrets. If you use a different secret name, update image.pullSecrets in values.yaml to match.
(Optional) TLS Secret If you are enabling TLS for a production deployment, follow the TLS guide to create and configure TLS secrets.

4. Install Helm Chart#

Using the prepared values file, install the ovderivedcache chart. The release name becomes the resource name prefix: release ovdc with the chart’s default naming produces objects named ovdc-ovderivedcache.

helm install ovdc omniverse/ovderivedcache \
    --version 6.0.0 \
    --namespace ovdc \
    -f values.yaml

Uninstall Instructions#

Uninstall Helm Chart
```
helm uninstall ovdc -n ovdc
```
Remove Unused Persistent Volumes

Important

Orphaned Data Will Remain

Persistent volumes created by the installation are not cleaned up by helm or Kubernetes. New/re-installations will not use pre-existing volumes.

It is recommended to remove unused PVCs after running the uninstall steps above.
```
# Remove **all** persistent volumes that are not attached to pods from the
# given namespace.
kubectl delete pvc --all -n ovdc
```

Summary#

This guide covered the deployment steps for OVDC, including chart registry authentication, namespace creation, secret configuration, and chart installation. After deployment, verify that OVDC pods are running and healthy in your cluster.

For detailed information on configuring OVDC settings such as memory allocation, storage sizing, and monitoring, refer to the configuration guide.