API Reference
Full Kubernetes CRD + operator-config API reference, generated from the operator Go types.
Auto-generated from source. This page is regenerated from the Dynamo operator CRDs by docs/fern/scripts/gen_kubernetes_api.py and covers every type across all three API packages: the deprecated nvidia.com/v1alpha1 surface, the supported nvidia.com/v1beta1 surface, and the operator’s own operator.config.dynamo.nvidia.com/v1alpha1 configuration. The trimmed DGD, DGDR, and DCD references cover only user-facing v1beta1 fields. To edit the surface, change the Go types under deploy/operator/api/ and let CI regenerate this page.
Dynamo publishes 3 Kubernetes API packages with 180 typed CRD and config sections.
nvidia.com/v1alpha1
Package v1alpha1 contains API Schema definitions for the nvidia.com v1alpha1 API group.
This package defines the DynamoGraphDeploymentRequest (DGDR) custom resource, which provides a high-level, SLA-driven interface for deploying machine learning models on Dynamo.
Package v1alpha1 contains API Schema definitions for the nvidia.com v1alpha1 API group.
Resource Types
Autoscaling
Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md for migration guidance. This field will be removed in a future API version.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Deprecated: This field is ignored.
Deprecated: This field is ignored.
Deprecated: This field is ignored.
Deprecated: This field is ignored. See HorizontalPodAutoscalerBehavior.
Deprecated: This field is ignored. See MetricSpec.
CheckpointDeletionPolicy
CheckpointDeletionPolicy defines what happens to DGD-managed automatic checkpoint resources when the owning DGD is deleted.
Kind: enum
Underlying type: string
Validation: Enum: [Delete Retain]
Appears in: ServiceCheckpointConfig
Allowed values
- Delete CheckpointDeletionPolicyDelete deletes DGD-managed automatic checkpoint<br />CRs and artifacts when the owning DGD is deleted.<br />
- Retain CheckpointDeletionPolicyRetain keeps DGD-managed automatic checkpoint CRs<br />and artifacts after the owning DGD is deleted. Users can reference the<br />retained checkpoint with checkpointRef if they accept compatibility risk.<br />
CheckpointMode
Deprecated: use checkpoint.enabled instead. enabled=true without checkpointRef creates a DGD-managed automatic checkpoint; checkpointRef restores the named checkpoint.
Kind: enum
Underlying type: string
Validation: Enum: [Auto Manual]
Appears in: ServiceCheckpointConfig
Allowed values
- Auto Deprecated: use checkpoint.enabled=true and omit checkpointRef.<br />
- Manual Deprecated: use checkpointRef to restore an existing checkpoint.<br />
CheckpointStartupPolicy
CheckpointStartupPolicy defines when worker pods should wait for a checkpoint.
Kind: enum
Underlying type: string
Validation: Enum: [Immediate WaitForCheckpoint]
Appears in: ServiceCheckpointConfig
Allowed values
- Immediate CheckpointStartupPolicyImmediate starts workers immediately. The checkpoint<br />job runs in the background, and only pods created after the checkpoint is<br />Ready are restore-shaped by the pod-create mutating webhook.<br />
- WaitForCheckpoint CheckpointStartupPolicyWaitForCheckpoint gates worker replicas until the<br />component’s checkpoint is Ready, then starts them from the checkpoint.<br />
ComponentKind
ComponentKind represents the type of underlying Kubernetes resource.
Kind: enum
Underlying type: string
Validation: Enum: [PodClique PodCliqueScalingGroup Deployment LeaderWorkerSet]
Appears in: ServiceReplicaStatus
Allowed values
- PodClique ComponentKindPodClique represents a PodClique resource.<br />
- PodCliqueScalingGroup ComponentKindPodCliqueScalingGroup represents a PodCliqueScalingGroup resource.<br />
- Deployment ComponentKindDeployment represents a Deployment resource.<br />
- LeaderWorkerSet ComponentKindLeaderWorkerSet represents a LeaderWorkerSet resource.<br />
ConfigMapKeySelector
ConfigMapKeySelector selects a specific key from a ConfigMap. Used to reference external configuration data stored in ConfigMaps.
Kind: type
Appears in: ProfilingConfigSpec
Name of the ConfigMap containing the desired data. Validation: Required: {} <br />
Key in the ConfigMap to select. If not specified, defaults to “disagg.yaml”.
DGDRState
Kind: enum
Underlying type: string
Validation: Enum: [Initializing Pending Profiling Deploying Ready DeploymentDeleted Failed]
Appears in: DynamoGraphDeploymentRequestStatus
Allowed values
- Initializing
- Pending
- Profiling
- Deploying
- Ready
- DeploymentDeleted
- Failed
DGDState
Kind: enum
Underlying type: string
Validation: Enum: [initializing pending successful failed]
Appears in: DeploymentStatus, DynamoGraphDeploymentStatus
Allowed values
- initializing
- pending
- successful
- failed
DeploymentOverridesSpec
DeploymentOverridesSpec allows users to customize metadata for auto-created DynamoGraphDeployments. When autoApply is enabled, these overrides are applied to the generated DGD resource.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
Name is the desired name for the created DynamoGraphDeployment.<br />If not specified, defaults to the DGDR name. Validation: Optional: {} <br />
Namespace is the desired namespace for the created DynamoGraphDeployment.<br />If not specified, defaults to the DGDR namespace. Validation: Optional: {} <br />
Labels are additional labels to add to the DynamoGraphDeployment metadata.<br />These are merged with auto-generated labels from the profiling process. Validation: Optional: {} <br />
Annotations are additional annotations to add to the DynamoGraphDeployment metadata. Validation: Optional: {} <br />
WorkersImage specifies the container image to use for DynamoGraphDeployment worker components.<br />This image is used for both temporary DGDs created during online profiling and the final DGD.<br />If omitted, the image from the base config file (e.g., disagg.yaml) is used.<br />Example: “nvcr.io/nvidia/ai-dynamo/vllm-runtime:1.2.1” Validation: Optional: {} <br />
DeploymentStatus
DeploymentStatus tracks the state of an auto-created DynamoGraphDeployment. This status is populated when autoApply is enabled and a DGD is created.
Kind: type
Appears in: DynamoGraphDeploymentRequestStatus
Name is the name of the created DynamoGraphDeployment.
Namespace is the namespace of the created DynamoGraphDeployment.
State is the current state of the DynamoGraphDeployment.<br />This value is mirrored from the DGD’s status.state field. See DGDState. Validation: Enum: [initializing pending successful failed] <br />
Created indicates whether the DGD has been successfully created.<br />Used to prevent recreation if the DGD is manually deleted by users.
DynamoCheckpoint
DynamoCheckpoint is the Schema for the dynamocheckpoints API It represents a container checkpoint that can be used to restore pods to a warm state
Kind: resource
nvidia.com/v1alpha1
DynamoCheckpoint
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
See DynamoCheckpointSpec.
DynamoCheckpointIdentity
Deprecated: legacy identity metadata. Keep it only where v1alpha1 still requires spec.identity; omit DGD-managed identity and use checkpointRef for explicit restores.
Kind: type
Appears in: DynamoCheckpointSpec, ServiceCheckpointConfig
Model is the model identifier (e.g., “meta-llama/Llama-3-70B”)<br />Deprecated: legacy spec.identity only. Validation: Required: {} <br />
BackendFramework is the runtime framework (vllm, sglang, trtllm)<br />Deprecated: legacy spec.identity only. Validation: Enum: [vllm sglang trtllm] <br />Required: {} <br />
DynamoVersion is the Dynamo platform version (optional).<br />Deprecated: legacy spec.identity only. Validation: Optional: {} <br />
TensorParallelSize is the tensor parallel configuration.<br />Deprecated: checkpoint launch uses the pod template instead. Validation: Minimum: 1 <br />Optional: {} <br />
PipelineParallelSize is the pipeline parallel configuration.<br />Deprecated: checkpoint launch uses the pod template instead. Validation: Minimum: 1 <br />Optional: {} <br />
Dtype is the data type (fp16, bf16, fp8, etc.).<br />Deprecated: legacy spec.identity only. Validation: Optional: {} <br />
MaxModelLen is the maximum sequence length.<br />Deprecated: legacy spec.identity only. Validation: Minimum: 1 <br />Optional: {} <br />
ExtraParameters are additional parameters that affect the checkpoint hash.<br />Use for any framework-specific or custom parameters not covered above.<br />Deprecated: legacy spec.identity only. Validation: Optional: {} <br />
DynamoCheckpointJobConfig
DynamoCheckpointJobConfig defines the configuration for the checkpoint creation Job
Kind: type
Appears in: DynamoCheckpointSpec
PodTemplateSpec allows customizing the checkpoint Job pod<br />This should include the container that runs the workload to be checkpointed<br />and any workload/runtime env, service account, GMS, or DRA wiring needed<br />by that container. Auto-created checkpoints from DynamoGraphDeployment<br />render Dynamo defaults before creating the DynamoCheckpoint. See PodTemplateSpec. Validation: Required: {} <br />
TargetContainerName is the container in PodTemplateSpec to snapshot.
Validation: MaxLength: 63 <br />MinLength: 1 <br />Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />Optional: {} <br />
SharedMemory controls the tmpfs mounted at /dev/shm for the checkpoint Job pod.<br />When omitted, checkpoint Jobs use the same default 8Gi tmpfs as Dynamo components. See SharedMemorySpec. Validation: Optional: {} <br />
ActiveDeadlineSeconds specifies the maximum time the Job can run Validation: Minimum: 1 <br />Optional: {} <br />
Deprecated: BackoffLimit is ignored. Checkpoint Jobs never retry. Validation: Minimum: 0 <br />Optional: {} <br />
Deprecated: TTLSecondsAfterFinished is ignored. The operator deletes checkpoint<br />Jobs after recording their terminal outcome. Validation: Minimum: 0 <br />Optional: {} <br />
DynamoCheckpointPhase
DynamoCheckpointPhase represents the current phase of the checkpoint lifecycle
Kind: enum
Underlying type: string
Validation: Enum: [Pending Creating Ready Failed]
Appears in: DynamoCheckpointStatus
Allowed values
- Pending DynamoCheckpointPhasePending indicates the checkpoint CR has been created but the Job has not started<br />
- Creating DynamoCheckpointPhaseCreating indicates the checkpoint Job is running<br />
- Ready DynamoCheckpointPhaseReady indicates the checkpoint artifact is available<br />
- Failed DynamoCheckpointPhaseFailed indicates the checkpoint creation failed<br />
DynamoCheckpointSpec
DynamoCheckpointSpec defines the desired state of DynamoCheckpoint
Kind: type
Appears in: DynamoCheckpoint
Deprecated: required by v1alpha1 for standalone checkpoints. Auto<br />checkpoints synthesize it; checkpointRef restores use the referenced CR. See DynamoCheckpointIdentity. Validation: Required: {} <br />
GPUMemoryService records checkpoint-time GPU Memory Service metadata for<br />a prepared checkpoint Job pod. The DynamoCheckpoint controller does not<br />inject GMS/DRA resources; auto-created checkpoints from<br />DynamoGraphDeployment prepare the pod template before creating this object.<br />Manual GMS-enabled checkpoints must provide the prepared pod template; the<br />controller fails the checkpoint if the required GMS/DRA wiring is missing.<br />This field is intentionally outside spec.identity, so it does not affect<br />the checkpoint identity hash or deduplication. See GPUMemoryServiceSpec. Validation: Optional: {} <br />
Job defines the configuration for the checkpoint creation Job See DynamoCheckpointJobConfig. Validation: Required: {} <br />
DynamoCheckpointStatus
DynamoCheckpointStatus defines the observed state of DynamoCheckpoint
Kind: type
Appears in: DynamoCheckpoint
Phase represents the current phase of the checkpoint lifecycle See DynamoCheckpointPhase. Validation: Enum: [Pending Creating Ready Failed] <br />Optional: {} <br />
CheckpointID is the artifact ID used by the snapshot protocol. Validation: Optional: {} <br />
IdentityHash is the computed hash of the checkpoint identity.<br />Deprecated: use CheckpointID. This field is retained for compatibility<br />with older status consumers. Validation: Optional: {} <br />
Deprecated: Location is ignored and no longer populated. It is retained<br />only so older objects continue to validate. Validation: Optional: {} <br />
Deprecated: StorageType is ignored and no longer populated. It is retained<br />only so older objects continue to validate. See DynamoCheckpointStorageType. Validation: Enum: [pvc s3 oci] <br />Optional: {} <br />
JobName is the name of the checkpoint creation Job Validation: Optional: {} <br />
PodSnapshotName is the name of the PodSnapshot this checkpoint created to drive capture. It is<br />the authoritative pointer to the snapshot (which is otherwise located by label, not by<br />reconstructing its name) and lets the controller distinguish a never-created snapshot (empty)<br />from one that was created and later went missing (set, but no longer found). Validation: Optional: {} <br />
CreatedAt is the timestamp when the checkpoint became ready See Time. Validation: Optional: {} <br />
Message provides additional information about the current state Validation: Optional: {} <br />
DEPRECATED: Conditions are deprecated. Use status.phase instead. See Condition. Validation: Optional: {} <br />
DynamoCheckpointStorageType
Deprecated: StorageType is retained for compatibility with older DynamoCheckpoint status consumers. The current checkpoint flow publishes PVC-backed artifacts discovered from the snapshot-agent DaemonSet.
Kind: type
Underlying type: string
Validation: Enum: [pvc s3 oci]
Appears in: DynamoCheckpointStatus
DynamoComponentDeployment
DynamoComponentDeployment is the Schema for the dynamocomponentdeployments API
Kind: resource
nvidia.com/v1alpha1
DynamoComponentDeployment
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
Spec defines the desired state for this Dynamo component deployment. See DynamoComponentDeploymentSpec.
DynamoComponentDeploymentSpec
DynamoComponentDeploymentSpec defines the desired state of DynamoComponentDeployment
Kind: type
Appears in: DynamoComponentDeployment
BackendFramework specifies the backend framework (e.g., “sglang”, “vllm”, “trtllm”) Validation: Enum: [sglang vllm trtllm] <br />
Annotations to add to generated Kubernetes resources for this component<br />(such as Pod, Service, and Ingress when applicable).
Labels to add to generated Kubernetes resources for this component.
The name of the component
ComponentType indicates the role of this component (for example, “main”).
SubComponentType indicates the sub-role of this component (for example, “prefill”).
GlobalDynamoNamespace indicates that the Component will be placed in the global Dynamo namespace
Resources requested and limits for this component, including CPU, memory,<br />GPUs/devices, and any runtime-specific resources. See Resources.
Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter<br />with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md<br />for migration guidance. This field will be removed in a future API version. See Autoscaling.
Envs defines additional environment variables to inject into the component containers. See EnvVar.
EnvFromSecret references a Secret whose key/value pairs will be exposed as<br />environment variables in the component containers.
VolumeMounts references PVCs defined at the top level for volumes to be mounted by the component. See VolumeMount.
Ingress config to expose the component outside the cluster (or through a service mesh). See IngressSpec.
ModelRef references a model that this component serves<br />When specified, a headless service will be created for endpoint discovery See ModelReference. Validation: Optional: {} <br />
SharedMemory controls the tmpfs mounted at /dev/shm (enable/disable and size). See SharedMemorySpec.
ExtraPodMetadata adds labels/annotations to the created Pods. See ExtraPodMetadata. Validation: Optional: {} <br />
ExtraPodSpec allows to override the main pod spec configuration.<br />It is a k8s standard PodSpec. It also contains a MainContainer (standard k8s Container) field<br />that allows overriding the main container configuration. See ExtraPodSpec. Validation: Optional: {} <br />
LivenessProbe to detect and restart unhealthy containers. See Probe.
ReadinessProbe to signal when the container is ready to receive traffic. See Probe.
Replicas is the desired number of Pods for this component.<br />When scalingAdapter is enabled, this field is managed by the<br />DynamoGraphDeploymentScalingAdapter and should not be modified directly. Validation: Minimum: 0 <br />
MinAvailable maps to Grove PodClique minAvailable for single-node and<br />Grove PodCliqueScalingGroup minAvailable for multi-node components.<br />This field determines 1) the minimum number of replicas guaranteed to be<br />gang-scheduled, and 2) when violating minAvailable replicas triggers gang<br />termination.<br />For Grove-backed DynamoGraphDeployment components, minAvailable defaults to<br />1 when omitted and is immutable after creation. Positive replica counts must<br />be greater than or equal to minAvailable. Replicas may be scaled to 0 as a<br />special scale-to-zero state; minAvailable remains configured but is not<br />enforced again until replicas is scaled back to a positive value.<br />For non-Grove deployments, setting this field will result in a validation error. Validation: Minimum: 1 <br />Optional: {} <br />
Multinode is the configuration for multinode components. See MultinodeSpec.
ScalingAdapter configures whether this service uses the DynamoGraphDeploymentScalingAdapter.<br />When enabled, replicas are managed via DGDSA and external autoscalers can scale<br />the service using the Scale subresource. When disabled, replicas can be modified directly. See ScalingAdapter. Validation: Optional: {} <br />
EPPConfig defines EPP-specific configuration options for Endpoint Picker Plugin components.<br />Only applicable when ComponentType is “epp”. See EPPConfig. Validation: Optional: {} <br />
FrontendSidecar configures an auto-generated frontend sidecar container.<br />When specified, the operator injects a fully configured frontend container<br />with all standard Dynamo environment variables, health probes, and ports.<br />This eliminates the need to manually specify these in extraPodSpec.containers. (GAIE) See FrontendSidecarSpec. Validation: Optional: {} <br />
Checkpoint configures container checkpointing for this service.<br />When enabled, pods can be restored from a checkpoint files for faster cold start. See ServiceCheckpointConfig. Validation: Optional: {} <br />
TopologyConstraint for this service. packDomain is required.<br />When both this and spec.topologyConstraint.packDomain are set, packDomain<br />must be narrower than or equal to the spec-level packDomain. See TopologyConstraint. Validation: Optional: {} <br />
GPUMemoryService configures the GPU Memory Service (GMS) sidecar.<br />When enabled, a GMS sidecar is injected and GPU access is managed via DRA. See GPUMemoryServiceSpec. Validation: Optional: {} <br />
Failover configures GMS (GPU Memory Service) failover for this service.<br />For intraPod mode: the main container is cloned into two engine containers (active + standby).<br />For interPod mode: the operator creates a dedicated GMS weight server pod and<br />multiple engine pods per rank that share GPUs via DRA resource claims. See FailoverSpec. Validation: Optional: {} <br />
DynamoGraphDeployment
DynamoGraphDeployment is the Schema for the dynamographdeployments API.
Kind: resource
nvidia.com/v1alpha1
DynamoGraphDeployment
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
Spec defines the desired state for this graph deployment. See DynamoGraphDeploymentSpec.
Status reflects the current observed state of this graph deployment. See DynamoGraphDeploymentStatus.
DynamoGraphDeploymentExperimentalSpec
DynamoGraphDeploymentExperimentalSpec groups graph-level opt-in preview features. Component-level experimental features are represented separately on component specs.
Kind: type
Appears in: DynamoGraphDeploymentSpec
KvTransferPolicy configures topology-aware routing for KV-cache<br />transfers between prefill and decode workers. See KvTransferPolicy. Validation: Optional: {} <br />
DynamoGraphDeploymentRequest
DynamoGraphDeploymentRequest is the Schema for the dynamographdeploymentrequests API. It serves as the primary interface for users to request model deployments with specific performance and resource constraints, enabling SLA-driven deployments.
Lifecycle:
- Initializing → Pending: Validates spec and prepares for profiling
- Pending → Profiling: Creates and runs profiling job (online or AIC)
- Profiling → Ready/Deploying: Generates DGD spec after profiling completes
- Deploying → Ready: When autoApply=true, monitors DGD until Ready
- Ready: Terminal state when DGD is operational or spec is available
- DeploymentDeleted: Terminal state when auto-created DGD is manually deleted
The spec becomes immutable once profiling starts. Users must delete and recreate the DGDR to modify configuration after this point.
DEPRECATION NOTICE: v1alpha1 DynamoGraphDeploymentRequest is deprecated. Please migrate to nvidia.com/v1beta1 DynamoGraphDeploymentRequest. v1alpha1 will be removed in a future release.
Kind: resource
nvidia.com/v1alpha1
DynamoGraphDeploymentRequest
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
Spec defines the desired state for this deployment request. See DynamoGraphDeploymentRequestSpec.
Status reflects the current observed state of this deployment request. See DynamoGraphDeploymentRequestStatus.
DynamoGraphDeploymentRequestSpec
DynamoGraphDeploymentRequestSpec defines the desired state of a DynamoGraphDeploymentRequest. This CRD serves as the primary interface for users to request model deployments with specific performance constraints and resource requirements, enabling SLA-driven deployments.
Kind: type
Appears in: DynamoGraphDeploymentRequest
Model specifies the model to deploy (e.g., “Qwen/Qwen3-0.6B”, “meta-llama/Llama-3-70b”).<br />This is a high-level identifier for easy reference in kubectl output and logs.<br />The controller automatically sets this value in profilingConfig.config.deployment.model. Validation: Required: {} <br />
Backend specifies the inference backend for profiling.<br />The controller automatically sets this value in profilingConfig.config.engine.backend.<br />Profiling runs on real GPUs or via AIC simulation to collect performance data. Validation: Enum: [auto vllm sglang trtllm] <br />Required: {} <br />
UseMocker indicates whether to deploy a mocker DynamoGraphDeployment instead of<br />a real backend deployment. When true, the deployment uses simulated engines that<br />don’t require GPUs, using the profiling data to simulate realistic timing behavior.<br />Mocker is available in all backend images and useful for large-scale experiments.<br />Profiling still runs against the real backend (specified above) to collect performance data.
ProfilingConfig provides the complete configuration for the profiling job.<br />Note: GPU discovery is automatically attempted to detect GPU resources from Kubernetes<br />cluster nodes. If the operator has node read permissions (cluster-wide or explicitly granted),<br />discovered GPU configuration is used as defaults when hardware configuration is not manually<br />specified (minNumGpusPerEngine, maxNumGpusPerEngine, numGpusPerNode). User-specified values<br />always take precedence over auto-discovered values. If GPU discovery fails (e.g.,<br />namespace-restricted operator without node permissions), manual hardware config is required.<br />This configuration is passed directly to the profiler.<br />The structure matches the profile_sla config format exactly (see ProfilingConfigSpec for schema).<br />Note: deployment.model and engine.backend are automatically set from the high-level<br />modelName and backend fields and should not be specified in this config. See ProfilingConfigSpec. Validation: Required: {} <br />
EnableGPUDiscovery controls whether the operator attempts to discover GPU hardware from cluster nodes.<br />DEPRECATED: This field is deprecated and will be removed in v1beta1. GPU discovery is now always<br />attempted automatically. Setting this field has no effect - the operator will always try to discover<br />GPU hardware when node read permissions are available. If discovery is unavailable (e.g., namespace-scoped<br />operator without permissions), manual hardware configuration is required regardless of this setting. Validation: Optional: {} <br />
AutoApply indicates whether to automatically create a DynamoGraphDeployment<br />after profiling completes. If false, only the spec is generated and stored in status.<br />Users can then manually create a DGD using the generated spec.
DeploymentOverrides allows customizing metadata for the auto-created DGD.<br />Only applicable when AutoApply is true. See DeploymentOverridesSpec. Validation: Optional: {} <br />
DynamoGraphDeploymentRequestStatus
DynamoGraphDeploymentRequestStatus represents the observed state of a DynamoGraphDeploymentRequest. The controller updates this status as the DGDR progresses through its lifecycle.
Kind: type
Appears in: DynamoGraphDeploymentRequest
State is a high-level textual status of the deployment request lifecycle. See DGDRState. Validation: Enum: [Initializing Pending Profiling Deploying Ready DeploymentDeleted Failed] <br />
Backend is extracted from profilingConfig.config.engine.backend for display purposes.<br />This field is populated by the controller and shown in kubectl output. Validation: Optional: {} <br />
ObservedGeneration reflects the generation of the most recently observed spec.<br />Used to detect spec changes and enforce immutability after profiling starts.
Conditions contains the latest observed conditions of the deployment request.<br />Standard condition types include: Validation, Profiling, SpecGenerated, DeploymentReady.<br />Conditions are merged by type on patch updates. See Condition.
ProfilingResults contains a reference to the ConfigMap holding profiling data.<br />Format: “configmap/<name>” Validation: Optional: {} <br />
GeneratedDeployment contains the full generated DynamoGraphDeployment specification<br />including metadata, based on profiling results. Users can extract this to create<br />a DGD manually, or it’s used automatically when autoApply is true.<br />Stored as RawExtension to preserve all fields including metadata.<br />For mocker backends, this contains the mocker DGD spec. See RawExtension. Validation: EmbeddedResource: {} <br />Optional: {} <br />
Deployment tracks the auto-created DGD when AutoApply is true.<br />Contains name, namespace, state, and creation status of the managed DGD. See DeploymentStatus. Validation: Optional: {} <br />
DynamoGraphDeploymentScalingAdapter
DynamoGraphDeploymentScalingAdapter provides a scaling interface for individual services within a DynamoGraphDeployment. It implements the Kubernetes scale subresource, enabling integration with HPA, KEDA, and custom autoscalers.
The adapter acts as an intermediary between autoscalers and the DGD, ensuring that only the adapter controller modifies the DGD’s service replicas. This prevents conflicts when multiple autoscaling mechanisms are in play.
Kind: resource
nvidia.com/v1alpha1
DynamoGraphDeploymentScalingAdapter
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
DynamoGraphDeploymentScalingAdapterSpec
DynamoGraphDeploymentScalingAdapterSpec defines the desired state of DynamoGraphDeploymentScalingAdapter
Kind: type
Appears in: DynamoGraphDeploymentScalingAdapter
Replicas is the desired number of replicas for the target service.<br />This field is modified by external autoscalers (HPA/KEDA/Planner) or manually by users. Validation: Minimum: 0 <br />Required: {} <br />
DGDRef references the DynamoGraphDeployment and the specific service to scale. See DynamoGraphDeploymentServiceRef. Validation: Required: {} <br />
DynamoGraphDeploymentScalingAdapterStatus
DynamoGraphDeploymentScalingAdapterStatus defines the observed state of DynamoGraphDeploymentScalingAdapter
Kind: type
Appears in: DynamoGraphDeploymentScalingAdapter
Replicas is the current number of replicas for the target service.<br />This is synced from the DGD’s service replicas and is required for the scale subresource. Validation: Optional: {} <br />
Selector is a label selector string for the pods managed by this adapter.<br />Required for HPA compatibility via the scale subresource. Validation: Optional: {} <br />
LastScaleTime is the last time the adapter scaled the target service. See Time. Validation: Optional: {} <br />
DynamoGraphDeploymentServiceRef
DynamoGraphDeploymentServiceRef identifies a specific service within a DynamoGraphDeployment
Kind: type
Appears in: DynamoGraphDeploymentScalingAdapterSpec
Name of the DynamoGraphDeployment Validation: MinLength: 1 <br />Required: {} <br />
ServiceName is the key name of the service within the DGD’s spec.services map to scale Validation: MinLength: 1 <br />Required: {} <br />
DynamoGraphDeploymentSpec
DynamoGraphDeploymentSpec defines the desired state of DynamoGraphDeployment.
Kind: type
Appears in: DynamoGraphDeployment
Annotations to propagate to all child resources (PCS, DCD, Deployments, and pod templates).<br />Service-level annotations take precedence over these values. Validation: Optional: {} <br />
Labels to propagate to all child resources (PCS, DCD, Deployments, and pod templates).<br />Service-level labels take precedence over these values. Validation: Optional: {} <br />
PriorityClassName is the name of the PriorityClass to use for Grove PodCliqueSets.<br />Requires the Grove pathway. Validation: Optional: {} <br />
PVCs defines a list of persistent volume claims that can be referenced by components.<br />Each PVC must have a unique name that can be referenced in component specifications. See PVC. Validation: MaxItems: 100 <br />Optional: {} <br />
Services are the services to deploy as part of this deployment. See DynamoComponentDeploymentSharedSpec. Validation: MaxProperties: 25 <br />Optional: {} <br />
Envs are environment variables applied to all services in the deployment unless<br />overridden by service-specific configuration. See EnvVar. Validation: Optional: {} <br />
BackendFramework specifies the backend framework (e.g., “sglang”, “vllm”, “trtllm”). Validation: Enum: [sglang vllm trtllm] <br />
Restart specifies the restart policy for the graph deployment. See Restart. Validation: Optional: {} <br />
TopologyConstraint is the deployment-level topology constraint.<br />When set, topologyProfile is required and names the ClusterTopology CR to use.<br />packDomain is optional here — it can be omitted when only services carry constraints.<br />Services without their own topologyConstraint inherit from this value. See SpecTopologyConstraint. Validation: Optional: {} <br />
Experimental groups graph-level preview features whose API shape and<br />behavior may change in breaking ways between releases. See DynamoGraphDeploymentExperimentalSpec. Validation: Optional: {} <br />
DynamoGraphDeploymentStatus
DynamoGraphDeploymentStatus defines the observed state of DynamoGraphDeployment.
Kind: type
Appears in: DynamoGraphDeployment
ObservedGeneration is the most recent generation observed by the controller. Validation: Optional: {} <br />
State is a high-level textual status of the graph deployment lifecycle. See DGDState. Validation: Enum: [initializing pending successful failed] <br />
Conditions contains the latest observed conditions of the graph deployment.<br />The slice is merged by type on patch updates. See Condition.
Services contains per-service replica status information.<br />The map key is the service name from spec.services. See ServiceReplicaStatus. Validation: Optional: {} <br />
Restart contains the status of the restart of the graph deployment. See RestartStatus. Validation: Optional: {} <br />
Checkpoints contains per-service checkpoint status information.<br />The map key is the service name from spec.services. See ServiceCheckpointStatus. Validation: Optional: {} <br />
RollingUpdate tracks the progress of operator manged rolling updates.<br />Currently only supported for singl-node, non-Grove deployments (DCD/Deployment). See RollingUpdateStatus. Validation: Optional: {} <br />
Placement groups DGD-level scheduler placement signals (score, reporting<br />state, and any future placement fields). See PlacementStatus. Validation: Optional: {} <br />
DynamoModel
DynamoModel is the Schema for the dynamo models API
Kind: resource
nvidia.com/v1alpha1
DynamoModel
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
See DynamoModelSpec.
See DynamoModelStatus.
DynamoModelSpec
DynamoModelSpec defines the desired state of DynamoModel
Kind: type
Appears in: DynamoModel
ModelName is the full model identifier (e.g., “meta-llama/Llama-3.3-70B-Instruct-lora”) Validation: Required: {} <br />
BaseModelName is the base model identifier that matches the service label<br />This is used to discover endpoints via headless services Validation: Required: {} <br />
ModelType specifies the type of model (e.g., “base”, “lora”, “adapter”) Validation: Enum: [base lora adapter] <br />Optional: {} <br />
Source specifies the model source location (only applicable for lora model type) See ModelSource. Validation: Optional: {} <br />
DynamoModelStatus
DynamoModelStatus defines the observed state of DynamoModel
Kind: type
Appears in: DynamoModel
Endpoints is the current list of all endpoints for this model See EndpointInfo. Validation: Optional: {} <br />
ReadyEndpoints is the count of endpoints that are ready
LoRAFallbackCoveredEndpoints is the count of legacy prefill endpoints<br />covered by a capable prefill during a rolling upgrade. These endpoints are<br />excluded from ReadyEndpoints because they cannot serve the adapter directly. Validation: Optional: {} <br />
TotalEndpoints is the total count of endpoints
Conditions represents the latest available observations of the model’s state See Condition. Validation: Optional: {} <br />
EPPConfig
EPPConfig contains configuration for EPP (Endpoint Picker Plugin) components. EPP is responsible for intelligent endpoint selection and KV-aware routing.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
ConfigMapRef references a user-provided ConfigMap containing EPP configuration.<br />The ConfigMap should contain EndpointPickerConfig YAML.<br />Mutually exclusive with Config. See ConfigMapKeySelector. Validation: Optional: {} <br />
Config allows specifying EPP EndpointPickerConfig directly as a structured object.<br />The operator will marshal this to YAML and create a ConfigMap automatically.<br />Mutually exclusive with ConfigMapRef.<br />One of ConfigMapRef or Config must be specified (no default configuration).<br />Uses the upstream type from github.com/kubernetes-sigs/gateway-api-inference-extension Validation: Type: object <br />Optional: {} <br />
EndpointInfo
EndpointInfo represents a single endpoint (pod) serving the model
Kind: type
Appears in: DynamoModelStatus
Address is the full address of the endpoint (e.g., “http://10.0.1.5:9090”)
PodName is the name of the pod serving this endpoint Validation: Optional: {} <br />
Ready indicates whether this endpoint is ready to serve traffic.<br />For LoRA models: true only if this endpoint’s lifecycle request succeeded.<br />For base models: always false (no probing performed).
LoRAFallbackCovered indicates a legacy prefill endpoint that cannot manage<br />LoRAs itself is covered by a capable prefill in the same topology during a<br />rolling upgrade. It does not make this endpoint ready to serve the adapter. Validation: Optional: {} <br />
ExtraPodMetadata
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
ExtraPodSpec
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
See Container.
FailoverSpec
FailoverSpec configures active-passive failover for a worker component. For intraPod mode: requires gpuMemoryService.enabled; the main container is cloned into engine containers (active + standby) within the same pod. For interPod mode: the operator creates a dedicated GMS weight server pod and multiple engine pods per rank that share GPUs via DRA resource claims.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Enabled activates failover mode.
Mode selects the failover deployment topology.<br />intraPod: engine containers run within the same pod (requires gpuMemoryService.enabled).<br />interPod: a dedicated GMS weight server pod + engine pods per rank (requires Grove). See GPUMemoryServiceMode. Validation: Enum: [intraPod interPod] <br />Optional: {} <br />
NumShadows is the number of shadow (standby) engine pods per rank.<br />Total engine pods per rank = NumShadows + 1 (1 primary + NumShadows shadows).<br />NumShadows is only meaningful for mode=interPod; intraPod uses a fixed<br />1 primary + 1 shadow sidecar layout and any value other than 1 is<br />rejected at admission time. Validation: Minimum: 1 <br />Optional: {} <br />
FrontendSidecarSpec
FrontendSidecarSpec configures the auto-generated frontend sidecar container. The operator uses these fields together with built-in frontend defaults (command, probes, ports, and Dynamo env vars) to produce a fully configured sidecar container.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Image is the container image for the frontend sidecar. Validation: Required: {} <br />
Args overrides the default frontend arguments. When specified, these replace<br />the default [“-m”, “dynamo.frontend”] entirely.<br />For example, [“-m”, “dynamo.frontend”, “—router-mode”, “direct”] for GAIE deployments. Validation: Optional: {} <br />
EnvFromSecret references a Secret whose key/value pairs will be exposed as<br />environment variables in the frontend sidecar container. Validation: Optional: {} <br />
Envs defines additional environment variables for the frontend sidecar.<br />These are merged with (and can override) the auto-generated Dynamo env vars. See EnvVar. Validation: Optional: {} <br />
GMSClientPodSpec
GMSClientPodSpec declares an additional GMS client pod for inter-pod GMS.
Kind: type
Appears in: GPUMemoryServiceSpec
Name identifies this client pod.
Validation: MaxLength: 63 <br />MinLength: 1 <br />Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />
PodTemplate configures the pod to run as a GMS client. See PodTemplateSpec. Validation: Schemaless: {} <br />Type: object <br />
GPUMemoryServiceMode
GPUMemoryServiceMode selects the GMS deployment topology.
Kind: enum
Underlying type: string
Appears in: FailoverSpec, GPUMemoryServiceSpec
Allowed values
- intraPod GMSModeIntraPod runs GMS as a sidecar within the same pod.<br />
- interPod GMSModeInterPod runs GMS as a separate weight server pod and one or more<br />engine pods per rank, sharing GPUs via DRA ResourceClaims and a shared<br />hostPath volume for UDS sockets. Extra client pod rendering is reserved<br />for a follow-up change.<br />
GPUMemoryServiceSpec
GPUMemoryServiceSpec configures the GPU Memory Service (GMS) for a worker component.
Kind: type
Appears in: DynamoCheckpointSpec, DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Enabled activates GMS wiring. GPU resources on client containers are<br />replaced with a DRA ResourceClaim for shared GPU access.
Mode selects the GMS deployment topology. See GPUMemoryServiceMode. Validation: Enum: [intraPod interPod] <br />Optional: {} <br />
DeviceClassName is the DRA DeviceClass to request GPUs from. Validation: Optional: {} <br />
ExtraClientContainers lists additional user-declared containers that should<br />be wired as GMS clients in pods rendered from the enclosing spec.<br />DGD/DCD services apply this to service pods. Auto-created checkpoints<br />apply checkpoint job clients before creating the DynamoCheckpoint; manual<br />DynamoCheckpoint users must provide an already-prepared pod template.<br />In each rendered pod, only matching container names are wired; absent<br />names are ignored.
Validation: items:MaxLength: 63 <br />items:MinLength: 1 <br />items:Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />Optional: {} <br />
ExtraClientPods declares additional GMS client pods for inter-pod GMS. This field is<br />reserved for future use and is rejected until inter-pod client orchestration is wired. See GMSClientPodSpec. Validation: Optional: {} <br />
IngressSpec
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Enabled exposes the component through an ingress or virtual service when true.
Host is the base host name to route external traffic to this component.
UseVirtualService indicates whether to configure a service-mesh VirtualService instead of a standard Ingress.
VirtualServiceGateway optionally specifies the gateway name to attach the VirtualService to.
HostPrefix is an optional prefix added before the host.
Annotations to set on the generated Ingress/VirtualService resources.
Labels to set on the generated Ingress/VirtualService resources.
TLS holds the TLS configuration used by the Ingress/VirtualService. See IngressTLSSpec.
HostSuffix is an optional suffix appended after the host.
IngressControllerClassName selects the ingress controller class (e.g., “nginx”).
IngressTLSSpec
Kind: type
Appears in: IngressSpec
SecretName is the name of a Kubernetes Secret containing the TLS certificate and key.
KvTransferEnforcement
KvTransferEnforcement controls how the selected prefill worker’s topology is applied to decode routing.
Kind: enum
Underlying type: string
Validation: Enum: [required preferred]
Appears in: KvTransferPolicy
Allowed values
- required KvTransferEnforcementRequired enforces same-domain decode worker<br />selection.<br />
- preferred KvTransferEnforcementPreferred biases decode worker selection toward the<br />same domain.<br />
KvTransferPolicy
KvTransferPolicy configures topology-aware routing for KV-cache transfers
between prefill and decode workers. This graph-wide policy lives under
spec.experimental while the API is incubating.
Kind: type
Appears in: DynamoGraphDeploymentExperimentalSpec
ClusterTopologyName references a Grove ClusterTopology CR. The operator<br />reads the CR’s topology levels and projects them through Dynamo-owned pod<br />labels for worker topology metadata. Validation: MinLength: 1 <br />Optional: {} <br />
LabelKey is a Kubernetes node label key (e.g.<br />“topology.kubernetes.io/zone”) whose value identifies the topology<br />domain for each worker. The operator copies the node label onto worker<br />pods so the runtime can publish it as worker metadata. The label<br />should correspond to the topology level named in domain.
Validation: MaxLength: 317 <br />MinLength: 1 <br />Pattern: ^(([a-z0-9]([-a-z0-9]\{0,61\}[a-z0-9])?)(\.[a-z0-9]([-a-z0-9]\{0,61\}[a-z0-9])?)*/)?([A-Za-z0-9]([-A-Za-z0-9_.]\{0,61\}[A-Za-z0-9])?)$ <br />Optional: {} <br />
Domain is the logical name for the topology level to enforce<br />(e.g. “zone”, “rack”). The router uses this to match workers that<br />share the same value for the label identified by labelKey.
See TopologyDomain.
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ <br />
Enforcement controls how the selected prefill worker’s topology is<br />applied to decode routing. “required” only allows decode workers in the<br />same topology domain as the selected prefill worker. “preferred” keeps<br />all decode workers eligible, but biases selection toward workers in the<br />same topology domain. Defaults to “required”. See KvTransferEnforcement. Validation: Enum: [required preferred] <br />Optional: {} <br />
PreferredWeight is required and used only when enforcement is<br />“preferred”. Higher values create a stronger same-domain routing<br />preference, but do not guarantee same-domain selection. The value is not<br />a probability; worker selection still depends on load and other routing<br />inputs. A value of 0 disables the topology preference; 1 is the strongest<br />supported preference. Validation: Maximum: 1 <br />Minimum: 0 <br />Optional: {} <br />
ModelReference
ModelReference identifies a model served by this component
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Name is the base model identifier (e.g., “llama-3-70b-instruct-v1”) Validation: Required: {} <br />
Revision is the model revision/version (optional) Validation: Optional: {} <br />
ModelSource
ModelSource defines the source location of a model
Kind: type
Appears in: DynamoModelSpec
URI is the model source URI<br />Supported formats:<br />- S3: s3://bucket/path/to/model<br />- HuggingFace: hf://org/model@revision_sha<br />- Local filesystem: file:///path/to/model Validation: Required: {} <br />
MultinodeSpec
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Indicates the number of nodes to deploy for multinode components.<br />Total number of GPUs is NumberOfNodes * GPU limit.<br />Must be greater than 1. Validation: Minimum: 2 <br />
PVC
Kind: type
Appears in: DynamoGraphDeploymentSpec
Create indicates to create a new PVC
Name is the name of the PVC Validation: Required: {} <br />
StorageClass to be used for PVC creation. Required when create is true.
Size of the volume in Gi, used during PVC creation. Required when create is true. See Quantity.
VolumeAccessMode is the volume access mode of the PVC. Required when create is true. See PersistentVolumeAccessMode.
PlacementScoreState
PlacementScoreState describes whether placement score is available and how complete the reported score is for a graph deployment. See the v1beta1 PlacementScoreState for the authoritative semantics of each value.
Kind: enum
Underlying type: string
Validation: Enum: [Reported Partial Unsupported Unknown]
Appears in: PlacementStatus
Allowed values
- Reported
- Partial
- Unsupported
- Unknown
PlacementStatus
PlacementStatus groups DGD-level scheduler placement fields under a single status object so future placement signals can be added without a schema break. See the v1beta1 PlacementStatus for the authoritative field docs.
Kind: type
Appears in: DynamoGraphDeploymentStatus
Score is the DGD-level scheduler placement score. Normalized to [0.0, 1.0]<br />where higher is better and 1.0 is the best possible placement. Validation: Maximum: 1 <br />Minimum: 0 <br />Optional: {} <br />
State indicates placement score reporting state. See PlacementScoreState. Validation: Enum: [Reported Partial Unsupported Unknown] <br />Optional: {} <br />
PodReference
PodReference names a pod in the same namespace as the referencing PodSnapshot.
Kind: type
Appears in: PodSnapshotContentSource, PodSnapshotSource
Name of the source pod. Validation: MinLength: 1 <br />Required: {} <br />
UID of the source pod, recorded so the node agent dumps that specific<br />pod and not a same-named recreation. See UID. Validation: Optional: {} <br />
PodSnapshot
PodSnapshot is the Schema for the snapshots API. It is the namespaced binding for a captured container checkpoint and is consumed by restore paths.
No conversion: this type exists only in v1alpha1 (no other API version), so it is not part of any conversion scheme.
Kind: resource
nvidia.com/v1alpha1
PodSnapshot
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
See PodSnapshotSpec.
See PodSnapshotStatus.
PodSnapshotContent
PodSnapshotContent is the Schema for the snapshotcontents API. It is the cluster-scoped artifact-of-record for a captured container checkpoint.
No conversion: this type exists only in v1alpha1 (no other API version), so it is not part of any conversion scheme.
Kind: resource
nvidia.com/v1alpha1
PodSnapshotContent
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
PodSnapshotContentSource
PodSnapshotContentSource is the immutable source descriptor: what to dump (PodRef) and where it runs (NodeName).
Kind: type
Appears in: PodSnapshotContentSpec
PodRef identifies the pod to dump. Its UID guards against dumping a<br />same-named recreation of the pod. See PodReference. Validation: Required: {} <br />
NodeName is the node the source pod runs on, denormalized from the live<br />pod so it travels with PodRef as one immutable unit and selects the node<br />agent that performs the dump. Validation: MinLength: 1 <br />Required: {} <br />
PodSnapshotContentSpec
PodSnapshotContentSpec defines the desired state of PodSnapshotContent. It is populated by the PodSnapshotReconciler (operator) at creation time and is immutable thereafter.
Kind: type
Appears in: PodSnapshotContent
PodSnapshotRef is the back-pointer to the bound PodSnapshot. It may span<br />namespaces because PodSnapshotContent is cluster-scoped. See PodSnapshotReference. Validation: Required: {} <br />
Source describes what to capture: the source pod and the node it runs on. See PodSnapshotContentSource. Validation: Required: {} <br />
PodSnapshotContentStatus
PodSnapshotContentStatus defines the observed state of PodSnapshotContent.
Kind: type
Appears in: PodSnapshotContent
Conditions reflect the latest observations of the PodSnapshotContent’s state.<br />Standard types are Ready and Failed. See Condition. Validation: Optional: {} <br />
PodSnapshotReference
PodSnapshotReference is a cross-namespace reference to a PodSnapshot.
Kind: type
Appears in: PodSnapshotContentSpec
Namespace of the referenced PodSnapshot. Validation: Required: {} <br />
Name of the referenced PodSnapshot. Validation: Required: {} <br />
UID of the referenced PodSnapshot, recorded at binding time to detect a<br />stale reference after a delete and recreate. See UID. Validation: Optional: {} <br />
PodSnapshotSource
PodSnapshotSource identifies the workload captured by a PodSnapshot.
Kind: type
Appears in: PodSnapshotSpec
PodRef references the pod, in the PodSnapshot’s namespace, that is captured.<br />The operator prepares the pod (control volume, target-container annotation,<br />checkpoint storage mount) before creating the PodSnapshot. See PodReference. Validation: Required: {} <br />
PodSnapshotSpec
PodSnapshotSpec defines the desired state of PodSnapshot.
Kind: type
Appears in: PodSnapshot
Source identifies the captured workload. It is a struct (rather than an<br />inlined reference) so future source variants can be added additively. See PodSnapshotSource. Validation: Required: {} <br />
PodSnapshotStatus
PodSnapshotStatus defines the observed state of PodSnapshot.
Kind: type
Appears in: PodSnapshot
BoundPodSnapshotContentName is the name of the cluster-scoped PodSnapshotContent<br />this PodSnapshot is bound to. It is nil until the agent has created the<br />content and recorded the binding. Validation: Optional: {} <br />
Conditions reflect the latest observations of the PodSnapshot’s state.<br />Standard types are Ready and Failed. See Condition. Validation: Optional: {} <br />
ProfilingConfigSpec
ProfilingConfigSpec defines configuration for the profiling process. This structure maps directly to the profile_sla.py config format. See dynamo/profiler/utils/profiler_argparse.py for the complete schema.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
Config is the profiling configuration as arbitrary JSON/YAML. This will be passed directly to the profiler.<br />The profiler will validate the configuration and report any errors. See JSON. Validation: Optional: {} <br />Type: object <br />
ConfigMapRef is an optional reference to a ConfigMap containing the DynamoGraphDeployment<br />base config file (disagg.yaml). This is separate from the profiling config above.<br />The path to this config will be set as engine.config in the profiling config. See ConfigMapKeySelector. Validation: Optional: {} <br />
ProfilerImage specifies the container image to use for profiling jobs.<br />This image contains the profiler code and dependencies needed for SLA-based profiling.<br />Example: “nvcr.io/nvidia/ai-dynamo/dynamo-planner:1.2.1” Validation: Required: {} <br />
OutputPVC is an optional PersistentVolumeClaim name for storing profiling output.<br />If specified, all profiling artifacts (logs, plots, configs, raw data) will be written<br />to this PVC instead of an ephemeral emptyDir volume. This allows users to access<br />complete profiling results after the job completes by mounting the PVC.<br />The PVC must exist in the same namespace as the DGDR.<br />If not specified, profiling uses emptyDir and only essential data is saved to ConfigMaps.<br />Note: ConfigMaps are still created regardless of this setting for planner integration. Validation: Optional: {} <br />
Resources specifies the compute resource requirements for the profiling job container.<br />If not specified, no resource requests or limits are set. See ResourceRequirements. Validation: Optional: {} <br />
Tolerations allows the profiling job to be scheduled on nodes with matching taints.<br />For example, to schedule on GPU nodes, add a toleration for the nvidia.com/gpu taint. See Toleration. Validation: Optional: {} <br />
NodeSelector is a selector which must match a node’s labels for the profiling pod to be scheduled on that node.<br />For example, to schedule on ARM64 nodes, use {“kubernetes.io/arch”: “arm64”}. Validation: Optional: {} <br />
ResourceItem
Kind: type
Appears in: Resources
CPU specifies the CPU resource request/limit (e.g., “1000m”, “2”)
Memory specifies the memory resource request/limit (e.g., “4Gi”, “8Gi”)
GPU indicates the number of GPUs to request.<br />Total number of GPUs is NumberOfNodes * GPU in case of multinode deployment.
GPUType can specify a custom GPU type, e.g. “gpu.intel.com/xe”<br />By default if not specified, the GPU type is “nvidia.com/gpu”
Custom specifies additional custom resource requests/limits
Resources
Resources defines requested and limits for a component, including CPU, memory, GPUs/devices, and any runtime-specific resources.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Requests specifies the minimum resources required by the component See ResourceItem.
Limits specifies the maximum resources allowed for the component See ResourceItem.
Claims specifies resource claims for dynamic resource allocation See ResourceClaim.
Restart
Kind: type
Appears in: DynamoGraphDeploymentSpec
ID is an arbitrary string that triggers a restart when changed.<br />Any modification to this value will initiate a restart of the graph deployment according to the strategy. Validation: MinLength: 1 <br />Required: {} <br />
Strategy specifies the restart strategy for the graph deployment. See RestartStrategy. Validation: Optional: {} <br />
RestartPhase
Kind: enum
Underlying type: string
Appears in: RestartStatus
Allowed values
- Pending
- Restarting
- Completed
- Failed
- Superseded
RestartStatus
RestartStatus contains the status of the restart of the graph deployment.
Kind: type
Appears in: DynamoGraphDeploymentStatus
ObservedID is the restart ID that has been observed and is being processed.<br />Matches the Restart.ID field in the spec.
Phase is the phase of the restart. See RestartPhase.
InProgress contains the names of the services that are currently being restarted. Validation: Optional: {} <br />
RestartStrategy
Kind: type
Appears in: Restart
Type specifies the restart strategy type. See RestartStrategyType. Validation: Enum: [Sequential Parallel] <br />
Order specifies the order in which the services should be restarted. Validation: Optional: {} <br />
RestartStrategyType
RollingUpdatePhase
RollingUpdatePhase represents the current phase of a rolling update.
Kind: enum
Underlying type: string
Validation: Enum: [Pending InProgress Completed Failed ]
Appears in: RollingUpdateStatus
Allowed values
- Pending
- InProgress
- Completed
- “
RollingUpdateStatus
RollingUpdateStatus tracks the progress of a rolling update.
Kind: type
Appears in: DynamoGraphDeploymentStatus
Phase indicates the current phase of the rolling update. See RollingUpdatePhase. Validation: Enum: [Pending InProgress Completed Failed ] <br />Optional: {} <br />
StartTime is when the rolling update began. See Time. Validation: Optional: {} <br />
EndTime is when the rolling update completed (successfully or failed). See Time. Validation: Optional: {} <br />
UpdatedServices is the list of services that have completed the rolling update.<br />A service is considered updated when its new replicas are all ready and old replicas are fully scaled down.<br />Only services of componentType Worker (or Prefill/Decode) are considered. Validation: Optional: {} <br />
ScalingAdapter
ScalingAdapter configures whether a service uses the DynamoGraphDeploymentScalingAdapter for replica management. When enabled, the DGDSA owns the replicas field and external autoscalers (HPA, KEDA, Planner) can control scaling via the Scale subresource.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Enabled indicates whether the ScalingAdapter should be enabled for this service.<br />When true, a DGDSA is created and owns the replicas field.<br />When false (default), no DGDSA is created and replicas can be modified directly in the DGD. Validation: Optional: {} <br />
ServiceCheckpointConfig
ServiceCheckpointConfig configures checkpointing for a DGD service
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Enabled indicates whether checkpointing is enabled for this service Validation: Optional: {} <br />
Deprecated: omit mode. Use enabled=true without checkpointRef for a<br />DGD-managed automatic checkpoint, or use checkpointRef to restore the<br />named checkpoint. See CheckpointMode. Validation: Enum: [Auto Manual] <br />Optional: {} <br />
StartupPolicy defines when normal worker replicas are started relative to<br />automatic checkpoint readiness.<br />- Immediate: start workers cold immediately; later Pods restore from the<br /> checkpoint once it is Ready.<br />- WaitForCheckpoint: keep worker replicas at zero until the checkpoint is<br /> Ready, then start them from the checkpoint. See CheckpointStartupPolicy. Validation: Enum: [Immediate WaitForCheckpoint] <br />Optional: {} <br />
DeletionPolicy defines whether a DGD-managed automatic checkpoint CR and<br />artifact are deleted or retained when the owning DGD is deleted.<br />Explicit checkpointRef checkpoints are never owned or deleted by the DGD. See CheckpointDeletionPolicy. Validation: Enum: [Delete Retain] <br />Optional: {} <br />
CheckpointRef references an existing DynamoCheckpoint CR by metadata.name.<br />If specified, this service’s Identity is ignored and the referenced checkpoint is used directly. Validation: Optional: {} <br />
Deprecated: omit for DGD-managed checkpoints; no action is needed.<br />Use CheckpointRef to restore an existing checkpoint. See DynamoCheckpointIdentity. Validation: Optional: {} <br />
TargetContainerName is the workload container to snapshot and restore.
Validation: MaxLength: 63 <br />MinLength: 1 <br />Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />Optional: {} <br />
Job customizes the DGD-managed checkpoint Job. See ServiceCheckpointJobConfig. Validation: Optional: {} <br />
ServiceCheckpointJobConfig
ServiceCheckpointJobConfig customizes the checkpoint Job created for a DGD service.
Kind: type
Appears in: ServiceCheckpointConfig
GMSClientContainers lists checkpoint Job containers that should receive<br />GMS client wiring. Requires gpuMemoryService on the service.
Validation: items:MaxLength: 63 <br />items:MinLength: 1 <br />items:Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />Optional: {} <br />
PodTemplate customizes the checkpoint Job pod. The operator starts from the<br />selected workload container and merges this template so users can add helper<br />containers such as gms-saver. See PodTemplateSpec. Validation: Schemaless: {} <br />Type: object <br />Optional: {} <br />
ServiceCheckpointStatus
ServiceCheckpointStatus contains checkpoint information for a single service.
Kind: type
Appears in: DynamoGraphDeploymentStatus
CheckpointName is the name of the associated Checkpoint CR Validation: Optional: {} <br />
CheckpointID is the artifact ID used by the snapshot protocol Validation: Optional: {} <br />
IdentityHash is the computed hash of the checkpoint identity<br />Deprecated: automatic checkpoints use CheckpointID. This field is retained<br />for older status consumers. Validation: Optional: {} <br />
Ready indicates the checkpoint artifact is ready for future pods to restore. Validation: Optional: {} <br />
ServiceReplicaStatus
ServiceReplicaStatus contains replica information for a single service.
Kind: type
Appears in: DynamoGraphDeploymentStatus
ComponentKind is the underlying resource kind (e.g., “PodClique”, “PodCliqueScalingGroup”, “Deployment”, “LeaderWorkerSet”). See ComponentKind. Validation: Enum: [PodClique PodCliqueScalingGroup Deployment LeaderWorkerSet] <br />
ComponentName is the name of the primary underlying resource.<br />DEPRECATED: Use ComponentNames instead. This field will be removed in a future release.<br />During rolling updates, this reflects the new (target) component name.
ComponentNames is the list of underlying resource names for this service.<br />During normal operation, this contains a single name.<br />During rolling updates, this contains both old and new component names. Validation: Optional: {} <br />
RuntimeNamespace is the effective Dynamo runtime namespace for this<br />component. Worker components may include a generation suffix; non-workers and<br />Grove-backed workers use the base namespace. During rolling updates, worker<br />status keeps the old active revision namespace until cutover completes. Validation: Optional: {} <br />
Replicas is the total number of non-terminated replicas.<br />Required for all component kinds. Validation: Minimum: 0 <br />
UpdatedReplicas is the number of replicas at the current/desired revision.<br />Required for all component kinds. Validation: Minimum: 0 <br />
ReadyReplicas is the number of ready replicas.<br />Populated for PodClique, Deployment, and LeaderWorkerSet.<br />Not available for PodCliqueScalingGroup.<br />When nil, the field is omitted from the API response. Validation: Minimum: 0 <br />Optional: {} <br />
AvailableReplicas is the number of available replicas.<br />For Deployment: replicas ready for >= minReadySeconds.<br />For PodCliqueScalingGroup: replicas where all constituent PodCliques have >= MinAvailable ready pods.<br />Not available for PodClique or LeaderWorkerSet.<br />When nil, the field is omitted from the API response. Validation: Minimum: 0 <br />Optional: {} <br />
ScheduledReplicas is the number of replicas the backend scheduler has<br />scheduled, in Dynamo component-replica units. Optional; omitted (nil)<br />when the backend cannot derive it reliably. A nil value means “not<br />reported”, never “zero scheduled”. Validation: Minimum: 0 <br />Optional: {} <br />
SpecTopologyConstraint
SpecTopologyConstraint defines deployment-level topology placement requirements. It carries both the topology profile (which ClusterTopology CR to use) and an optional default pack domain that services without their own constraint inherit.
Kind: type
Appears in: DynamoGraphDeploymentSpec
TopologyProfile is the name of the ClusterTopology CR that defines the<br />topology hierarchy for this deployment. Validation: MinLength: 1 <br />
PackDomain is the default topology domain to pack pods within.<br />Optional — omit when only services carry constraints.
See TopologyDomain.
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ <br />Optional: {} <br />
TopologyConstraint
TopologyConstraint defines service-level topology placement requirements. The topology profile is inherited from the deployment-level SpecTopologyConstraint; only the pack domain is specified here.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
PackDomain is the topology domain to pack pods within. Must match a<br />domain defined in the referenced ClusterTopology CR.
See TopologyDomain.
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ <br />
TopologyDomain
TopologyDomain is a free-form topology level identifier.
Common examples: “region”, “zone”, “datacenter”, “block”, “rack”, “host”, “numa”.
When used with a ClusterTopology CR, domain names are defined in the CR’s
hierarchy; when used with spec.experimental.kvTransferPolicy.labelKey
alone, the value is a user-chosen logical name for the topology level.
Must match ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ (lowercase alphanumeric,
may contain hyphens but must not start or end with one).
Kind: type
Underlying type: string
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
Appears in: KvTransferPolicy, SpecTopologyConstraint, TopologyConstraint
VolumeMount
VolumeMount references a PVC defined at the top level for volumes to be mounted by the component
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Name references a PVC name defined in the top-level PVCs map Validation: Required: {} <br />
MountPoint specifies where to mount the volume.<br />If useAsCompilationCache is true and mountPoint is not specified,<br />a backend-specific default will be used.
UseAsCompilationCache indicates this volume should be used as a compilation cache.<br />When true, backend-specific environment variables will be set and default mount points may be used.
nvidia.com/v1beta1
Package v1beta1 contains API Schema definitions for the nvidia.com v1beta1 API group.
Resource Types
BackendType
BackendType specifies the inference backend.
Kind: enum
Underlying type: string
Validation: Enum: [auto sglang trtllm vllm]
Appears in: DynamoGraphDeploymentRequestSpec
Allowed values
- auto
- sglang
- trtllm
- vllm
CheckpointDeletionPolicy
CheckpointDeletionPolicy defines what happens to DGD-managed automatic checkpoint resources when the owning DGD is deleted.
Kind: enum
Underlying type: string
Validation: Enum: [Delete Retain]
Appears in: ComponentCheckpointConfig
Allowed values
- Delete CheckpointDeletionPolicyDelete deletes DGD-managed automatic checkpoint<br />CRs and artifacts when the owning DGD is deleted.<br />
- Retain CheckpointDeletionPolicyRetain keeps DGD-managed automatic checkpoint CRs<br />and artifacts after the owning DGD is deleted. Users can reference the<br />retained checkpoint with checkpointRef if they accept compatibility risk.<br />
CheckpointMode
Deprecated: use checkpoint.enabled instead. enabled=true without checkpointRef creates a DGD-managed automatic checkpoint; checkpointRef restores the named checkpoint.
Kind: enum
Underlying type: string
Validation: Enum: [Auto Manual]
Appears in: ComponentCheckpointConfig
Allowed values
- Auto Deprecated: use checkpoint.enabled=true and omit checkpointRef.<br />
- Manual Deprecated: use checkpointRef to restore an existing checkpoint.<br />
CheckpointStartupPolicy
CheckpointStartupPolicy defines when worker pods should wait for a checkpoint.
Kind: enum
Underlying type: string
Validation: Enum: [Immediate WaitForCheckpoint]
Appears in: ComponentCheckpointConfig
Allowed values
- Immediate CheckpointStartupPolicyImmediate starts workers immediately. The checkpoint<br />job runs in the background, and only pods created after the checkpoint is<br />Ready are restore-shaped by the pod-create mutating webhook.<br />
- WaitForCheckpoint CheckpointStartupPolicyWaitForCheckpoint gates worker replicas until the<br />component’s checkpoint is Ready, then starts them from the checkpoint.<br />
CompilationCacheConfig
CompilationCacheConfig configures a PVC-backed compilation cache for a component. The operator handles backend-specific mount paths and environment variables so users do not need to hand-wire them into the pod template.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
pvcName references a user-created PVC by name. The PVC must exist in<br />the same namespace as the DynamoGraphDeployment. Validation: MinLength: 1 <br />Required: {} <br />
mountPath overrides the backend-specific default mount path. When<br />empty, the operator selects a default appropriate for the backend<br />framework. Validation: Optional: {} <br />
ComponentCheckpointConfig
ComponentCheckpointConfig configures checkpointing for a DGD component.
Kind: type
Appears in: ExperimentalSpec
enabled indicates whether checkpointing is enabled for this component.<br />When true, omit checkpointRef for a DGD-managed automatic checkpoint or<br />set checkpointRef to restore an existing checkpoint. Omit the checkpoint<br />block, or set enabled=false, to disable checkpointing. Validation: Required: {} <br />
Deprecated: omit mode. Use enabled=true without checkpointRef for a<br />DGD-managed automatic checkpoint, or use checkpointRef to restore the<br />named checkpoint. See CheckpointMode. Validation: Enum: [Auto Manual] <br />Optional: {} <br />
startupPolicy defines when normal worker replicas are started relative to<br />automatic checkpoint readiness.<br />Immediate (default): start workers cold immediately; later Pods restore<br />from the checkpoint once it is Ready.<br />WaitForCheckpoint: keep worker replicas at zero until the checkpoint is<br />Ready, then start them from the checkpoint.
See CheckpointStartupPolicy.
Validation: Enum: [Immediate WaitForCheckpoint] <br />Optional: {} <br />
DeletionPolicy defines whether a DGD-managed automatic checkpoint CR and<br />artifact are deleted or retained when the owning DGD is deleted.<br />Explicit checkpointRef checkpoints are never owned or deleted by the DGD. See CheckpointDeletionPolicy. Validation: Enum: [Delete Retain] <br />Optional: {} <br />
checkpointRef references an existing DynamoCheckpoint CR by metadata.name.<br />When set, this component’s identity is ignored and the referenced<br />checkpoint is used directly.
Validation: Optional: {} <br />
Deprecated: omit for DGD-managed checkpoints; no action is needed.<br />Use checkpointRef to restore an existing checkpoint. See DynamoCheckpointIdentity. Validation: Optional: {} <br />
targetContainerName is the workload container to snapshot and restore.
Validation: MaxLength: 63 <br />MinLength: 1 <br />Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />Optional: {} <br />
job customizes the DGD-managed checkpoint Job. See ComponentCheckpointJobConfig. Validation: Optional: {} <br />
ComponentCheckpointJobConfig
ComponentCheckpointJobConfig customizes the checkpoint Job created for a DGD component.
Kind: type
Appears in: ComponentCheckpointConfig
gmsClientContainers lists checkpoint Job containers that should receive<br />GMS client wiring. Requires gpuMemoryService on the component.
Validation: items:MaxLength: 63 <br />items:MinLength: 1 <br />items:Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />Optional: {} <br />
podTemplate customizes the checkpoint Job pod. The operator starts from the<br />selected workload container and merges this template so users can add helper<br />containers such as gms-saver. See PodTemplateSpec. Validation: Schemaless: {} <br />Type: object <br />Optional: {} <br />
ComponentCheckpointStatus
ComponentCheckpointStatus contains checkpoint information for a single component.
Kind: type
Appears in: DynamoGraphDeploymentStatus
checkpointName is the name of the associated DynamoCheckpoint CR. Validation: Optional: {} <br />
checkpointID is the artifact ID used by the snapshot protocol. Validation: Optional: {} <br />
identityHash is the computed hash of the checkpoint identity.<br />Deprecated: automatic checkpoints use checkpointID. This field is retained<br />for older status consumers. Validation: Optional: {} <br />
ready indicates the checkpoint artifact is ready for future pods to restore. Validation: Optional: {} <br />
ComponentKind
ComponentKind represents the type of underlying Kubernetes resource backing a DGD component.
Kind: enum
Underlying type: string
Validation: Enum: [PodClique PodCliqueScalingGroup Deployment LeaderWorkerSet]
Appears in: ComponentReplicaStatus
Allowed values
- PodClique
- PodCliqueScalingGroup
- Deployment
- LeaderWorkerSet
ComponentReplicaStatus
ComponentReplicaStatus contains replica information for a single component.
Kind: type
Appears in: DynamoGraphDeploymentStatus
componentKind is the underlying resource kind (e.g. PodClique,<br />Deployment, LeaderWorkerSet).
See ComponentKind.
Validation: Enum: [PodClique PodCliqueScalingGroup Deployment LeaderWorkerSet] <br />
componentNames is the list of underlying Kubernetes resource names for<br />this Dynamo component. During normal operation this contains a single<br />name; during rolling updates it contains both old and new resource names. Validation: Optional: {} <br />
runtimeNamespace is the effective Dynamo runtime namespace for this<br />component. Worker components may include a generation suffix; non-workers and<br />Grove-backed workers use the base namespace. During rolling updates, worker<br />status keeps the old active revision namespace until cutover completes. Validation: Optional: {} <br />
replicas is the total number of non-terminated replicas. Validation: Minimum: 0 <br />
updatedReplicas is the number of replicas at the current/desired revision. Validation: Minimum: 0 <br />
readyReplicas is the number of ready replicas. Populated for<br />PodClique, Deployment, and LeaderWorkerSet; not available for<br />PodCliqueScalingGroup.
Validation: Minimum: 0 <br />Optional: {} <br />
availableReplicas is the number of available replicas. Populated for<br />Deployment and PodCliqueScalingGroup; not available for<br />PodClique or LeaderWorkerSet.
Validation: Minimum: 0 <br />Optional: {} <br />
scheduledReplicas is the number of replicas the backend scheduler has<br />scheduled, expressed strictly in Dynamo component-replica units (not<br />raw backend pod counts). It is a diagnostic aid for distinguishing<br />capacity/scheduling shortfalls from runtime readiness.<br />It is optional and omitted (nil) when the active backend cannot derive<br />it reliably in component-replica units — for example before the backing<br />resource’s status has been observed, or for backends that do not report<br />a scheduling count. A nil value therefore means “not reported”, never<br />“zero scheduled”; consumers must not treat absence as a scheduling<br />failure. Validation: Minimum: 0 <br />Optional: {} <br />
ComponentType
ComponentType identifies the role of a Dynamo component within a graph.
In v1beta1 this is a strict enum. Unlike v1alpha1 (where subComponentType
was used as a workaround for disaggregated serving), prefill and decode
are first-class values: users can set them directly and downstream consumers
(e.g., the EPP) can filter on the pod label nvidia.com/dynamo-component-type.
Kind: enum
Underlying type: string
Validation: Enum: [frontend worker prefill decode planner epp]
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
Allowed values
- frontend
- worker
- prefill
- decode
- planner
- epp
DGDRPhase
DGDRPhase represents the lifecycle phase of a DynamoGraphDeploymentRequest.
Kind: enum
Underlying type: string
Validation: Enum: [Pending Profiling Ready Deploying Deployed Failed]
Appears in: DynamoGraphDeploymentRequestStatus
Allowed values
- Pending
- Profiling
- Ready
- Deploying
- Deployed
- Failed
DGDState
DGDState is the high-level lifecycle state of a DynamoGraphDeployment.
Kind: enum
Underlying type: string
Validation: Enum: [initializing pending successful failed]
Appears in: DynamoGraphDeploymentStatus
Allowed values
- initializing
- pending
- successful
- failed
DeploymentInfoStatus
DeploymentInfoStatus tracks the state of the deployed DynamoGraphDeployment.
Kind: type
Appears in: DynamoGraphDeploymentRequestStatus
Replicas is the desired number of replicas. Validation: Optional: {} <br />
AvailableReplicas is the number of replicas that are available and ready. Validation: Optional: {} <br />
DynamoCheckpointIdentity
Deprecated: omit in DGD component checkpoint configs. Auto needs no replacement; use checkpointRef for explicit restores. Duplicated from v1alpha1; DynamoCheckpoint itself remains v1alpha1.
Kind: type
Appears in: ComponentCheckpointConfig
model is the model identifier (e.g. “meta-llama/Llama-3-70B”).<br />Deprecated: legacy identity only. Validation: MinLength: 1 <br />Required: {} <br />
backendFramework is the runtime framework (vllm, sglang, trtllm).<br />Deprecated: legacy identity only.
Validation: Enum: [vllm sglang trtllm] <br />Required: {} <br />
dynamoVersion is the Dynamo platform version.<br />Deprecated: legacy identity only. Validation: Optional: {} <br />
tensorParallelSize is the tensor parallel configuration.<br />Deprecated: checkpoint launch uses the pod template instead. Validation: Minimum: 1 <br />Optional: {} <br />
pipelineParallelSize is the pipeline parallel configuration.<br />Deprecated: checkpoint launch uses the pod template instead. Validation: Minimum: 1 <br />Optional: {} <br />
dtype is the data type (fp16, bf16, fp8, etc.).<br />Deprecated: legacy identity only.
Validation: Optional: {} <br />
maxModelLen is the maximum sequence length.<br />Deprecated: legacy identity only. Validation: Minimum: 1 <br />Optional: {} <br />
extraParameters are additional parameters that affect the checkpoint hash.<br />Deprecated: legacy identity only. Validation: Optional: {} <br />
DynamoComponentDeployment
DynamoComponentDeployment is the Schema for the dynamocomponentdeployments API.
v1beta1 is a served version: the API server accepts reads and writes against it, and transparently converts to/from v1alpha1 (still the storage version until a later MR flips it). Conversion goes through the operator’s conversion webhook; see api/v1alpha1/*_conversion.go.
Kind: resource
nvidia.com/v1beta1
DynamoComponentDeployment
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
spec defines the desired state for this Dynamo component deployment. See DynamoComponentDeploymentSpec.
DynamoComponentDeploymentSpec
DynamoComponentDeploymentSpec defines the desired state of a DynamoComponentDeployment.
Kind: type
Appears in: DynamoComponentDeployment
backendFramework specifies the backend framework. Validation: Enum: [sglang vllm trtllm] <br />
name is the stable logical identifier for this component within its<br />DynamoGraphDeployment. It must be unique within the parent’s<br />spec.components list.<br />For standalone DynamoComponentDeployment objects, the defaulting webhook<br />populates name from metadata.name on admission, so users<br />typically do not need to set it explicitly.<br />name is decoupled from the underlying Kubernetes resource name so that<br />the operator can rename child workloads (e.g. suffixing worker DCDs with<br />a hash during rolling updates) without losing the stable identity that<br />downstream consumers (labels, status maps, DGDSA references, planner<br />RBAC, EPP filters) depend on.
Validation: MaxLength: 63 <br />MinLength: 1 <br />Pattern: ^[A-Za-z0-9]([-A-Za-z0-9]*[A-Za-z0-9])?$ <br />Required: {} <br />
type indicates the role of this component within a Dynamo graph. Drives<br />port mapping, frontend detection, planner RBAC, and the pod label<br />nvidia.com/dynamo-component-type. Because prefill and decode are<br />first-class values, users can set them directly.
See ComponentType.
Validation: Enum: [frontend worker prefill decode planner epp] <br />Optional: {} <br />
globalDynamoNamespace places the component in the global Dynamo<br />namespace rather than the per-deployment namespace derived from the<br />DGD name. Validation: Optional: {} <br />
podTemplate is the pod template used to create the component’s pods.<br />The operator injects its defaults (image, command, env, ports, probes,<br />resources, volume mounts) into the container named "main" inside<br />podTemplate.spec.containers, merging user overrides by name. If no<br />container named "main" is present, the operator auto-generates it<br />with standard defaults. All other containers in podTemplate.spec.containers<br />are treated as user-managed sidecars: the operator does not inject<br />defaults into them, so sidecars must specify required fields (e.g. image)<br />themselves. The validation webhook rejects pod templates where a<br />non-"main" container is missing a required field such as image.
See PodTemplateSpec.
Validation: Optional: {} <br />
replicas is the desired number of Pods for this component. When<br />scalingAdapter is set on this component, this field is managed by<br />the DynamoGraphDeploymentScalingAdapter and should not be modified<br />directly.
Validation: Minimum: 0 <br />Optional: {} <br />
minAvailable maps to Grove PodClique minAvailable for single-node and<br />Grove PodCliqueScalingGroup minAvailable for multi-node components.<br />This field determines 1) the minimum number of replicas guaranteed to be<br />gang-scheduled, and 2) when violating minAvailable replicas triggers gang<br />termination.<br />For Grove-backed DynamoGraphDeployment components, minAvailable defaults to<br />1 when omitted and is immutable after creation. Positive replica counts must<br />be greater than or equal to minAvailable. Replicas may be scaled to 0 as a<br />special scale-to-zero state; minAvailable remains configured but is not<br />enforced again until replicas is scaled back to a positive value.<br />For non-Grove deployments, setting this field will result in a validation error. Validation: Minimum: 1 <br />Optional: {} <br />
multinode configures multinode components. See MultinodeSpec. Validation: Optional: {} <br />
sharedMemorySize controls the size of the tmpfs mounted at /dev/shm.<br />nil selects the operator default (8Gi), a positive quantity sets a<br />custom size, and "0" disables the shared-memory volume entirely.<br />Simpler replacement for v1alpha1’s SharedMemorySpec struct with its<br />disabled bool + size Quantity pattern.
See Quantity.
Validation: Optional: {} <br />
modelRef references a model served by this component. When specified,<br />a headless service is created for endpoint discovery. See ModelReference. Validation: Optional: {} <br />
scalingAdapter opts this component into using the<br />DynamoGraphDeploymentScalingAdapter. When set (even as an empty object,<br />scalingAdapter: \{\}), a DGDSA is created and owns the replicas field<br />so that external autoscalers (HPA/KEDA/Planner) can drive scaling via<br />the Scale subresource. Omit the field to opt out.
See ScalingAdapter.
Validation: Optional: {} <br />
eppConfig holds EPP-specific configuration for Endpoint Picker Plugin<br />components. Only meaningful when type is epp.
See EPPConfig.
Validation: Optional: {} <br />
frontendSidecar optionally designates a container in<br />podTemplate.spec.containers as the frontend sidecar. The value must<br />match the name of a container in that list; the operator merges its<br />frontend-sidecar defaults (auto-generated Dynamo env vars, ports,<br />health probes) into that container the same way it merges into "main".<br />The full container definition (image, args, envFrom, env) lives in<br />podTemplate — this eliminates the redundant image, args,<br />envFromSecret, and envs fields from v1alpha1’s FrontendSidecarSpec.<br />The validation webhook rejects values that do not match any container<br />name in podTemplate.spec.containers.
Validation: Optional: {} <br />
compilationCache configures a PVC-backed compilation cache. The operator<br />handles backend-specific mount paths and environment variables, so<br />users do not need to hand-wire them into podTemplate. Extracted from<br />v1alpha1’s volumeMount.useAsCompilationCache flag.
See CompilationCacheConfig.
Validation: Optional: {} <br />
topologyConstraint applies to this component.<br />topologyConstraint.packDomain is required. When both this and<br />spec.topologyConstraint.packDomain are set, this field’s packDomain<br />must be narrower than or equal to the spec-level value.
See TopologyConstraint.
Validation: Optional: {} <br />
experimental groups opt-in preview features whose API shape and<br />behavior may change in breaking ways between v1beta1 releases,<br />including disappearing without a name-preserving graduation path.<br />In v1beta1 this block holds gpuMemoryService and failover (which<br />remain tightly coupled — failover requires GMS — and are expected to<br />evolve together as the DRA-based GPU sharing story matures), and<br />checkpoint (whose API shape is still settling). Fields here are<br />explicitly NOT covered by the normal v1beta1 deprecation policy; do not<br />depend on them for production workloads.
See ExperimentalSpec.
Validation: Optional: {} <br />
DynamoGraphDeployment
DynamoGraphDeployment is the Schema for the dynamographdeployments API.
v1beta1 is a served version: the API server accepts reads and writes against it, and transparently converts to/from v1alpha1 (still the storage version until a later MR flips it). Conversion goes through the operator’s conversion webhook; see api/v1alpha1/*_conversion.go.
Kind: resource
nvidia.com/v1beta1
DynamoGraphDeployment
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
spec defines the desired state for this graph deployment. See DynamoGraphDeploymentSpec.
status reflects the current observed state of this graph deployment. See DynamoGraphDeploymentStatus.
DynamoGraphDeploymentComponentRef
DynamoGraphDeploymentComponentRef identifies a specific component within a
DynamoGraphDeployment. Renamed from v1alpha1’s DynamoGraphDeploymentServiceRef
to align with the v1beta1 services -> components and
serviceName -> componentName renames.
Kind: type
Appears in: DynamoGraphDeploymentScalingAdapterSpec
name is the metadata.name of the target DynamoGraphDeployment.
Validation: MinLength: 1 <br />Required: {} <br />
componentName is the componentName of the entry within the target<br />DGD’s spec.components list to scale.
Validation: MinLength: 1 <br />Required: {} <br />
DynamoGraphDeploymentExperimentalSpec
DynamoGraphDeploymentExperimentalSpec groups graph-level opt-in preview
features whose API shape and behavior may change in breaking ways between
v1beta1 releases. Component-level experimental features live under
spec.components[*].experimental.
Kind: type
Appears in: DynamoGraphDeploymentSpec
kvTransferPolicy configures topology-aware routing for KV-cache<br />transfers between prefill and decode workers. See KvTransferPolicy. Validation: Optional: {} <br />
v1beta1 DynamoGraphDeploymentRequest
DynamoGraphDeploymentRequest is the Schema for the dynamographdeploymentrequests API. It provides a simplified, SLA-driven interface for deploying inference models on Dynamo. Users specify a model and optional performance targets; the controller handles profiling, configuration selection, and deployment.
Lifecycle:
- Pending: Spec validated, preparing for profiling
- Profiling: Profiling job is running to discover optimal configurations
- Ready: Profiling complete, generated DGD spec available in status
- Deploying: DGD is being created and rolled out (when autoApply=true)
- Deployed: DGD is running and healthy
- Failed: An unrecoverable error occurred
Kind: resource
nvidia.com/v1beta1
DynamoGraphDeploymentRequest
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
Spec defines the desired state for this deployment request. See DynamoGraphDeploymentRequestSpec.
Status reflects the current observed state of this deployment request. See DynamoGraphDeploymentRequestStatus.
v1beta1 DynamoGraphDeploymentRequestSpec
DynamoGraphDeploymentRequestSpec defines the desired state of a DynamoGraphDeploymentRequest. Only the Model field is required; all other fields are optional and have sensible defaults.
Kind: type
Appears in: DynamoGraphDeploymentRequest
Model specifies the model to deploy (e.g., “Qwen/Qwen3-0.6B”, “meta-llama/Llama-3-70b”).<br />Can be a HuggingFace ID or a private model name. Validation: MinLength: 1 <br />Required: {} <br />
Backend specifies the inference backend to use for profiling and deployment. See BackendType. Validation: Enum: [auto sglang trtllm vllm] <br />Optional: {} <br />
Image is the container image reference for the profiling job (planner image).<br />Example: “nvcr.io/nvidia/ai-dynamo/dynamo-planner:1.2.1”.<br />For Dynamo < 1.1.0, use dynamo-frontend. Validation: Optional: {} <br />
ModelCache provides optional PVC configuration for pre-downloaded model weights.<br />When provided, weights are loaded from the PVC instead of downloading from HuggingFace. See ModelCacheSpec. Validation: Optional: {} <br />
Hardware describes the hardware resources available for profiling and deployment.<br />Typically auto-filled by the operator from cluster discovery. See HardwareSpec. Validation: Optional: {} <br />
Workload defines the expected workload characteristics for SLA-based profiling. See WorkloadSpec. Validation: Optional: {} <br />
SLA defines service-level agreement targets that drive profiling optimization. See SLASpec. Validation: Optional: {} <br />
Overrides allows customizing the profiling job and the generated DynamoGraphDeployment. See OverridesSpec. Validation: Optional: {} <br />
Features controls optional Dynamo platform features in the generated deployment. See FeaturesSpec. Validation: Optional: {} <br />
SearchStrategy controls the profiling search depth.<br />“rapid” performs a fast sweep; “thorough” explores more configurations. See SearchStrategy. Validation: Enum: [rapid thorough] <br />Optional: {} <br />
AutoApply indicates whether to automatically create a DynamoGraphDeployment<br />after profiling completes. If false, the generated spec is stored in status<br />for manual review and application. Validation: Optional: {} <br />
v1beta1 DynamoGraphDeploymentRequestStatus
DynamoGraphDeploymentRequestStatus represents the observed state of a DynamoGraphDeploymentRequest.
Kind: type
Appears in: DynamoGraphDeploymentRequest
Phase is the high-level lifecycle phase of the deployment request. See DGDRPhase. Validation: Enum: [Pending Profiling Ready Deploying Deployed Failed] <br />Optional: {} <br />
ProfilingPhase indicates the current sub-phase of the profiling pipeline.<br />Only meaningful when Phase is “Profiling”. Cleared when profiling completes or fails. See ProfilingPhase. Validation: Enum: [Initializing SweepingPrefill SweepingDecode SelectingConfig BuildingCurves GeneratingDGD Done] <br />Optional: {} <br />
DGDName is the name of the generated or created DynamoGraphDeployment. Validation: Optional: {} <br />
ProfilingJobName is the name of the Kubernetes Job running the profiler. Validation: Optional: {} <br />
Conditions contains the latest observed conditions of the deployment request.<br />Standard condition types include: Succeeded, Validation, Profiling, SpecGenerated, DeploymentReady. See Condition. Validation: Optional: {} <br />
ProfilingResults contains the selected deployment configuration produced by profiling.<br />Deprecated compatibility fields may remain on objects created by older releases. See ProfilingResultsStatus. Validation: Optional: {} <br />
DeploymentInfo tracks the state of the deployed DynamoGraphDeployment.<br />Populated when a DGD has been created (either via autoApply or manually). See DeploymentInfoStatus. Validation: Optional: {} <br />
ObservedGeneration is the most recent generation observed by the controller. Validation: Optional: {} <br />
DynamoGraphDeploymentScalingAdapter
DynamoGraphDeploymentScalingAdapter provides a scaling interface for individual components within a DynamoGraphDeployment. It implements the Kubernetes scale subresource, enabling integration with HPA, KEDA, and custom autoscalers.
The adapter acts as an intermediary between autoscalers and the DGD, ensuring that only the adapter controller modifies the DGD’s component replicas. This prevents conflicts when multiple autoscaling mechanisms are in play.
v1alpha1 remains the storage version; conversion between served versions is handled by the operator’s conversion webhook (see api/v1alpha1/dynamographdeploymentscalingadapter_conversion.go).
Kind: resource
nvidia.com/v1beta1
DynamoGraphDeploymentScalingAdapter
Refer to Kubernetes API documentation for fields of metadata.
See ObjectMeta.
DynamoGraphDeploymentScalingAdapterSpec
DynamoGraphDeploymentScalingAdapterSpec defines the desired state of a DynamoGraphDeploymentScalingAdapter.
Kind: type
Appears in: DynamoGraphDeploymentScalingAdapter
replicas is the desired number of replicas for the target component.<br />This field is modified by external autoscalers (HPA/KEDA/Planner) or<br />manually by users. Validation: Minimum: 0 <br />Required: {} <br />
dgdRef references the DynamoGraphDeployment and the specific component to scale. See DynamoGraphDeploymentComponentRef. Validation: Required: {} <br />
DynamoGraphDeploymentScalingAdapterStatus
DynamoGraphDeploymentScalingAdapterStatus defines the observed state of a DynamoGraphDeploymentScalingAdapter.
Kind: type
Appears in: DynamoGraphDeploymentScalingAdapter
replicas is the current number of replicas for the target component.<br />This is synced from the DGD’s component replicas and is required for<br />the scale subresource.
selector is a label selector string for the pods managed by this<br />adapter. Required for HPA compatibility via the scale subresource. Validation: Optional: {} <br />
lastScaleTime is the last time the adapter scaled the target component. See Time. Validation: Optional: {} <br />
DynamoGraphDeploymentSpec
DynamoGraphDeploymentSpec defines the desired state of a DynamoGraphDeployment.
Kind: type
Appears in: DynamoGraphDeployment
annotations to propagate to all child resources (PCS, DCD, Deployments,<br />and pod templates). Component-level (podTemplate) values take precedence<br />on conflict.
Validation: Optional: {} <br />
labels to propagate to all child resources. Same precedence rules as annotations.
Validation: Optional: {} <br />
priorityClassName is the name of the PriorityClass to use for Grove PodCliqueSets.<br />Requires the Grove pathway. Validation: Optional: {} <br />
components are the components deployed as part of this graph. Each entry<br />carries its own stable logical name, and names must be unique within<br />the list. Component types are generally repeatable, except type: epp<br />which may appear at most once.
See DynamoComponentDeploymentSharedSpec.
Validation: MaxItems: 25 <br />Optional: {} <br />
env is prepended to every component’s environment. Component-specific<br />env entries with the same name take precedence and may reference values<br />from this list. See EnvVar. Validation: Optional: {} <br />
backendFramework specifies the backend framework (e.g. “sglang”, “vllm”, “trtllm”). Validation: Enum: [sglang vllm trtllm] <br />
restart specifies the restart policy for the graph deployment. See Restart. Validation: Optional: {} <br />
topologyConstraint is the deployment-level topology constraint. When<br />set, spec.topologyConstraint.clusterTopologyName names the ClusterTopology<br />CR to use. spec.topologyConstraint.packDomain is optional at this<br />level and can be omitted when only components carry constraints.<br />Components without their own topologyConstraint inherit from this value.
See SpecTopologyConstraint.
Validation: Optional: {} <br />
experimental groups graph-level preview features whose API shape and<br />behavior may change in breaking ways between v1beta1 releases. See DynamoGraphDeploymentExperimentalSpec. Validation: Optional: {} <br />
DynamoGraphDeploymentStatus
DynamoGraphDeploymentStatus defines the observed state of a DynamoGraphDeployment. Unchanged between v1alpha1 and v1beta1.
Kind: type
Appears in: DynamoGraphDeployment
observedGeneration is the most recent generation observed by the controller. Validation: Optional: {} <br />
state is a high-level textual status of the graph deployment lifecycle. See DGDState. Validation: Enum: [initializing pending successful failed] <br />
conditions contains the latest observed conditions of the graph deployment.<br />Merged by type on patch updates. See Condition. Validation: Optional: {} <br />
components contains per-component replica status information, keyed by component name. See ComponentReplicaStatus. Validation: Optional: {} <br />
restart contains the status of a graph-level restart. See RestartStatus. Validation: Optional: {} <br />
checkpoints contains per-component checkpoint status, keyed by component name. See ComponentCheckpointStatus. Validation: Optional: {} <br />
rollingUpdate tracks the progress of operator-managed rolling updates.<br />Currently only supported for single-node, non-Grove deployments (DCD/Deployment). See RollingUpdateStatus. Validation: Optional: {} <br />
placement groups DGD-level scheduler placement signals (score, reporting<br />state, and any future placement fields). See PlacementStatus. Validation: Optional: {} <br />
EPPConfig
EPPConfig contains configuration for EPP (Endpoint Picker Plugin) components.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
configMapRef references a user-provided ConfigMap containing EPP<br />configuration. Mutually exclusive with config.
See ConfigMapKeySelector.
Validation: Optional: {} <br />
config allows specifying EPP EndpointPickerConfig directly as a<br />structured object. The operator marshals this to YAML and creates a<br />ConfigMap automatically. Mutually exclusive with configMapRef. One of<br />configMapRef or config must be specified.
Validation: Type: object <br />Optional: {} <br />
ExperimentalSpec
ExperimentalSpec groups opt-in preview features whose API shape and behavior
may change in breaking ways between v1beta1 releases (including disappearing
without a name-preserving graduation path). Fields placed under
experimental are explicitly NOT covered by the normal v1beta1 deprecation
policy and should not be relied on for production workloads. Features
graduate out of this block (and become first-class fields on the shared
spec) once their API is considered stable.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
gpuMemoryService configures the GPU Memory Service (GMS). When set, GPU<br />access for GMS clients is managed via DRA. See GPUMemoryServiceSpec. Validation: Optional: {} <br />
failover configures active-passive GPU failover for this component.<br />Requires gpuMemoryService to also be set, and failover.mode must<br />match gpuMemoryService.mode (enforced by the validation webhook).
See FailoverSpec.
Validation: Optional: {} <br />
checkpoint configures container-image snapshotting and restore for<br />this component. Set checkpoint.enabled: true to opt in. Without<br />checkpointRef, the DGD controller creates a DGD-scoped DynamoCheckpoint<br />CR and later restores pods in the same DGD generation from that<br />checkpoint. With checkpointRef, the DGD restores from that existing<br />checkpoint instead. The user-facing shape of this field is still settling,<br />which is why it lives under experimental in v1beta1 instead of at the<br />top level.
See ComponentCheckpointConfig.
Validation: Optional: {} <br />
FailoverSpec
FailoverSpec configures active-passive failover for a worker component.
The main container is cloned into two engine containers (active + standby)
sharing GPUs via DRA, and the standby acquires the flock when the active
engine fails. Failover requires that gpuMemoryService is also set, and that
failover.mode matches gpuMemoryService.mode. Also requires the
nvidia.com/dynamo-kube-discovery-mode: container annotation on the DGD.
See ExperimentalSpec for the stability caveat.
Kind: type
Appears in: ExperimentalSpec
mode selects the failover deployment topology. Must match<br />spec.experimental.gpuMemoryService.mode (or<br />spec.components[*].experimental.gpuMemoryService.mode inside a<br />DynamoGraphDeployment).
See GPUMemoryServiceMode.
Validation: Enum: [IntraPod InterPod] <br />Optional: {} <br />
numShadows is the number of shadow (standby) engine containers per<br />rank. Reserved for future use; the operator currently creates exactly<br />one shadow. Validation: Maximum: 1 <br />Minimum: 1 <br />Optional: {} <br />
FeaturesSpec
FeaturesSpec controls optional Dynamo platform features in the generated deployment.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
Planner contains the raw Planner configuration passed to the Planner service.<br />Its schema is defined by dynamo.planner.config.planner_config.PlannerConfig.<br />See Planner Guide.<br />DGDR passes this object through without field-level validation; the Planner<br />service validates it at startup.<br />The presence of this field (non-null) enables the planner in the generated DGD. See RawExtension. Validation: Type: object <br />Optional: {} <br />
Mocker configures the simulated (mocker) backend for testing without GPUs. See MockerSpec. Validation: Optional: {} <br />
GMSClientPodSpec
GMSClientPodSpec declares an additional GMS client pod for inter-pod GMS.
Kind: type
Appears in: GPUMemoryServiceSpec
name identifies this client pod.
Validation: MaxLength: 63 <br />MinLength: 1 <br />Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />
podTemplate configures the pod to run as a GMS client. See PodTemplateSpec. Validation: Schemaless: {} <br />Type: object <br />
GPUMemoryServiceMode
GPUMemoryServiceMode selects the GMS deployment topology.
Kind: enum
Underlying type: string
Appears in: FailoverSpec, GPUMemoryServiceSpec
Allowed values
- IntraPod GMSModeIntraPod runs GMS as a sidecar within the same pod.<br />
- InterPod GMSModeInterPod runs GMS as rank-local pods that share GPUs through DRA.<br />Extra client pod rendering is reserved for a follow-up change.<br />
GPUMemoryServiceSpec
GPUMemoryServiceSpec configures the GPU Memory Service (GMS) for a
worker component. The operator injects GMS wiring and replaces the main
container’s GPU resources with a DRA ResourceClaim for shared GPU access.
See ExperimentalSpec for the stability caveat.
Kind: type
Appears in: ExperimentalSpec
mode selects the GMS deployment topology. See GPUMemoryServiceMode. Validation: Enum: [IntraPod InterPod] <br />Optional: {} <br />
deviceClassName is the DRA DeviceClass to request GPUs from.
Validation: Optional: {} <br />
extraClientContainers lists additional user-declared containers that should<br />be wired as GMS clients in service pods. Checkpoint Job clients are declared<br />under checkpoint.job.gmsClientContainers. In each rendered pod, only<br />matching container names are wired; absent names are ignored.
Validation: items:MaxLength: 63 <br />items:MinLength: 1 <br />items:Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ <br />Optional: {} <br />
extraClientPods declares additional GMS client pods for inter-pod GMS. This field is<br />reserved for future use and is rejected until inter-pod client orchestration is wired. See GMSClientPodSpec. Validation: Optional: {} <br />
GPUSKUType
GPUSKUType is the AIC hardware system identifier for a supported GPU.
Kind: enum
Underlying type: string
Validation: Enum: [gb200_sxm gb10 b200_sxm h200_sxm h100_sxm h100_pcie a100_sxm a100_pcie a30 l40s l40 l4 v100_sxm v100_pcie t4 mi200 mi300]
Appears in: HardwareSpec
Allowed values
- gb200_sxm --- Blackwell ---<br />
- gb10
- b200_sxm
- h200_sxm --- Hopper ---<br />
- h100_sxm
- h100_pcie
- a100_sxm --- Ampere ---<br />
- a100_pcie
- a30
- l40s --- Ada ---<br />
- l40
- l4
- v100_sxm --- Older NVIDIA ---<br />
- v100_pcie
- t4
- mi200 --- AMD ---<br />
- mi300
HardwareSpec
HardwareSpec describes the GPU hardware for profiling and deployment. All fields are auto-detected from cluster GPU nodes when omitted (requires cluster-wide mode with GPU discovery enabled). gpuSku is a selector (restricts which nodes are considered); the other fields are pure overrides passed to the profiler. If all four fields are set, discovery is skipped.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
GPUSKU selects the GPU type to target.<br />When omitted, auto-detected by selecting the GPU with the highest<br />node count, then highest VRAM. In mixed-GPU clusters, set this to<br />choose which GPU type to use. Discovery and totalGpus are then<br />restricted to nodes matching this SKU. See GPUSKUType. Validation: Enum: [gb200_sxm gb10 b200_sxm h200_sxm h100_sxm h100_pcie a100_sxm a100_pcie a30 l40s l40 l4 v100_sxm v100_pcie t4 mi200 mi300] <br />Optional: {} <br />
VRAMMB is the VRAM per GPU in MiB.<br />When omitted, auto-detected from cluster GPU nodes. Validation: Optional: {} <br />
TotalGPUs is the GPU budget for profiling and deployment.<br />The profiler uses this to determine parallelism and replica count.<br />When omitted, computed by counting GPUs on discovered nodes<br />(filtered by gpuSku when set), temporarily capped at 32 to<br />limit profiler search space. This cap may be removed in a future<br />release. Set this field explicitly to override. Validation: Optional: {} <br />
NumGPUsPerNode is the number of GPUs per node.<br />When omitted, auto-detected from cluster GPU nodes. Validation: Optional: {} <br />
Interconnect describes the primary GPU-to-GPU interconnect within a node.<br />Semantics / usage:<br /> - This is capability metadata used for profiling, planning, and deployment decisions.<br /> - It does NOT configure or enable any GPU interconnect; it only describes what is available/assumed.<br /> - When omitted, the operator may attempt best-effort discovery (currently distinguishes “nvlink”<br /> vs “pcie” based on DCGM NVLink link count). If discovery is unavailable, it may remain empty.<br />Impact of wrong / missing values:<br /> - If set more optimistically than reality (e.g., “nvlink” when only PCIe is present), performance<br /> models may overestimate intra-node bandwidth and choose overly aggressive parallelism or layouts,<br /> resulting in degraded performance compared to expectations.<br /> - If set more pessimistically than reality (e.g., “pcie” when NVLink is present), the system may<br /> choose conservative plans and leave performance on the table.<br /> - If unset and undiscovered, consumers should treat the interconnect as unknown and fall back to<br /> conservative assumptions.<br />Example values: “pcie”, “nvlink”. Other values may be accepted but may not be auto-detected. Validation: Optional: {} <br />
RDMA indicates whether the cluster has RDMA-capable networking available for Dynamo data movement.<br />Semantics / usage:<br /> - This is capability metadata used for profiling, planning, and deployment decisions.<br /> - It does NOT install, enable, or configure RDMA (e.g., drivers, SR-IOV, NVIDIA network operator,<br /> GPUDirect settings). It only expresses availability/intent.<br /> - When omitted, the operator may attempt best-effort discovery (e.g., via node labels indicating<br /> RDMA/SR-IOV capability and/or presence of NVIDIA network-operator RDMA components). If discovery<br /> is unavailable, it may remain unset.<br />Impact of wrong / missing values:<br /> - False positive (set true when RDMA is not actually usable end-to-end) may cause plans or<br /> deployments to assume RDMA is available; depending on the runtime transport selection and<br /> fallback behavior, this can lead to connection/setup failures or performance regressions.<br /> - False negative (set false when RDMA is available) will typically avoid RDMA-optimized paths and<br /> fall back to non-RDMA transports, usually remaining functional but potentially slower.<br /> - If unset and undiscovered, consumers should treat RDMA availability as unknown and use<br /> conservative defaults / fallback transports. Validation: Optional: {} <br />
KvTransferEnforcement
KvTransferEnforcement controls how the selected prefill worker’s topology is applied to decode routing.
Kind: enum
Underlying type: string
Validation: Enum: [required preferred]
Appears in: KvTransferPolicy
Allowed values
- required KvTransferEnforcementRequired enforces same-domain decode worker<br />selection.<br />
- preferred KvTransferEnforcementPreferred biases decode worker selection toward the<br />same domain.<br />
KvTransferPolicy
KvTransferPolicy configures topology-aware routing for KV-cache transfers
between prefill and decode workers. This is a graph-wide concern placed
under spec.experimental while the API is incubating.
Kind: type
Appears in: DynamoGraphDeploymentExperimentalSpec
clusterTopologyName references a Grove ClusterTopology CR. The operator<br />reads the CR’s topology levels and projects them through Dynamo-owned pod<br />labels for worker topology metadata. Validation: MinLength: 1 <br />Optional: {} <br />
labelKey is a Kubernetes node label key (e.g.<br />“topology.kubernetes.io/zone”) whose value identifies the topology<br />domain for each worker. The operator copies the node label onto worker<br />pods so the runtime can publish it as worker metadata. The label<br />should correspond to the topology level named in domain.
Validation: MaxLength: 317 <br />MinLength: 1 <br />Pattern: ^(([a-z0-9]([-a-z0-9]\{0,61\}[a-z0-9])?)(\.[a-z0-9]([-a-z0-9]\{0,61\}[a-z0-9])?)*/)?([A-Za-z0-9]([-A-Za-z0-9_.]\{0,61\}[A-Za-z0-9])?)$ <br />Optional: {} <br />
domain is the logical name for the topology level to enforce<br />(e.g. “zone”, “rack”). The router uses this to match workers that<br />share the same value for the label identified by labelKey.
See TopologyDomain.
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ <br />
enforcement controls how the selected prefill worker’s topology is<br />applied to decode routing. “required” only allows decode workers in the<br />same topology domain as the selected prefill worker. “preferred” keeps<br />all decode workers eligible, but biases selection toward workers in the<br />same topology domain. Defaults to “required”. See KvTransferEnforcement. Validation: Enum: [required preferred] <br />Optional: {} <br />
preferredWeight is required and used only when enforcement is<br />“preferred”. Higher values create a stronger same-domain routing<br />preference, but do not guarantee same-domain selection. The value is not<br />a probability; worker selection still depends on load and other routing<br />inputs. A value of 0 disables the topology preference; 1 is the strongest<br />supported preference. Validation: Maximum: 1 <br />Minimum: 0 <br />Optional: {} <br />
MockerSpec
MockerSpec configures the simulated (mocker) backend.
Kind: type
Appears in: FeaturesSpec
Enabled indicates whether to deploy mocker workers instead of real inference workers.<br />Useful for large-scale testing without GPUs. Validation: Optional: {} <br />
ModelCacheSpec
ModelCacheSpec references a PVC containing pre-downloaded model weights.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
PVCName is the name of the PersistentVolumeClaim containing model weights.<br />The PVC must exist in the same namespace as the DGDR. Validation: Optional: {} <br />
PVCModelPath is the path to the model checkpoint directory within the PVC<br />(e.g. “deepseek-r1” or “models/Llama-3.1-405B-FP8”). Validation: Optional: {} <br />
PVCMountPath is the mount path for the PVC inside the container. Validation: Optional: {} <br />
ModelReference
ModelReference identifies a model served by a component. When specified, a headless service is created for endpoint discovery.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
name is the base model identifier (e.g. “llama-3-70b-instruct-v1”). Validation: MinLength: 1 <br />Required: {} <br />
revision is the model revision/version. Validation: Optional: {} <br />
MultinodeSpec
MultinodeSpec configures a multinode component.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
nodeCount is the number of nodes to deploy for the multinode component.<br />Total GPUs used is nodeCount * container GPU request.
Validation: Minimum: 2 <br />Optional: {} <br />
OptimizationType
OptimizationType defines the optimization target for SLA-based profiling.
Kind: enum
Underlying type: string
Validation: Enum: [latency throughput]
Appears in: SLASpec
Allowed values
- latency
- throughput
OverridesSpec
OverridesSpec allows customizing the profiling job and the generated DynamoGraphDeployment.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
ProfilingJob allows overriding the profiling Job specification.<br />Fields set here are merged into the controller-generated Job spec. See JobSpec. Validation: Optional: {} <br />
DGD provides a partial, versioned DynamoGraphDeployment override for the<br />profiler-generated deployment. Set apiVersion to nvidia.com/v1alpha1 or<br />nvidia.com/v1beta1 and kind to DynamoGraphDeployment.<br />The profiler merges the override using the schema for its declared version.<br />If the generated DGD uses another supported version, the complete DGD is<br />converted before the merge and converted back afterward. The final DGD<br />selected or created by a DGDR is nvidia.com/v1beta1.<br />The override can update DGD fields, but topology entries are limited to<br />services or components already present in the generated DGD. Metadata labels<br />and annotations are merged, metadata.name selects the final DGD name, and<br />other identity or runtime metadata is ignored.<br />V1alpha1 worker argument lists retain legacy append behavior. V1beta1 follows<br />structural schema merge behavior, including map-list merging and atomic-list<br />replacement.<br />The raw embedded resource preserves either supported schema. The API server<br />validates that it has apiVersion and kind; override processing validates the<br />DGD kind, supported version, and field schema. See RawExtension. Validation: EmbeddedResource: {} <br />Optional: {} <br />
ParetoConfig
ParetoConfig is retained for compatibility with status objects produced by older profiler releases. Deprecated: The profiler no longer generates Pareto configurations.
Kind: type
Appears in: ProfilingResultsStatus
Config is the full deployment configuration for this Pareto point. See RawExtension. Validation: Type: object <br />
PlacementScoreState
PlacementScoreState describes whether placement score is available and how complete the reported score is for a graph deployment.
Every backend must set this field after the first reconciliation:
- Reported: a score is available for every scored placement unit.
- Partial: a score is available for some but not all placement units.
- Unsupported: the backend does not surface a placement score at all.
- Unknown: the backend supports scores but the current value is indeterminate (e.g. read failure, not yet populated by the scheduler). When set, PlacementStatus.Score must be cleared.
Kind: enum
Underlying type: string
Validation: Enum: [Reported Partial Unsupported Unknown]
Appears in: PlacementStatus
Allowed values
- Reported
- Partial
- Unsupported
- Unknown
PlacementStatus
PlacementStatus groups DGD-level scheduler placement fields under a single status object so future placement signals (e.g. scheduler contract version, last-report timestamp, per-unit reports) can be added without a schema break.
The score source is an open question in DEP #10064 (Grove mirror, typed Grove scheduler API, or unstructured provider). Until a source is selected and implemented, the DGD controller does not write this field; the schema and conversion are landed here so downstream consumers can rely on the shape.
Kind: type
Appears in: DynamoGraphDeploymentStatus
score is the DGD-level scheduler placement score aggregated from<br />relevant scheduler placement units. Normalized to [0.0, 1.0] where higher<br />is better and 1.0 represents the best possible placement. Aggregation<br />uses the minimum across placement units so the value is a worst-placement<br />signal for the graph. Scores are only comparable across DGDs that share<br />the same scheduler scoring contract and version. Validation: Maximum: 1 <br />Minimum: 0 <br />Optional: {} <br />
state indicates placement score reporting state. See PlacementScoreState<br />for the semantics of each value. See PlacementScoreState. Validation: Enum: [Reported Partial Unsupported Unknown] <br />Optional: {} <br />
ProfilingPhase
ProfilingPhase represents a sub-phase within the profiling pipeline. When the DGDR Phase is “Profiling”, this value indicates which step of the profiling pipeline is currently executing.
Kind: enum
Underlying type: string
Validation: Enum: [Initializing SweepingPrefill SweepingDecode SelectingConfig BuildingCurves GeneratingDGD Done]
Appears in: DynamoGraphDeploymentRequestStatus
Allowed values
- Initializing Profiler is loading the DGD template, detecting GPU hardware,<br />and resolving the model architecture from HuggingFace.<br />
- SweepingPrefill Sweeping parallelization strategies (TP/TEP/DEP) across GPU counts<br />for prefill, measuring TTFT at each configuration.<br />
- SweepingDecode Sweeping parallelization strategies and concurrency levels<br />for decode, measuring ITL at each configuration.<br />
- SelectingConfig Filtering results against SLA targets and selecting the most<br />cost-efficient configuration that meets TTFT/ITL requirements.<br />
- BuildingCurves Building detailed interpolation curves (ISL→TTFT for prefill,<br />KV-usage×context-length→ITL for decode) using the selected configs.<br />
- GeneratingDGD Packaging profiling data into a ConfigMap and generating<br />the final DGD YAML with planner integration.<br />
- Done Profiling pipeline finished successfully.<br />
ProfilingResultsStatus
ProfilingResultsStatus contains the output of the profiling process.
Kind: type
Appears in: DynamoGraphDeploymentRequestStatus
Pareto is retained for compatibility with existing status objects.<br />Deprecated: The controller no longer populates this field. See ParetoConfig. Validation: Optional: {} <br />
SelectedConfig is the recommended configuration chosen by the profiler<br />based on the SLA targets. This is the configuration used for deployment<br />when autoApply is true. See RawExtension. Validation: Type: object <br />Optional: {} <br />
Restart
Restart specifies the restart policy for a graph deployment.
Kind: type
Appears in: DynamoGraphDeploymentSpec
id is an arbitrary string that triggers a restart when changed. Any<br />modification to this value initiates a restart of the graph deployment<br />according to the configured strategy. Validation: MinLength: 1 <br />Required: {} <br />
strategy specifies the restart strategy for the graph deployment. See RestartStrategy. Validation: Optional: {} <br />
RestartPhase
RestartPhase enumerates phases of a graph-level restart.
Kind: enum
Underlying type: string
Appears in: RestartStatus
Allowed values
- Pending
- Restarting
- Completed
- Failed
- Superseded
RestartStatus
RestartStatus contains the status of a graph-level restart.
Kind: type
Appears in: DynamoGraphDeploymentStatus
observedID is the restart ID currently being processed. Matches Restart.id in the spec.
phase is the phase of the restart. See RestartPhase.
inProgress contains the names of the components currently being restarted. Validation: Optional: {} <br />
RestartStrategy
RestartStrategy defines how components are restarted.
Kind: type
Appears in: Restart
type specifies the restart strategy type. See RestartStrategyType. Validation: Enum: [Sequential Parallel] <br />Optional: {} <br />
order is the complete ordered set of component names for sequential<br />restarts. Omit or leave empty to use the controller’s default order.<br />This field must not be set for parallel restarts. Validation: Optional: {} <br />
RestartStrategyType
RestartStrategyType enumerates restart strategies.
Kind: enum
Underlying type: string
Appears in: RestartStrategy
Allowed values
- Sequential
- Parallel
RollingUpdatePhase
RollingUpdatePhase represents the current phase of a rolling update.
Kind: enum
Underlying type: string
Validation: Enum: [Pending InProgress Completed Failed ]
Appears in: RollingUpdateStatus
Allowed values
- Pending
- InProgress
- Completed
- Failed
- “
RollingUpdateStatus
RollingUpdateStatus tracks the progress of an operator-managed rolling update.
Kind: type
Appears in: DynamoGraphDeploymentStatus
phase indicates the current phase of the rolling update. See RollingUpdatePhase. Validation: Enum: [Pending InProgress Completed Failed ] <br />Optional: {} <br />
startTime is when the rolling update began. See Time. Validation: Optional: {} <br />
endTime is when the rolling update completed (successfully or failed). See Time. Validation: Optional: {} <br />
updatedComponents is the list of components that have completed the<br />rolling update. Validation: Optional: {} <br />
SLASpec
SLASpec defines the service-level agreement targets for profiling optimization.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
TTFT is the Time To First Token target in milliseconds. Validation: Optional: {} <br />
ITL is the Inter-Token Latency target in milliseconds. Validation: Optional: {} <br />
E2ELatency is the target end-to-end request latency in milliseconds.<br />Alternative to specifying TTFT + ITL. Validation: Optional: {} <br />
OptimizationType is the optimization target for SLA profiling.<br />Valid values: latency, throughput. See OptimizationType. Validation: Enum: [latency throughput] <br />Optional: {} <br />
ScalingAdapter
ScalingAdapter opts a component into using the DynamoGraphDeploymentScalingAdapter
(DGDSA). When scalingAdapter is set on a component (even as an empty
object, scalingAdapter: {}), the DGDSA is created and owns the replicas
field so that external autoscalers (HPA/KEDA/Planner) can drive scaling via
the Scale subresource. Omitting the field opts the component out.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
SearchStrategy
SearchStrategy controls the profiling search depth.
Kind: enum
Underlying type: string
Validation: Enum: [rapid thorough]
Appears in: DynamoGraphDeploymentRequestSpec
Allowed values
- rapid
- thorough
SpecTopologyConstraint
SpecTopologyConstraint defines deployment-level topology placement requirements.
Kind: type
Appears in: DynamoGraphDeploymentSpec
clusterTopologyName is the name of the ClusterTopology resource that<br />defines the topology hierarchy for this deployment. Validation: MinLength: 1 <br />
packDomain is the default topology domain to pack pods within.<br />Optional; omit when only components carry constraints.
See TopologyDomain.
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ <br />Optional: {} <br />
TopologyConstraint
TopologyConstraint defines component-level topology placement requirements.
The topology profile is inherited from the deployment-level
SpecTopologyConstraint.
Kind: type
Appears in: DynamoComponentDeploymentSharedSpec, DynamoComponentDeploymentSpec
packDomain is the topology domain to pack pods within. Must match a<br />domain defined in the referenced ClusterTopology CR.
See TopologyDomain.
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$ <br />
TopologyDomain
TopologyDomain is a free-form topology level identifier.
Common examples: “region”, “zone”, “datacenter”, “block”, “rack”, “host”, “numa”.
When used with a ClusterTopology CR, domain names are defined in the CR’s
hierarchy; when used with spec.experimental.kvTransferPolicy.labelKey
alone, the value is a user-chosen logical name for the topology level.
Kind: type
Underlying type: string
Validation: Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
Appears in: KvTransferPolicy, SpecTopologyConstraint, TopologyConstraint
WorkloadSpec
WorkloadSpec defines the workload characteristics for SLA-based profiling.
Kind: type
Appears in: DynamoGraphDeploymentRequestSpec
ISL is the Input Sequence Length (number of tokens). Validation: Optional: {} <br />
OSL is the Output Sequence Length (number of tokens). Validation: Optional: {} <br />
Concurrency is the target concurrency level.<br />Required (or RequestRate) when the planner is disabled. Validation: Optional: {} <br />
RequestRate is the target request rate (req/s).<br />Required (or Concurrency) when the planner is disabled. Validation: Optional: {} <br />
operator.config.dynamo.nvidia.com/v1alpha1
Resource Types
CertProvisionMode
CertProvisionMode controls how webhook TLS certificates are managed.
Kind: enum
Underlying type: string
Appears in: WebhookServer
Allowed values
- auto CertProvisionModeAuto uses the built-in cert-controller to generate and rotate certificates.<br />
- manual CertProvisionModeManual expects certificates to be provided externally (e.g., cert-manager, admin).<br />
CheckpointConfiguration
CheckpointConfiguration holds checkpoint/restore settings.
Kind: type
Appears in: OperatorConfiguration
Enabled indicates if checkpoint functionality is enabled
Seccomp controls the localhost seccomp profile applied to checkpoint and<br />restore pods. A nil value means “use the default profile”; set<br />Seccomp.Disabled=true to disable seccomp injection entirely. See CheckpointSeccompConfiguration.
Storage optionally configures the namespace-local checkpoint PVC that<br />workload pods mount. When omitted, the operator preserves the legacy<br />behavior of discovering storage from a snapshot-agent DaemonSet in the<br />workload namespace. See CheckpointStorageConfiguration.
CleanupImage is the image used by best-effort artifact cleanup Jobs for<br />automatically-created checkpoints. It must provide a POSIX shell and rm.
CheckpointOCIConfig
Deprecated: CheckpointOCIConfig is retained for compatibility and ignored by the current snapshot flow.
Kind: type
Appears in: CheckpointStorageConfiguration
URI is the legacy OCI URI (oci://registry/repository).
CredentialsSecretRef is the legacy docker config secret name.
CheckpointPVCConfig
CheckpointPVCConfig configures the namespace-local PVC mounted into checkpoint and restore workload pods.
Kind: type
Appears in: CheckpointStorageConfiguration
PVCName is the PVC name in each workload namespace.
BasePath is the mount path inside checkpoint and restore workload pods.
Create tells the operator to create the PVC in workload namespaces when<br />it is missing. When false, the PVC must already exist.
Size is the storage request used when Create is true.
StorageClassName is the optional StorageClass name used when Create is true.
AccessMode is the PVC access mode used when Create is true.
CheckpointS3Config
Deprecated: CheckpointS3Config is retained for compatibility and ignored by the current snapshot flow.
Kind: type
Appears in: CheckpointStorageConfiguration
URI is the legacy S3 URI (s3://[endpoint/]bucket/prefix).
CredentialsSecretRef is the legacy credentials secret name.
CheckpointSeccompConfiguration
CheckpointSeccompConfiguration controls the localhost seccomp profile applied to checkpoint and restore pods. The profile blocks io_uring syscalls (which CRIU cannot dump). Default behavior (zero-value substruct, or absent substruct) applies DefaultSeccompProfile. Set Disabled=true on OpenShift (custom localhost profiles require privileged SCC) or when using a CRIU build with io_uring support. Set Profile to override the default path.
Kind: type
Appears in: CheckpointConfiguration
Disabled, when true, suppresses seccomp profile injection entirely.<br />Use this for clusters where custom localhost profiles are not allowed<br />(e.g. OpenShift’s restricted-v2 SCC) or for CRIU builds that handle<br />io_uring natively.
Profile is the localhost seccomp profile path. Empty falls back to<br />DefaultSeccompProfile. Ignored when Disabled is true.
CheckpointStorageConfiguration
CheckpointStorageConfiguration configures checkpoint storage for operator pod mutations. Only PVC storage is implemented today.
Kind: type
Appears in: CheckpointConfiguration
Type is the storage backend type. Only pvc is implemented today.
PVC configuration for pvc-based settings. See CheckpointPVCConfig.
Deprecated: S3 is retained for compatibility and ignored. See CheckpointS3Config.
Deprecated: OCI is retained for compatibility and ignored. See CheckpointOCIConfig.
DRAConfiguration
DRAConfiguration holds Dynamic Resource Allocation (resource.k8s.io/v1) settings.
NOTE: auto-detection here only verifies that the resource.k8s.io/v1 API is
registered on the apiserver (Kubernetes 1.34+). It does NOT verify that a
GPU-specific DRA resource driver (e.g. nvidia/k8s-dra-driver-gpu) is
installed, that its DeviceClass exists, or that node-level GPU drivers are
compatible. An admin can use enabled: false to force-off DRA integration
on clusters where the API is present but the GPU driver stack is not wired
up — this makes the operator fail GMS / inter-pod failover admissions early
with a clear error instead of letting pods Pend with a confusing
“resourceclaim not found” at schedule time.
Kind: type
Appears in: OperatorConfiguration
Enabled overrides auto-detection of the resource.k8s.io/v1 API.<br />nil = auto-detect. Setting true requires detection to also succeed (the<br />operator will exit at startup otherwise).
DiscoveryBackend
DiscoveryBackend is the type for the discovery backend.
Kind: enum
Underlying type: string
Appears in: DiscoveryConfiguration
Allowed values
- kubernetes DiscoveryBackendKubernetes is the Kubernetes discovery backend<br />
- etcd DiscoveryBackendEtcd is the etcd discovery backend<br />
DiscoveryConfiguration
DiscoveryConfiguration holds discovery backend settings.
Kind: type
Appears in: OperatorConfiguration
Backend is the discovery backend: “kubernetes” or “etcd” See DiscoveryBackend.
GPUConfiguration
GPUConfiguration holds GPU discovery settings.
Kind: type
Appears in: OperatorConfiguration
DiscoveryEnabled indicates whether GPU discovery is enabled
GroveConfiguration
GroveConfiguration holds Grove orchestrator settings.
Kind: type
Appears in: OrchestratorConfiguration
Enabled overrides auto-detection. nil = auto-detect.
TerminationDelay configures the termination delay for Grove PodCliqueSets See Duration.
InfrastructureConfiguration
InfrastructureConfiguration holds service mesh and backend addresses.
Kind: type
Appears in: OperatorConfiguration
NATSAddress is the address of the NATS server
ETCDAddress is the address of the etcd server
ModelExpressURL is the URL of the Model Express server to inject into all pods
PrometheusEndpoint is the URL of the Prometheus endpoint to use for metrics
IngressConfiguration
IngressConfiguration holds ingress settings.
Kind: type
Appears in: OperatorConfiguration
VirtualServiceGateway is the name of the Istio virtual service gateway
ControllerClassName is the ingress controller class name
ControllerTLSSecretName is the TLS secret for the ingress controller
HostSuffix is the suffix for ingress hostnames
IstioMeshConfiguration
IstioMeshConfiguration holds Istio-specific mesh settings.
Kind: type
Appears in: ServiceMeshConfiguration
TLSMode is the Istio TLS mode for DestinationRules.<br />Supported values: “DISABLE”, “SIMPLE”, “ISTIO_MUTUAL”, “MUTUAL”.<br />Defaults to “SIMPLE”.
InsecureSkipVerify skips TLS certificate verification in DestinationRules.<br />Defaults to true (matching upstream GAIE behavior with self-signed certs).
ClientCertificate is the path (in the istio-proxy sidecar’s filesystem)<br />to the file holding the client-side TLS certificate used for mTLS.<br />REQUIRED when TLSMode is “MUTUAL”; ignored for other modes.
PrivateKey is the path (in the istio-proxy sidecar’s filesystem) to the<br />file holding the client-side TLS private key used for mTLS.<br />REQUIRED when TLSMode is “MUTUAL”; ignored for other modes.
CaCertificates is the optional path (in the istio-proxy sidecar’s<br />filesystem) to the file holding CA certificates used to verify the<br />server certificate. Used only when TLSMode is “MUTUAL”; for other modes<br />the field is ignored.
KaiSchedulerConfiguration
KaiSchedulerConfiguration holds Kai-scheduler settings.
Kind: type
Appears in: OrchestratorConfiguration
Enabled overrides auto-detection. nil = auto-detect.
LWSConfiguration
LWSConfiguration holds LWS orchestrator settings.
Kind: type
Appears in: OrchestratorConfiguration
Enabled overrides auto-detection. nil = auto-detect.
LeaderElectionConfiguration
LeaderElectionConfiguration holds leader election settings.
Kind: type
Appears in: OperatorConfiguration
Enabled enables leader election for controller manager
ID is the leader election resource identity
Namespace is the namespace for the leader election resource
LoggingConfiguration
LoggingConfiguration holds logging settings.
Kind: type
Appears in: OperatorConfiguration
Level is the log level (e.g., “info”, “debug”)
Format is the log format (e.g., “json”, “text”)
MPIConfiguration
MPIConfiguration holds MPI SSH secret settings.
Kind: type
Appears in: OperatorConfiguration
SSHSecretName is the name of the secret containing the SSH key for MPI
SSHSecretNamespace is the namespace where the MPI SSH secret is located
MetricsServer
MetricsServer extends Server with secure serving option.
Kind: type
Appears in: ServerConfiguration
BindAddress is the address the server binds to
Port is the port the server listens on
Secure enables secure serving for the metrics endpoint.<br />nil = default to true (secure by default).
NamespaceConfiguration
NamespaceConfiguration determines operator namespace mode.
Kind: type
Appears in: OperatorConfiguration
Restricted enables namespace-restricted mode for development and testing.<br />Namespace-restricted mode is not supported for production.
Scope configures the namespace ownership claim in namespace-restricted mode. See NamespaceScopeConfiguration.
NamespaceScopeConfiguration
NamespaceScopeConfiguration configures the development/test namespace ownership claim.
Kind: type
Appears in: NamespaceConfiguration
LeaseDuration is the duration of namespace scope marker lease before expiration See Duration.
LeaseRenewInterval is the interval for renewing namespace scope marker lease See Duration.
OperatorConfiguration
OperatorConfiguration is the Schema for the operator configuration.
Kind: resource
operator.config.dynamo.nvidia.com/v1alpha1
OperatorConfiguration
Server configuration (metrics, health probes, webhooks) See ServerConfiguration.
Leader election configuration See LeaderElectionConfiguration.
Namespace configuration (restricted vs cluster-wide) See NamespaceConfiguration.
Orchestrator configuration with optional overrides See OrchestratorConfiguration.
DRA (Dynamic Resource Allocation) settings with optional override See DRAConfiguration.
Service mesh and infrastructure addresses See InfrastructureConfiguration.
Ingress configuration See IngressConfiguration.
ServiceMesh configures automatic generation of service-mesh resources<br />(e.g., Istio DestinationRules) for EPP components. See ServiceMeshConfiguration.
RBAC configuration for cross-namespace resource management (cluster-wide mode) See RBACConfiguration.
MPI SSH secret configuration See MPIConfiguration.
Checkpoint/restore configuration See CheckpointConfiguration.
Discovery backend configuration See DiscoveryConfiguration.
GPU discovery configuration See GPUConfiguration.
Logging configuration See LoggingConfiguration.
HTTP/2 and TLS settings See SecurityConfiguration.
OrchestratorConfiguration
OrchestratorConfiguration holds orchestrator override settings.
Kind: type
Appears in: OperatorConfiguration
Grove orchestrator configuration See GroveConfiguration.
LWS orchestrator configuration See LWSConfiguration.
KaiScheduler configuration See KaiSchedulerConfiguration.
VolcanoScheduler configuration See VolcanoSchedulerConfiguration.
RBACConfiguration
RBACConfiguration holds RBAC settings for cluster-wide mode.
Kind: type
Appears in: OperatorConfiguration
PlannerClusterRoleName is the ClusterRole for planner
DGDRProfilingClusterRoleName is the ClusterRole for DGDR profiling jobs
EPPClusterRoleName is the ClusterRole for EPP
SecurityConfiguration
SecurityConfiguration holds HTTP/2 and TLS settings.
Kind: type
Appears in: OperatorConfiguration
EnableHTTP2 enables HTTP/2 for metrics and webhook servers
Server
Server holds a bind address and port.
Kind: type
Appears in: MetricsServer, ServerConfiguration, WebhookServer
BindAddress is the address the server binds to
Port is the port the server listens on
ServerConfiguration
ServerConfiguration holds server bind addresses and ports.
Kind: type
Appears in: OperatorConfiguration
Metrics server configuration See MetricsServer.
Health probe server configuration See Server.
Webhook server configuration See WebhookServer.
ServiceMeshConfiguration
ServiceMeshConfiguration holds service mesh integration settings. The operator uses this to generate mesh-specific resources (e.g., Istio DestinationRules) for EPP components so that sidecar proxies connect correctly without double-TLS issues.
Kind: type
Appears in: OperatorConfiguration
Enabled overrides service mesh auto-detection. nil = auto-detect.
Provider selects the service mesh implementation. Supported: “istio”, "".<br />Empty string disables service mesh resource generation.
Istio holds Istio-specific settings. Only used when Provider is “istio”. See IstioMeshConfiguration.
VolcanoSchedulerConfiguration
VolcanoSchedulerConfiguration holds Volcano scheduler settings.
Kind: type
Appears in: OrchestratorConfiguration
EXPERIMENTAL: Enabled controls Volcano scheduler integration for Grove PodCliqueSets.
WebhookServer
WebhookServer extends Server with host and certificate directory.
Kind: type
Appears in: ServerConfiguration
BindAddress is the address the server binds to
Port is the port the server listens on
Host is the address the webhook server binds to
CertDir is the directory containing TLS certificates
CertProvisionMode controls certificate management: “auto” (built-in cert-controller) or “manual” (external) See CertProvisionMode.
SecretName is the name of the Kubernetes Secret holding webhook TLS certificates
ServiceName is the name of the Kubernetes Service fronting the webhook server.<br />Used to generate certificate SANs. Set by the Helm chart.
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.
-
Security Context: All components receive
fsGroup: 1000by default to ensure proper file permissions for mounted volumes. This can be overridden via theextraPodSpec.securityContextfield. -
Shared Memory: All components receive an 8Gi shared memory volume mounted at
/dev/shmby default (can be disabled or resized via thesharedMemoryfield). -
Environment Variables: Components automatically receive environment variables like
DYN_NAMESPACE,DYN_PARENT_DGD_K8S_NAME,DYNAMO_PORT, and backend-specific variables. -
Pod Configuration: Default
terminationGracePeriodSecondsof 60 seconds andrestartPolicy: 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:60secondsrestartPolicy:Always
Security Context
The operator automatically applies default security context settings to all components to ensure proper file permissions, particularly for mounted volumes:
fsGroup:1000- Sets the group ownership of mounted volumes and any files created in those volumes
This default ensures that non-root containers can write to mounted volumes (like model caches or persistent storage) without permission issues. The fsGroup setting is particularly important for:
- Model downloads and caching
- Compilation cache directories
- Persistent volume claims (PVCs)
- SSH key generation in multinode deployments
Overriding Security Context
To override the default security context, specify your own securityContext in the extraPodSpec of your component:
Important: When you provide any securityContext object in extraPodSpec, the operator will not inject any defaults. This gives you complete control over the security context, including the ability to run as root (by omitting runAsNonRoot or setting it to false).
OpenShift and Security Context Constraints
In OpenShift environments with Security Context Constraints (SCCs), you may need to omit explicit UID/GID values to allow OpenShift’s admission controllers to assign them dynamically:
Alternatively, if you want to keep the default fsGroup: 1000 behavior and are certain your cluster allows it, you don’t need to specify anything - the operator defaults will work.
Shared Memory Configuration
Shared memory is enabled by default for all components:
- Enabled:
true(unless explicitly disabled viasharedMemory.disabled) - Size:
8Gi - Mount Path:
/dev/shm - Volume Type:
emptyDirwithmemorymedium
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
The operator automatically applies distributed execution configuration based on parallelism settings:
Tensor/Pipeline Parallel Mode (Recommended) (when world_size > GPUs_per_node):
- Uses PyTorch multiprocessing (mp) backend for distributed execution (
--distributed-executor-backend mp) - Supports multi-node deployments with PyTorch’s native distributed initialization
- All nodes: Run vLLM with proper
--nnodes,--node-rank,--master-addrflags injected - Probes: Worker probes adjusted; leader probes remain active
Ray Backend:
- Used for use cases such as Elastic EP
- Install with
pip install "ray>=2.55.0"and configure--distributed-executor-backend ray
Data Parallel Mode (when world_size × data_parallel_size > GPUs_per_node):
- Worker nodes: All probes (liveness, readiness, startup) are removed
- Leader nodes: All probes remain active
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 into component containers based on component type, backend framework, and operator configuration. User-provided envs values always take precedence over operator defaults.
All Components
These environment variables are injected into every component container regardless of type.
Infrastructure (Conditional)
These are injected into all components when the corresponding infrastructure service is configured in the operator’s OperatorConfiguration.
Frontend Components
Worker Components
Planner Components
EPP (Endpoint Picker Plugin) Components
VLLM Backend
TensorRT-LLM Backend
Service Accounts
The following component types automatically receive dedicated service accounts:
- Planner:
planner-serviceaccount - EPP:
epp-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:
- Scans all Kubernetes secrets of type
kubernetes.io/dockerconfigjsonin the component’s namespace - Extracts the docker registry server URLs from each secret’s authentication configuration
- Matches the container image’s registry host against the discovered registry URLs
- Automatically injects matching secrets as
imagePullSecretsin 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:
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 (system)
- Protocol: TCP
- Name:
system - Port: 19090 (NIXL)
- Protocol: TCP
- Name:
nixl
Planner Components
- Port: 9085
- Protocol: TCP
- Name:
metrics
EPP Components
- Port: 9002 (gRPC)
- Protocol: TCP
- Name:
grpc - Port: 9003 (gRPC health)
- Protocol: TCP
- Name:
grpc-health - Port: 9090 (metrics)
- Protocol: TCP
- Name:
metrics
Backend-Specific Configurations
VLLM
- Ray Head Port: 6379 (for Ray-based multinode deployments)
- MP Master Port: 29500 (for PyTorch distributed multinode TP/PP deployments with mp backend)
- Data Parallel RPC Port: 13445 (for data parallel 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, Security Context & Pod Specifications:
internal/dynamo/graph.go- Contains the main logic for applying default probes, security context, environment variables, shared memory, and pod configurations - Component-Specific Defaults:
internal/dynamo/component_common.go- Base container and pod spec shared by all component typesinternal/dynamo/component_frontend.gointernal/dynamo/component_worker.gointernal/dynamo/component_planner.gointernal/dynamo/component_epp.go
- Image Pull Secrets:
internal/secrets/docker.go- Implements the docker secret indexer and automatic discovery - Backend-Specific Behavior:
- Checkpoint / Restore:
internal/checkpoint/podspec.go- Checkpoint env var injection and volume setupinternal/checkpoint/resolve.go- Checkpoint resolution logicinternal/checkpoint/resource.go- Checkpoint resource management
- Constants & Annotations:
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, orstartupProbefields) take precedence over operator defaults - For security context, if you provide any
securityContextinextraPodSpec, no defaults will be injected, giving you full control - For multinode deployments, some defaults are modified or removed as described above to accommodate distributed execution patterns
- The
extraPodSpec.mainContainerfield can be used to override probe configurations set by the operator
Raw generated Markdown source: docs/fern/kubernetes/api-reference.md