• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

NVIDIA / gpu-operator / 30655041468

31 Jul 2026 06:24PM UTC coverage: 38.468% (-0.3%) from 38.791%
30655041468

push

github

web-flow
Merge pull request #2705 from cdesiniotis/fix-unit-test-gpucluster-render

fix failing unit test TestGPUClusterRenderGolden

5576 of 14495 relevant lines covered (38.47%)

0.44 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

51.79
/controllers/gpucluster_controller.go
1
/**
2
# Copyright (c) NVIDIA CORPORATION.  All rights reserved.
3
#
4
# Licensed under the Apache License, Version 2.0 (the "License");
5
# you may not use this file except in compliance with the License.
6
# You may obtain a copy of the License at
7
#
8
#     http://www.apache.org/licenses/LICENSE-2.0
9
#
10
# Unless required by applicable law or agreed to in writing, software
11
# distributed under the License is distributed on an "AS IS" BASIS,
12
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
# See the License for the specific language governing permissions and
14
# limitations under the License.
15
**/
16

17
package controllers
18

19
import (
20
        "context"
21
        "fmt"
22
        "strings"
23
        "time"
24

25
        appsv1 "k8s.io/api/apps/v1"
26
        corev1 "k8s.io/api/core/v1"
27
        apierrors "k8s.io/apimachinery/pkg/api/errors"
28
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
29
        "k8s.io/apimachinery/pkg/runtime"
30
        "k8s.io/apimachinery/pkg/types"
31
        "k8s.io/client-go/tools/events"
32
        "k8s.io/client-go/util/workqueue"
33
        ctrl "sigs.k8s.io/controller-runtime"
34
        "sigs.k8s.io/controller-runtime/pkg/client"
35
        "sigs.k8s.io/controller-runtime/pkg/controller"
36
        "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
37
        "sigs.k8s.io/controller-runtime/pkg/handler"
38
        "sigs.k8s.io/controller-runtime/pkg/log"
39
        "sigs.k8s.io/controller-runtime/pkg/predicate"
40
        "sigs.k8s.io/controller-runtime/pkg/reconcile"
41
        "sigs.k8s.io/controller-runtime/pkg/source"
42

43
        gpuv1 "github.com/NVIDIA/gpu-operator/api/nvidia/v1"
44
        nvidiav1alpha1 "github.com/NVIDIA/gpu-operator/api/nvidia/v1alpha1"
45
        "github.com/NVIDIA/gpu-operator/controllers/clusterinfo"
46
        "github.com/NVIDIA/gpu-operator/internal/conditions"
47
        "github.com/NVIDIA/gpu-operator/internal/consts"
48
        "github.com/NVIDIA/gpu-operator/internal/state"
49
        "github.com/NVIDIA/gpu-operator/internal/utils"
50
)
51

52
// gpuClusterFinalizer holds the GPUCluster until reconcileDelete has ordered teardown.
53
const gpuClusterFinalizer = "gpucluster.nvidia.com/dra-resourceclaim"
54

55
// draAdminNamespaceLabelKey is the label the kube-scheduler requires on a namespace
56
// before it allows adminAccess: true in ResourceClaim/ResourceClaimTemplate objects.
57
const draAdminNamespaceLabelKey = "resource.kubernetes.io/admin-access"
58

59
// GPUClusterReconciler reconciles a GPUCluster object
60
type GPUClusterReconciler struct {
61
        client.Client
62
        Scheme      *runtime.Scheme
63
        ClusterInfo clusterinfo.Interface
64
        Namespace   string
65

66
        stateManager     state.Manager
67
        conditionUpdater conditions.Updater
68
        recorder         events.EventRecorder
69
}
70

71
//+kubebuilder:rbac:groups=nvidia.com,resources=gpuclusters,verbs=get;list;watch;create;update;patch;delete
72
//+kubebuilder:rbac:groups=nvidia.com,resources=gpuclusters/status,verbs=get;update;patch
73
//+kubebuilder:rbac:groups=nvidia.com,resources=gpuclusters/finalizers,verbs=update
74
//+kubebuilder:rbac:groups=nvidia.com,resources=clusterpolicies,verbs=get;list;watch
75
//+kubebuilder:rbac:groups="",resources=namespaces,verbs=get;update;patch
76
//+kubebuilder:rbac:groups=events.k8s.io,resources=events,verbs=create;patch
77
//+kubebuilder:rbac:groups=resource.k8s.io,resources=resourceclaimtemplates,verbs=get;list;watch;create;update;delete
78

