-
Notifications
You must be signed in to change notification settings - Fork 523
Add GPUCluster CRD and controller for DRA-based stack #2571
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
64b69c9
dbb9947
63ab1fa
16f0d53
da52abc
b0803b4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| /** | ||
| # Copyright (c) NVIDIA CORPORATION. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| **/ | ||
|
|
||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
|
|
||
| nvidiav1 "github.com/NVIDIA/gpu-operator/api/nvidia/v1" | ||
| ) | ||
|
|
||
| const ( | ||
| GPUClusterCRDName = "GPUCluster" | ||
| ) | ||
|
|
||
| const ( | ||
| // Ignored marks a duplicate GPUCluster that the singleton controller does not reconcile. | ||
| Ignored State = "ignored" | ||
| ) | ||
|
|
||
| // NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. | ||
|
|
||
| // GPUClusterSpec defines the desired state of GPUCluster, the DRA-based | ||
| // software-enablement stack. Unlike ClusterPolicy, it does not manage the NVIDIA driver | ||
| // or the device-plugin; the driver is installed separately (host-installed or via an | ||
| // NVIDIADriver CR) and GPUCluster waits for driver readiness before proceeding. | ||
| type GPUClusterSpec struct { | ||
| // DRADriver defines the spec for the NVIDIA DRA driver stack (gpus + computeDomains). | ||
| DRADriver DRADriverSpec `json:"draDriver"` | ||
|
|
||
| // DCGM defines the spec for the standalone NVIDIA DCGM hostengine. Disabled by default; | ||
| // when disabled, dcgm-exporter uses its embedded nv-hostengine. NOTE: the reused enabled | ||
| // field carries no server-side default and its IsEnabled() treats nil as enabled, so the | ||
| // controller must default nil enabled to disabled here. | ||
| DCGM *nvidiav1.DCGMSpec `json:"dcgm,omitempty"` | ||
|
|
||
| // DCGMExporter defines the spec for NVIDIA DCGM Exporter. Enabled by default, but the | ||
| // reused enabled field carries no server-side default; the controller defaults nil enabled. | ||
| DCGMExporter *nvidiav1.DCGMExporterSpec `json:"dcgmExporter,omitempty"` | ||
|
|
||
| // GFD defines the spec for the standalone GPU Feature Discovery operand. Enabled by default, | ||
| // but the reused enabled field carries no server-side default; the controller defaults nil enabled. | ||
| GFD *nvidiav1.GPUFeatureDiscoverySpec `json:"gfd,omitempty"` | ||
|
Comment on lines
+54
to
+56
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As discussed with @shivamerla, let's omit GFD for now. We can add it to the |
||
|
|
||
| // HostPaths defines the host paths used in host-path volumes for various components. | ||
| HostPaths nvidiav1.HostPathsSpec `json:"hostPaths,omitempty"` | ||
|
|
||
| // Daemonsets defines the common configuration applied to all DaemonSets deployed | ||
| // by the GPUCluster controller. | ||
| Daemonsets nvidiav1.DaemonsetsSpec `json:"daemonsets,omitempty"` | ||
| } | ||
|
|
||
| // DRADriverSpec defines the spec for the NVIDIA DRA driver stack. There is no top-level | ||
| // enabled toggle; enablement is per capability (gpus / computeDomains). | ||
| type DRADriverSpec struct { | ||
| // NVIDIA DRA driver image repository | ||
| Repository string `json:"repository,omitempty"` | ||
|
|
||
| // NVIDIA DRA driver image name | ||
| // +kubebuilder:validation:Pattern=^[a-zA-Z0-9\-]+$ | ||
| Image string `json:"image,omitempty"` | ||
|
|
||
| // NVIDIA DRA driver image tag | ||
| Version string `json:"version,omitempty"` | ||
|
|
||
| // Image pull policy | ||
| ImagePullPolicy string `json:"imagePullPolicy,omitempty"` | ||
|
|
||
| // Image pull secrets | ||
| ImagePullSecrets []string `json:"imagePullSecrets,omitempty"` | ||
|
|
||
| // FeatureGates is a map of feature gate names to a boolean enabling or disabling each. | ||
| // It is rendered as the FEATURE_GATES environment variable on the DRA driver containers. | ||
| FeatureGates map[string]bool `json:"featureGates,omitempty"` | ||
|
|
||
| // GPUs configures the gpu.nvidia.com capability of the DRA driver. | ||
| GPUs DRADriverGPUsSpec `json:"gpus,omitempty"` | ||
|
|
||
| // ComputeDomains configures the compute-domain capability of the DRA driver. | ||
| ComputeDomains DRADriverComputeDomainsSpec `json:"computeDomains,omitempty"` | ||
| } | ||
|
|
||
| // IsGPUsEnabled returns true if the gpus capability of the DRA driver is enabled. | ||
| func (d *DRADriverSpec) IsGPUsEnabled() bool { | ||
| return d.GPUs.Enabled != nil && *d.GPUs.Enabled | ||
| } | ||
|
|
||
| // IsComputeDomainsEnabled returns true if the computeDomains capability of the DRA driver is enabled. | ||
| func (d *DRADriverSpec) IsComputeDomainsEnabled() bool { | ||
| return d.ComputeDomains.Enabled != nil && *d.ComputeDomains.Enabled | ||
| } | ||
|
|
||
| // DRADriverGPUsSpec configures the gpus capability of the DRA driver. It maps onto the | ||
| // gpus container of the upstream kubelet-plugin DaemonSet. | ||
| type DRADriverGPUsSpec struct { | ||
| // Enabled indicates if the gpus capability of the DRA driver is enabled. | ||
| // +kubebuilder:default=true | ||
| Enabled *bool `json:"enabled,omitempty"` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This was pointed out by @rajathagasthya in the design doc, but I believe we can remove this field. The |
||
|
|
||
| // KubeletPlugin configures the kubelet-plugin workload for the gpus capability. | ||
| KubeletPlugin DRADriverKubeletPluginSpec `json:"kubeletPlugin,omitempty"` | ||
| } | ||
|
|
||
| // DRADriverComputeDomainsSpec configures the computeDomains capability of the DRA driver. | ||
| // The kubeletPlugin maps onto the computeDomains container of the upstream kubelet-plugin | ||
| // DaemonSet; the controller is a separate Deployment. | ||
| type DRADriverComputeDomainsSpec struct { | ||
| // Enabled indicates if the computeDomains capability of the DRA driver is enabled. | ||
| // +kubebuilder:default=true | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @shivamerla are you okay if we enable compute domains by default? |
||
| Enabled *bool `json:"enabled,omitempty"` | ||
|
|
||
| // Controller configures the compute-domain controller Deployment. | ||
| Controller DRADriverControllerSpec `json:"controller,omitempty"` | ||
|
|
||
| // KubeletPlugin configures the kubelet-plugin workload for the computeDomains capability. | ||
| KubeletPlugin DRADriverKubeletPluginSpec `json:"kubeletPlugin,omitempty"` | ||
| } | ||
|
|
||
| // DRADriverKubeletPluginSpec configures a DRA driver kubelet-plugin container. The gpus and | ||
| // computeDomains blocks map onto the two containers of a single kubelet-plugin DaemonSet. | ||
| // Scheduling is opinionated and not configurable here. | ||
| type DRADriverKubeletPluginSpec struct { | ||
| // Optional: List of environment variables | ||
| Env []nvidiav1.EnvVar `json:"env,omitempty"` | ||
|
|
||
| // Optional: Define resources requests and limits for the kubelet-plugin container | ||
| Resources *nvidiav1.ResourceRequirements `json:"resources,omitempty"` | ||
|
|
||
| // HealthcheckPort is the port running a gRPC health service checked by a livenessProbe. | ||
| // Set to a negative value to disable the service and the probe. | ||
| HealthcheckPort *int32 `json:"healthcheckPort,omitempty"` | ||
| } | ||
|
|
||
| // DRADriverControllerSpec defines configuration for the compute-domain controller Deployment. | ||
| // Scheduling is opinionated and not configurable here. | ||
| type DRADriverControllerSpec struct { | ||
| // Optional: List of environment variables | ||
| Env []nvidiav1.EnvVar `json:"env,omitempty"` | ||
|
|
||
| // Optional: Define resources requests and limits for the controller container | ||
| Resources *nvidiav1.ResourceRequirements `json:"resources,omitempty"` | ||
| } | ||
|
|
||
| // GPUClusterStatus defines the observed state of GPUCluster | ||
| type GPUClusterStatus struct { | ||
| // +kubebuilder:validation:Enum=ignored;ready;notReady;disabled | ||
| // State indicates the status of the GPUCluster instance | ||
| State State `json:"state"` | ||
| // Namespace indicates the namespace in which the operator and operands are installed | ||
| Namespace string `json:"namespace,omitempty"` | ||
| // Conditions is a list of conditions representing the GPUCluster's current state. | ||
| Conditions []metav1.Condition `json:"conditions,omitempty"` | ||
| } | ||
|
|
||
| // +genclient | ||
| // +genclient:nonNamespaced | ||
| //+kubebuilder:object:root=true | ||
| //+kubebuilder:subresource:status | ||
| //+kubebuilder:resource:scope=Cluster,shortName={"gc"} | ||
| //+kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.state`,priority=0 | ||
| //+kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`,priority=0 | ||
|
|
||
| // GPUCluster is the Schema for the gpuclusters API | ||
| type GPUCluster struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| Spec GPUClusterSpec `json:"spec,omitempty"` | ||
| Status GPUClusterStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| //+kubebuilder:object:root=true | ||
|
|
||
| // GPUClusterList contains a list of GPUCluster | ||
| type GPUClusterList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
| Items []GPUCluster `json:"items"` | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cdesiniotis @shivamerla Do we want to enable DCGM by default? Something to think about given that we may need to integrate NVSentinel into our operand stack. Changing the default later on may not be as easy