> **⚠️ Important**: This documentation is automatically generated from source code. > Do not edit this file directly. # API Reference ## Packages - [nvidia.com/v1alpha1](#nvidiacomv1alpha1) ## nvidia.com/v1alpha1 Package v1alpha1 contains API Schema definitions for the nvidia.com v1alpha1 API group. ### Resource Types - [DynamoComponentDeployment](#dynamocomponentdeployment) - [DynamoGraphDeployment](#dynamographdeployment) #### Autoscaling _Appears in:_ - [DynamoComponentDeploymentSharedSpec](#dynamocomponentdeploymentsharedspec) - [DynamoComponentDeploymentSpec](#dynamocomponentdeploymentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `enabled` _boolean_ | | | | | `minReplicas` _integer_ | | | | | `maxReplicas` _integer_ | | | | | `behavior` _[HorizontalPodAutoscalerBehavior](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#horizontalpodautoscalerbehavior-v2-autoscaling)_ | | | | | `metrics` _[MetricSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#metricspec-v2-autoscaling) array_ | | | | #### DynamoComponentDeployment DynamoComponentDeployment is the Schema for the dynamocomponentdeployments API | Field | Description | Default | Validation | | --- | --- | --- | --- | | `apiVersion` _string_ | `nvidia.com/v1alpha1` | | | | `kind` _string_ | `DynamoComponentDeployment` | | | | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec` _[DynamoComponentDeploymentSpec](#dynamocomponentdeploymentspec)_ | Spec defines the desired state for this Dynamo component deployment. | | | #### DynamoComponentDeploymentSharedSpec _Appears in:_ - [DynamoComponentDeploymentSpec](#dynamocomponentdeploymentspec) - [DynamoGraphDeploymentSpec](#dynamographdeploymentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `annotations` _object (keys:string, values:string)_ | Annotations to add to generated Kubernetes resources for this component
(such as Pod, Service, and Ingress when applicable). | | | | `labels` _object (keys:string, values:string)_ | Labels to add to generated Kubernetes resources for this component. | | | | `serviceName` _string_ | The name of the component | | | | `componentType` _string_ | ComponentType indicates the role of this component (for example, "main"). | | | | `subComponentType` _string_ | SubComponentType indicates the sub-role of this component (for example, "prefill"). | | | | `dynamoNamespace` _string_ | Dynamo namespace of the service (allows to override the Dynamo namespace of the service defined in annotations inside the Dynamo archive) | | | | `resources` _[Resources](#resources)_ | Resources requested and limits for this component, including CPU, memory,
GPUs/devices, and any runtime-specific resources. | | | | `autoscaling` _[Autoscaling](#autoscaling)_ | Autoscaling config for this component (replica range, target utilization, etc.). | | | | `envs` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core) array_ | Envs defines additional environment variables to inject into the component containers. | | | | `envFromSecret` _string_ | EnvFromSecret references a Secret whose key/value pairs will be exposed as
environment variables in the component containers. | | | | `volumeMounts` _[VolumeMount](#volumemount) array_ | VolumeMounts references PVCs defined at the top level for volumes to be mounted by the component. | | | | `ingress` _[IngressSpec](#ingressspec)_ | Ingress config to expose the component outside the cluster (or through a service mesh). | | | | `sharedMemory` _[SharedMemorySpec](#sharedmemoryspec)_ | SharedMemory controls the tmpfs mounted at /dev/shm (enable/disable and size). | | | | `extraPodMetadata` _[ExtraPodMetadata](#extrapodmetadata)_ | ExtraPodMetadata adds labels/annotations to the created Pods. | | | | `extraPodSpec` _[ExtraPodSpec](#extrapodspec)_ | ExtraPodSpec allows to override the main pod spec configuration.
It is a k8s standard PodSpec. It also contains a MainContainer (standard k8s Container) field
that allows overriding the main container configuration. | | | | `livenessProbe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#probe-v1-core)_ | LivenessProbe to detect and restart unhealthy containers. | | | | `readinessProbe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#probe-v1-core)_ | ReadinessProbe to signal when the container is ready to receive traffic. | | | | `replicas` _integer_ | Replicas is the desired number of Pods for this component when autoscaling is not used. | | | | `multinode` _[MultinodeSpec](#multinodespec)_ | Multinode is the configuration for multinode components. | | | #### DynamoComponentDeploymentSpec DynamoComponentDeploymentSpec defines the desired state of DynamoComponentDeployment _Appears in:_ - [DynamoComponentDeployment](#dynamocomponentdeployment) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `backendFramework` _string_ | BackendFramework specifies the backend framework (e.g., "sglang", "vllm", "trtllm") | | Enum: [sglang vllm trtllm]
| | `annotations` _object (keys:string, values:string)_ | Annotations to add to generated Kubernetes resources for this component
(such as Pod, Service, and Ingress when applicable). | | | | `labels` _object (keys:string, values:string)_ | Labels to add to generated Kubernetes resources for this component. | | | | `serviceName` _string_ | The name of the component | | | | `componentType` _string_ | ComponentType indicates the role of this component (for example, "main"). | | | | `subComponentType` _string_ | SubComponentType indicates the sub-role of this component (for example, "prefill"). | | | | `dynamoNamespace` _string_ | Dynamo namespace of the service (allows to override the Dynamo namespace of the service defined in annotations inside the Dynamo archive) | | | | `resources` _[Resources](#resources)_ | Resources requested and limits for this component, including CPU, memory,
GPUs/devices, and any runtime-specific resources. | | | | `autoscaling` _[Autoscaling](#autoscaling)_ | Autoscaling config for this component (replica range, target utilization, etc.). | | | | `envs` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core) array_ | Envs defines additional environment variables to inject into the component containers. | | | | `envFromSecret` _string_ | EnvFromSecret references a Secret whose key/value pairs will be exposed as
environment variables in the component containers. | | | | `volumeMounts` _[VolumeMount](#volumemount) array_ | VolumeMounts references PVCs defined at the top level for volumes to be mounted by the component. | | | | `ingress` _[IngressSpec](#ingressspec)_ | Ingress config to expose the component outside the cluster (or through a service mesh). | | | | `sharedMemory` _[SharedMemorySpec](#sharedmemoryspec)_ | SharedMemory controls the tmpfs mounted at /dev/shm (enable/disable and size). | | | | `extraPodMetadata` _[ExtraPodMetadata](#extrapodmetadata)_ | ExtraPodMetadata adds labels/annotations to the created Pods. | | | | `extraPodSpec` _[ExtraPodSpec](#extrapodspec)_ | ExtraPodSpec allows to override the main pod spec configuration.
It is a k8s standard PodSpec. It also contains a MainContainer (standard k8s Container) field
that allows overriding the main container configuration. | | | | `livenessProbe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#probe-v1-core)_ | LivenessProbe to detect and restart unhealthy containers. | | | | `readinessProbe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#probe-v1-core)_ | ReadinessProbe to signal when the container is ready to receive traffic. | | | | `replicas` _integer_ | Replicas is the desired number of Pods for this component when autoscaling is not used. | | | | `multinode` _[MultinodeSpec](#multinodespec)_ | Multinode is the configuration for multinode components. | | | #### DynamoGraphDeployment DynamoGraphDeployment is the Schema for the dynamographdeployments API. | Field | Description | Default | Validation | | --- | --- | --- | --- | | `apiVersion` _string_ | `nvidia.com/v1alpha1` | | | | `kind` _string_ | `DynamoGraphDeployment` | | | | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec` _[DynamoGraphDeploymentSpec](#dynamographdeploymentspec)_ | Spec defines the desired state for this graph deployment. | | | | `status` _[DynamoGraphDeploymentStatus](#dynamographdeploymentstatus)_ | Status reflects the current observed state of this graph deployment. | | | #### DynamoGraphDeploymentSpec DynamoGraphDeploymentSpec defines the desired state of DynamoGraphDeployment. _Appears in:_ - [DynamoGraphDeployment](#dynamographdeployment) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `pvcs` _[PVC](#pvc) array_ | PVCs defines a list of persistent volume claims that can be referenced by components.
Each PVC must have a unique name that can be referenced in component specifications. | | Optional: {}
| | `services` _object (keys:string, values:[DynamoComponentDeploymentSharedSpec](#dynamocomponentdeploymentsharedspec))_ | Services are the services to deploy as part of this deployment. | | Optional: {}
| | `envs` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core) array_ | Envs are environment variables applied to all services in the deployment unless
overridden by service-specific configuration. | | Optional: {}
| | `backendFramework` _string_ | BackendFramework specifies the backend framework (e.g., "sglang", "vllm", "trtllm"). | | Enum: [sglang vllm trtllm]
| #### DynamoGraphDeploymentStatus DynamoGraphDeploymentStatus defines the observed state of DynamoGraphDeployment. _Appears in:_ - [DynamoGraphDeployment](#dynamographdeployment) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `state` _string_ | State is a high-level textual status of the graph deployment lifecycle. | | | | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array_ | Conditions contains the latest observed conditions of the graph deployment.
The slice is merged by type on patch updates. | | | #### IngressSpec _Appears in:_ - [DynamoComponentDeploymentSharedSpec](#dynamocomponentdeploymentsharedspec) - [DynamoComponentDeploymentSpec](#dynamocomponentdeploymentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `enabled` _boolean_ | Enabled exposes the component through an ingress or virtual service when true. | | | | `host` _string_ | Host is the base host name to route external traffic to this component. | | | | `useVirtualService` _boolean_ | UseVirtualService indicates whether to configure a service-mesh VirtualService instead of a standard Ingress. | | | | `virtualServiceGateway` _string_ | VirtualServiceGateway optionally specifies the gateway name to attach the VirtualService to. | | | | `hostPrefix` _string_ | HostPrefix is an optional prefix added before the host. | | | | `annotations` _object (keys:string, values:string)_ | Annotations to set on the generated Ingress/VirtualService resources. | | | | `labels` _object (keys:string, values:string)_ | Labels to set on the generated Ingress/VirtualService resources. | | | | `tls` _[IngressTLSSpec](#ingresstlsspec)_ | TLS holds the TLS configuration used by the Ingress/VirtualService. | | | | `hostSuffix` _string_ | HostSuffix is an optional suffix appended after the host. | | | | `ingressControllerClassName` _string_ | IngressControllerClassName selects the ingress controller class (e.g., "nginx"). | | | #### IngressTLSSpec _Appears in:_ - [IngressSpec](#ingressspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `secretName` _string_ | SecretName is the name of a Kubernetes Secret containing the TLS certificate and key. | | | #### MultinodeSpec _Appears in:_ - [DynamoComponentDeploymentSharedSpec](#dynamocomponentdeploymentsharedspec) - [DynamoComponentDeploymentSpec](#dynamocomponentdeploymentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `nodeCount` _integer_ | Indicates the number of nodes to deploy for multinode components.
Total number of GPUs is NumberOfNodes * GPU limit.
Must be greater than 1. | 2 | Minimum: 2
| #### PVC _Appears in:_ - [DynamoGraphDeploymentSpec](#dynamographdeploymentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `create` _boolean_ | Create indicates to create a new PVC | | | | `name` _string_ | Name is the name of the PVC | | Required: {}
| | `storageClass` _string_ | StorageClass to be used for PVC creation. Required when create is true. | | | | `size` _[Quantity](#quantity)_ | Size of the volume in Gi, used during PVC creation. Required when create is true. | | | | `volumeAccessMode` _[PersistentVolumeAccessMode](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeaccessmode-v1-core)_ | VolumeAccessMode is the volume access mode of the PVC. Required when create is true. | | | #### SharedMemorySpec _Appears in:_ - [DynamoComponentDeploymentSharedSpec](#dynamocomponentdeploymentsharedspec) - [DynamoComponentDeploymentSpec](#dynamocomponentdeploymentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `disabled` _boolean_ | | | | | `size` _[Quantity](#quantity)_ | | | | #### VolumeMount VolumeMount references a PVC defined at the top level for volumes to be mounted by the component _Appears in:_ - [DynamoComponentDeploymentSharedSpec](#dynamocomponentdeploymentsharedspec) - [DynamoComponentDeploymentSpec](#dynamocomponentdeploymentspec) | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | Name references a PVC name defined in the top-level PVCs map | | Required: {}
| | `mountPoint` _string_ | MountPoint specifies where to mount the volume.
If useAsCompilationCache is true and mountPoint is not specified,
a backend-specific default will be used. | | | | `useAsCompilationCache` _boolean_ | UseAsCompilationCache indicates this volume should be used as a compilation cache.
When true, backend-specific environment variables will be set and default mount points may be used. | false | | # Operator Default Values Injection The Dynamo operator automatically applies default values to various fields when they are not explicitly specified in your deployments. These defaults include: - **Health Probes**: Startup, liveness, and readiness probes are configured differently for frontend, worker, and planner components. For example, worker components receive a startup probe with a 2-hour timeout (720 failures × 10 seconds) to accommodate long model loading times. - **Shared Memory**: All components receive an 8Gi shared memory volume mounted at `/dev/shm` by default (can be disabled or resized via the `sharedMemory` field). - **Environment Variables**: Components automatically receive environment variables like `DYN_NAMESPACE`, `DYN_PARENT_DGD_K8S_NAME`, `DYNAMO_PORT`, and backend-specific variables. - **Pod Configuration**: Default `terminationGracePeriodSeconds` of 60 seconds and `restartPolicy: Always`. - **Autoscaling**: When enabled without explicit metrics, defaults to CPU-based autoscaling with 80% target utilization. - **Backend-Specific Behavior**: For multinode deployments, probes are automatically modified or removed for worker nodes depending on the backend framework (VLLM, SGLang, or TensorRT-LLM). ## Pod Specification Defaults All components receive the following pod-level defaults unless overridden: - **`terminationGracePeriodSeconds`**: `60` seconds - **`restartPolicy`**: `Always` ## Shared Memory Configuration Shared memory is enabled by default for all components: - **Enabled**: `true` (unless explicitly disabled via `sharedMemory.disabled`) - **Size**: `8Gi` - **Mount Path**: `/dev/shm` - **Volume Type**: `emptyDir` with `memory` medium To disable shared memory or customize the size, use the `sharedMemory` field in your component specification. ## Health Probes by Component Type The operator applies different default health probes based on the component type. ### Frontend Components Frontend components receive the following probe configurations: **Liveness Probe:** - **Type**: HTTP GET - **Path**: `/health` - **Port**: `http` (8000) - **Initial Delay**: 60 seconds - **Period**: 60 seconds - **Timeout**: 30 seconds - **Failure Threshold**: 10 **Readiness Probe:** - **Type**: Exec command - **Command**: `curl -s http://localhost:${DYNAMO_PORT}/health | jq -e ".status == \"healthy\""` - **Initial Delay**: 60 seconds - **Period**: 60 seconds - **Timeout**: 30 seconds - **Failure Threshold**: 10 ### Worker Components Worker components receive the following probe configurations: **Liveness Probe:** - **Type**: HTTP GET - **Path**: `/live` - **Port**: `system` (9090) - **Period**: 5 seconds - **Timeout**: 30 seconds - **Failure Threshold**: 1 **Readiness Probe:** - **Type**: HTTP GET - **Path**: `/health` - **Port**: `system` (9090) - **Period**: 10 seconds - **Timeout**: 30 seconds - **Failure Threshold**: 60 **Startup Probe:** - **Type**: HTTP GET - **Path**: `/live` - **Port**: `system` (9090) - **Period**: 10 seconds - **Timeout**: 5 seconds - **Failure Threshold**: 720 (allows up to 2 hours for startup: 10s × 720 = 7200s) :::{note} For larger models (typically >70B parameters) or slower storage systems, you may need to increase the `failureThreshold` to allow more time for model loading. Calculate the required threshold based on your expected startup time: `failureThreshold = (expected_startup_seconds / period)`. Override the startup probe in your component specification if the default 2-hour window is insufficient. ::: ### Multinode Deployment Probe Modifications For multinode deployments, the operator modifies probes based on the backend framework and node role: #### VLLM Backend - **Worker nodes**: All probes (liveness, readiness, startup) are removed #### SGLang Backend - **Worker nodes**: All probes (liveness, readiness, startup) are removed #### TensorRT-LLM Backend - **Leader nodes**: All probes remain unchanged - **Worker nodes**: - Liveness and startup probes are removed - Readiness probe is replaced with a TCP socket check on SSH port (2222): - **Initial Delay**: 20 seconds - **Period**: 20 seconds - **Timeout**: 5 seconds - **Failure Threshold**: 10 ## Environment Variables The operator automatically injects environment variables based on component type and configuration: ### All Components - **`DYN_NAMESPACE`**: The Dynamo namespace for the component - **`DYN_PARENT_DGD_K8S_NAME`**: The parent DynamoGraphDeployment Kubernetes resource name - **`DYN_PARENT_DGD_K8S_NAMESPACE`**: The parent DynamoGraphDeployment Kubernetes namespace ### Frontend Components - **`DYNAMO_PORT`**: `8000` - **`DYN_HTTP_PORT`**: `8000` ### Worker Components - **`DYN_SYSTEM_ENABLED`**: `true` - **`DYN_SYSTEM_USE_ENDPOINT_HEALTH_STATUS`**: `["generate"]` - **`DYN_SYSTEM_PORT`**: `9090` ### Planner Components - **`PLANNER_PROMETHEUS_PORT`**: `9085` ### VLLM Backend (with compilation cache) When a volume mount is configured with `useAsCompilationCache: true`: - **`VLLM_CACHE_ROOT`**: Set to the mount point of the cache volume ## Service Account Planner components automatically receive the following service account: - **`serviceAccountName`**: `planner-serviceaccount` ## Image Pull Secrets The operator automatically discovers and injects image pull secrets for container images. When a component specifies a container image, the operator: 1. Scans all Kubernetes secrets of type `kubernetes.io/dockerconfigjson` in the component's namespace 2. Extracts the docker registry server URLs from each secret's authentication configuration 3. Matches the container image's registry host against the discovered registry URLs 4. Automatically injects matching secrets as `imagePullSecrets` in the pod specification This eliminates the need to manually specify image pull secrets for each component. The operator maintains an internal index of docker secrets and their associated registries, refreshing this index periodically. **To disable automatic image pull secret discovery** for a specific component, add the following annotation: ```yaml annotations: nvidia.com/disable-image-pull-secret-discovery: "true" ``` ## Autoscaling Defaults When autoscaling is enabled but no metrics are specified, the operator applies: - **Default Metric**: CPU utilization - **Target Average Utilization**: `80%` ## Port Configurations Default container ports are configured based on component type: ### Frontend Components - **Port**: 8000 - **Protocol**: TCP - **Name**: `http` ### Worker Components - **Port**: 9090 - **Protocol**: TCP - **Name**: `system` ### Planner Components - **Port**: 9085 - **Protocol**: TCP - **Name**: `metrics` ## Backend-Specific Configurations ### VLLM - **Ray Head Port**: 6379 (for multinode deployments) ### SGLang - **Distribution Init Port**: 29500 (for multinode deployments) ### TensorRT-LLM - **SSH Port**: 2222 (for multinode MPI communication) - **OpenMPI Environment**: `OMPI_MCA_orte_keep_fqdn_hostnames=1` ## Implementation Reference For users who want to understand the implementation details or contribute to the operator, the default values described in this document are set in the following source files: - **Health Probes & Pod Specifications**: [`internal/dynamo/graph.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/dynamo/graph.go) - Contains the main logic for applying default probes, environment variables, shared memory, and pod configurations - **Component-Specific Defaults**: - [`internal/dynamo/component_frontend.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/dynamo/component_frontend.go) - [`internal/dynamo/component_worker.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/dynamo/component_worker.go) - [`internal/dynamo/component_planner.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/dynamo/component_planner.go) - **Image Pull Secrets**: [`internal/secrets/docker.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/secrets/docker.go) - Implements the docker secret indexer and automatic discovery - **Backend-Specific Behavior**: - [`internal/dynamo/backend_vllm.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/dynamo/backend_vllm.go) - [`internal/dynamo/backend_sglang.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/dynamo/backend_sglang.go) - [`internal/dynamo/backend_trtllm.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/dynamo/backend_trtllm.go) - **Constants & Annotations**: [`internal/consts/consts.go`](https://github.com/ai-dynamo/dynamo/blob/main/deploy/cloud/operator/internal/consts/consts.go) - Defines annotation keys and other constants ## Notes - All these defaults can be overridden by explicitly specifying values in your DynamoComponentDeployment or DynamoGraphDeployment resources - User-specified probes (via `livenessProbe`, `readinessProbe`, or `startupProbe` fields) take precedence over operator defaults - For multinode deployments, some defaults are modified or removed as described above to accommodate distributed execution patterns - The `extraPodSpec.mainContainer` field can be used to override probe configurations set by the operator