79
func (r *GPUClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
1✔
80
        logger := log.FromContext(ctx)
1✔
81
        logger.V(consts.LogLevelInfo).Info("Reconciling GPUCluster")
1✔
82

1✔
83
        instance := &nvidiav1alpha1.GPUCluster{}
1✔
84
        if err := r.Get(ctx, req.NamespacedName, instance); err != nil {
2✔
85
                if apierrors.IsNotFound(err) {
2✔
86
                        // Deleted; owned objects are garbage-collected, so there is nothing to clean up.
1✔
87
                        return ctrl.Result{}, nil
1✔
88
                }
1✔
89
                // instance was not populated by the failed Get, so there is no object to
90
                // update status on; just surface the error for requeue.
91
                logger.Error(err, "error getting GPUCluster object")
×
92
                return ctrl.Result{}, fmt.Errorf("error getting GPUCluster object: %w", err)
×
93
        }
94

95
        if !instance.DeletionTimestamp.IsZero() {
2✔
96
                return r.reconcileDelete(ctx, instance)
1✔
97
        }
1✔
98

99
        if err := utils.EnsureFinalizer(ctx, r.Client, instance, gpuClusterFinalizer); err != nil {
1✔
100
                return ctrl.Result{}, fmt.Errorf("error adding finalizer to GPUCluster %s: %w", req.NamespacedName, err)
×
101
        }
×
102

103
        if msg, err := r.validatePrerequisites(ctx); err != nil {
1✔
104
                return ctrl.Result{}, err
×
105
        } else if msg != "" {
2✔
106
                logger.V(consts.LogLevelWarning).Info("GPUCluster prerequisite not met", "reason", msg)
1✔
107
                if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.NotReady); err != nil {
1✔
108
                        return ctrl.Result{}, err
×
109
                }
×
110
                if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.PrerequisiteNotMet, msg); condErr != nil {
1✔
111
                        logger.Error(condErr, "failed to set condition")
×
112
                }
×
113
                return ctrl.Result{RequeueAfter: time.Minute}, nil
1✔
114
        }
115

116
        // The operand states render ResourceClaimTemplates with adminAccess: true, which the
117
        // kube-scheduler only admits from a labeled namespace; label it before syncing states.
118
        if err := r.ensureAdminAccessLabel(ctx); err != nil {
1✔
119
                return ctrl.Result{}, fmt.Errorf("failed to label namespace for admin access: %w", err)
×
120
        }
×
121

122
        infoCatalog := state.NewInfoCatalog()
1✔
123
        infoCatalog.Add(state.InfoTypeClusterInfo, r.ClusterInfo)
1✔
124

1✔
125
        managerStatus := r.stateManager.SyncState(ctx, instance, infoCatalog)
1✔
126

1✔
127
        if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.State(managerStatus.Status)); err != nil {
1✔
128
                return ctrl.Result{}, err
×
129
        }
×
130

131
        if managerStatus.Status != state.SyncStateReady {
1✔
132
                logger.Info("GPUCluster instance is not ready")
×
133
                for _, result := range managerStatus.StatesStatus {
×
134
                        if result.Status != state.SyncStateReady && result.ErrInfo != nil {
×
135
                                if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.ReconcileFailed, fmt.Sprintf("Error syncing state %s: %v", result.StateName, result.ErrInfo)); condErr != nil {
×
136
                                        logger.Error(condErr, "failed to set condition")
×
137
                                }
×
138
                                return ctrl.Result{RequeueAfter: time.Second * 5}, nil
×
139
                        }
140
                }
141
                // no state reported an error, so we are waiting on operand pods
142
                if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.OperandNotReady, "Waiting for operand pods to be ready"); condErr != nil {
×
143
                        logger.Error(condErr, "failed to set condition")
×
144
                }
×
145
                return ctrl.Result{RequeueAfter: time.Second * 5}, nil
×
146
        }
147

148
        if condErr := r.conditionUpdater.SetConditionsReady(ctx, instance, conditions.Reconciled, "All resources have been successfully reconciled"); condErr != nil {
1✔
149
                logger.Error(condErr, "failed to set condition")
×
150
                return ctrl.Result{}, condErr
×
151
        }
×
152
        // Resync periodically so out-of-band changes (a deleted DeviceClass/VAP, or a
153
        // newly-created ClusterPolicy) are detected and reconciled even while ready;
154
        // only DaemonSets are watched, and the ready path is otherwise event-driven.
155
        return ctrl.Result{RequeueAfter: time.Minute}, nil
1✔
156
}
157

