⚠️ Important: This documentation is automatically generated from source code. Do not edit this file directly.

API Reference#

Packages#

nvidia.com/v1alpha1

nvidia.com/v1alpha1#

Package v1alpha1 contains API Schema definitions for the nvidia.com v1alpha1 API group.

Resource Types#

DynamoComponentDeployment
DynamoGraphDeployment

Autoscaling#

Appears in:

DynamoComponentDeploymentSharedSpec
DynamoComponentDeploymentSpec

Field	Description	Default	Validation
`enabled` boolean
`minReplicas` integer
`maxReplicas` integer
`behavior` HorizontalPodAutoscalerBehavior
`metrics` MetricSpec array

DynamoComponentDeployment#

DynamoComponentDeployment is the Schema for the dynamocomponentdeployments API

Field	Description	Default	Validation
`apiVersion` string	`nvidia.com/v1alpha1`
`kind` string	`DynamoComponentDeployment`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` DynamoComponentDeploymentSpec	Spec defines the desired state for this Dynamo component deployment.

DynamoComponentDeploymentSharedSpec#

Appears in:

DynamoComponentDeploymentSpec

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”).
`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 requested and limits for this component, including CPU, memory, GPUs/devices, and any runtime-specific resources.
`autoscaling` Autoscaling	Autoscaling config for this component (replica range, target utilization, etc.).
`envs` EnvVar 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.
`pvc` PVC	PVC config describing volumes to be mounted by the component.
`ingress` IngressSpec	Ingress config to expose the component outside the cluster (or through a service mesh).
`sharedMemory` SharedMemorySpec	SharedMemory controls the tmpfs mounted at /dev/shm (enable/disable and size).
`extraPodMetadata` ExtraPodMetadata	ExtraPodMetadata adds labels/annotations to the created Pods.
`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	LivenessProbe to detect and restart unhealthy containers.
`readinessProbe` Probe	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	Multinode is the configuration for multinode components.

DynamoComponentDeploymentSpec#

DynamoComponentDeploymentSpec defines the desired state of DynamoComponentDeployment

Appears in:

DynamoComponentDeployment

Field	Description	Validation
`dynamoComponent` string	DynamoComponent selects the Dynamo component from the archive to deploy. Typically corresponds to a component defined in the packaged Dynamo artifacts.
`dynamoTag` string	contains the tag of the DynamoComponent: for example, “my_package:MyService”
`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”).
`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 requested and limits for this component, including CPU, memory, GPUs/devices, and any runtime-specific resources.
`autoscaling` Autoscaling	Autoscaling config for this component (replica range, target utilization, etc.).
`envs` EnvVar 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.
`pvc` PVC	PVC config describing volumes to be mounted by the component.
`ingress` IngressSpec	Ingress config to expose the component outside the cluster (or through a service mesh).
`sharedMemory` SharedMemorySpec	SharedMemory controls the tmpfs mounted at /dev/shm (enable/disable and size).
`extraPodMetadata` ExtraPodMetadata	ExtraPodMetadata adds labels/annotations to the created Pods.
`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	LivenessProbe to detect and restart unhealthy containers.
`readinessProbe` Probe	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	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	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` DynamoGraphDeploymentSpec	Spec defines the desired state for this graph deployment.
`status` DynamoGraphDeploymentStatus	Status reflects the current observed state of this graph deployment.

DynamoGraphDeploymentSpec#

DynamoGraphDeploymentSpec defines the desired state of DynamoGraphDeployment.

Appears in:

DynamoGraphDeployment

Field	Description	Validation
`dynamoGraph` string	DynamoGraph selects the graph (workflow/topology) to deploy. This must match a graph name packaged with the Dynamo archive.
`envs` EnvVar array	Envs are environment variables applied to all services in the graph 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

Field	Description	Default	Validation
`state` string	State is a high-level textual status of the graph deployment lifecycle.
`conditions` Condition array	Conditions contains the latest observed conditions of the graph deployment. The slice is merged by type on patch updates.

IngressSpec#

Appears in:

DynamoComponentDeploymentSharedSpec
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	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

Field	Description	Default	Validation
`secretName` string	SecretName is the name of a Kubernetes Secret containing the TLS certificate and key.

MultinodeSpec#

Appears in:

DynamoComponentDeploymentSharedSpec
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:

DynamoComponentDeploymentSharedSpec
DynamoComponentDeploymentSpec

Field	Description	Default	Validation
`create` boolean	Create indicates to create a new PVC
`name` string	Name is the name of the PVC
`storageClass` string	StorageClass to be used for PVC creation. Leave it as empty if the PVC is already created.
`size` Quantity	Size of the NIM cache in Gi, used during PVC creation
`volumeAccessMode` PersistentVolumeAccessMode	VolumeAccessMode is the volume access mode of the PVC
`mountPoint` string

SharedMemorySpec#

Appears in:

DynamoComponentDeploymentSharedSpec
DynamoComponentDeploymentSpec

Field	Description	Default	Validation
`disabled` boolean
`size` Quantity