158
// validatePrerequisites checks the cross-CR rules that gate DRA enablement, returning
159
// a message describing the first unmet prerequisite or an empty string when all are met.
160
func (r *GPUClusterReconciler) validatePrerequisites(ctx context.Context) (string, error) {
1✔
161
        clusterPolicies := &gpuv1.ClusterPolicyList{}
1✔
162
        if err := r.List(ctx, clusterPolicies); err != nil {
1✔
163
                return "", fmt.Errorf("error listing ClusterPolicy objects: %w", err)
×
164
        }
×
165
        // TODO: relax this prerequisite once ClusterPolicy and GPUCluster can co-exist
166
        if clusterPolicy := getSingletonClusterPolicy(clusterPolicies.Items); clusterPolicy != nil {
2✔
167
                return fmt.Sprintf("A ClusterPolicy CR %q exists; a ClusterPolicy CR and GPUCluster CR may not exist at the same time", clusterPolicy.Name), nil
1✔
168
        }
1✔
169
        return "", nil
1✔
170
}
171

172
// ensureAdminAccessLabel patches the operator namespace with the label required by the
173
// kube-scheduler to allow adminAccess: true in ResourceClaim/ResourceClaimTemplate
174
// objects. The label is deliberately never removed: it is namespace-level configuration
175
// that other adminAccess consumers in the namespace may rely on.
176
func (r *GPUClusterReconciler) ensureAdminAccessLabel(ctx context.Context) error {
1✔
177
        ns := &corev1.Namespace{}
1✔
178
        if err := r.Get(ctx, client.ObjectKey{Name: r.Namespace}, ns); err != nil {
1✔
179
                return fmt.Errorf("could not get namespace %s: %w", r.Namespace, err)
×
180
        }
×
181
        if ns.Labels[draAdminNamespaceLabelKey] == "true" {
1✔
182
                return nil
×
183
        }
×
184
        patch := client.MergeFrom(ns.DeepCopy())
1✔
185
        if ns.Labels == nil {
2✔
186
                ns.Labels = make(map[string]string)
1✔
187
        }
1✔
188
        ns.Labels[draAdminNamespaceLabelKey] = "true"
1✔
189
        return r.Patch(ctx, ns, patch)
1✔
190
}
191

192
// reconcileDelete drains ResourceClaim-consuming DaemonSets before releasing the CR:
193
// garbage collection would otherwise delete the DRA kubelet plugin while their pods
194
// still need it to unprepare claims, leaving them stuck in Terminating. Foreground
195
// propagation keeps each DaemonSet present until its pods are gone, i.e. unprepared.
196
func (r *GPUClusterReconciler) reconcileDelete(ctx context.Context, instance *nvidiav1alpha1.GPUCluster) (ctrl.Result, error) {
1✔
197
        logger := log.FromContext(ctx)
1✔
198

1✔
199
        if !controllerutil.ContainsFinalizer(instance, gpuClusterFinalizer) {
1✔
200
                return ctrl.Result{}, nil
×
201
        }
×
202

203
        dsList := &appsv1.DaemonSetList{}
1✔
204
        if err := r.List(ctx, dsList, client.InNamespace(r.Namespace)); err != nil {
1✔
205
                return ctrl.Result{}, fmt.Errorf("error listing DaemonSets: %w", err)
×
206
        }
×
207
        var draining []string
1✔
208
        for i := range dsList.Items {
2✔
209
                ds := &dsList.Items[i]
1✔
210
                if !metav1.IsControlledBy(ds, instance) || len(ds.Spec.Template.Spec.ResourceClaims) == 0 {
2✔
211
                        continue
1✔
212
                }
213
                draining = append(draining, ds.Name)
1✔
214
                if ds.DeletionTimestamp.IsZero() {
2✔
215
                        logger.V(consts.LogLevelInfo).Info("Draining ResourceClaim-consuming DaemonSet before teardown", "DaemonSet", ds.Name)
1✔
216
                        if err := r.Delete(ctx, ds, client.PropagationPolicy(metav1.DeletePropagationForeground)); err != nil && !apierrors.IsNotFound(err) {
1✔
217
                                return ctrl.Result{}, fmt.Errorf("error deleting DaemonSet %s: %w", ds.Name, err)
×
218
                        }
×
219
                }
220
        }
221
        if len(draining) > 0 {
2✔
222
                r.recorder.Eventf(instance, nil, corev1.EventTypeNormal, "DrainingClaimConsumers", "Delete",
1✔
223
                        "Waiting for ResourceClaim-consuming DaemonSet(s) to terminate: %s", strings.Join(draining, ", "))
1✔
224
                return ctrl.Result{RequeueAfter: time.Second * 5}, nil
1✔
225
        }
1✔
226

227
        controllerutil.RemoveFinalizer(instance, gpuClusterFinalizer)
1✔
228
        if err := r.Update(ctx, instance); err != nil {
1✔
229
                return ctrl.Result{}, fmt.Errorf("error removing finalizer: %w", err)
×
230
        }
×
231
        return ctrl.Result{}, nil
1✔
232
}
233

234
// updateCRStatus persists the given state (and the operator namespace) to the GPUCluster's
235
// .status subresource. It refetches the CR first to avoid resourceVersion conflicts and skips
236
// the API write when the status is already current. The desired status is mirrored onto cr
237
// up front so it is set on every non-error path.
238
func (r *GPUClusterReconciler) updateCRStatus(ctx context.Context, cr *nvidiav1alpha1.GPUCluster, desired nvidiav1alpha1.State) error {
1✔
239
        reqLogger := log.FromContext(ctx)
1✔
240

1✔
241
        // Refetch to avoid a resourceVersion conflict.
1✔
242
        instance := &nvidiav1alpha1.GPUCluster{}
1✔
243
        if err := r.Get(ctx, types.NamespacedName{Name: cr.Name}, instance); err != nil {
1✔
244
                reqLogger.Error(err, "Failed to get GPUCluster instance for status update")
×
245
                return err
×
246
        }
×
247
        cr.Status.State = desired
1✔
248
        cr.Status.Namespace = r.Namespace
1✔
249

1✔
250
        if instance.Status.State == desired && instance.Status.Namespace == r.Namespace {
1✔
251
                return nil
×
252
        }
×
253
        instance.Status.State = desired
1✔
254
        instance.Status.Namespace = r.Namespace
1✔
255

1✔
256
        reqLogger.V(consts.LogLevelInfo).Info("Updating CR Status", "Status", instance.Status)
1✔
257
        if err := r.Status().Update(ctx, instance); err != nil {
1✔
258
                reqLogger.Error(err, "Failed to update CR status")
×
259
                return err
×
260
        }
×
261
        return nil
1✔
262
}
263

264
// enqueueAllGPUClusters enqueues every instance so each is reconciled when any
265
// instance or owned resource changes.
266
func (r *GPUClusterReconciler) enqueueAllGPUClusters(ctx context.Context, _ *nvidiav1alpha1.GPUCluster) []reconcile.Request {
1✔
267
        logger := log.FromContext(ctx)
1✔
268
        list := &nvidiav1alpha1.GPUClusterList{}
1✔
269

1✔
270
        if err := r.List(ctx, list); err != nil {
1✔
271
                logger.Error(err, "Unable to list GPUCluster resources")
×
272
                return []reconcile.Request{}
×
273
        }
×
274

275
        reconcileRequests := make([]reconcile.Request, 0, len(list.Items))
1✔
276
        for _, config := range list.Items {
2✔
277
                reconcileRequests = append(reconcileRequests,
1✔
278
                        reconcile.Request{
1✔
279
                                NamespacedName: types.NamespacedName{
1✔
280
                                        Name: config.GetName(),
1✔
281
                                },
1✔
282
                        })
1✔
283
        }
1✔
284

285
        return reconcileRequests
1✔
286
}
287

288
func (r *GPUClusterReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
×
289
        // The state manager renders the DRA driver operand for the GPUCluster.
×
290
        stateManager, err := state.NewManager(
×
291
                nvidiav1alpha1.GPUClusterCRDName,
×
292
                r.Namespace,
×
293
                mgr.GetClient(),
×
294
                mgr.GetScheme())
×
295
        if err != nil {
×
296
                return fmt.Errorf("error creating state manager: %w", err)
×
297
        }
×
298
        r.stateManager = stateManager
×
299

×
300
        r.conditionUpdater = conditions.NewGPUClusterUpdater(mgr.GetClient())
×
301
        r.recorder = mgr.GetEventRecorder("nvidia-gpu-operator")
×
302

×
303
        c, err := controller.New("gpu-cluster-controller", mgr, controller.Options{
×
304
                Reconciler:              r,
×
305
                MaxConcurrentReconciles: 1,
×
306
                RateLimiter:             workqueue.NewTypedItemExponentialFailureRateLimiter[reconcile.Request](minDelayCR, maxDelayCR),
×
307
        })
×
308
        if err != nil {
×
309
                return err
×
310
        }
×
311

312
        err = c.Watch(source.Kind(
×
313
                mgr.GetCache(),
×
314
                &nvidiav1alpha1.GPUCluster{},
×
315
                handler.TypedEnqueueRequestsFromMapFunc(r.enqueueAllGPUClusters),
×
316
                predicate.TypedGenerationChangedPredicate[*nvidiav1alpha1.GPUCluster]{},
×
317
        ),
×
318
        )
×
319
        if err != nil {
×
320
                return err
×
321
        }
×
322

323
        // Watch the secondary resources each state manager owns.
324
        watchSources := stateManager.GetWatchSources(mgr)
×
325
        for _, watchSource := range watchSources {
×
326
                err = c.Watch(
×
327
                        watchSource,
×
328
                )
×
329
                if err != nil {
×
330
                        return fmt.Errorf("error setting up Watch for source type %v: %w", watchSource, err)
×
331
                }
×
332
        }
333

334
        return nil
×
335
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE TRIAL · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc