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

NVIDIA / gpu-operator / 30135712468

25 Jul 2026 12:11AM UTC coverage: 33.505% (-0.04%) from 33.544%
30135712468

Pull #2676

github

tariq1890
add finaliser to GPUCluster CR using PATCH

Signed-off-by: Tariq Ibrahim <tibrahim@nvidia.com>
Co-authored-by: Rajath Agasthya <ragasthya@nvidia.com>
Pull Request #2676: add finaliser to GPUCluster CR using PATCH

8 of 9 new or added lines in 2 files covered. (88.89%)

10 existing lines in 2 files now uncovered.

4828 of 14410 relevant lines covered (33.5%)

0.38 hits per line

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

52.15
/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
        nvidiav1alpha1 "github.com/NVIDIA/gpu-operator/api/nvidia/v1alpha1"
44
        "github.com/NVIDIA/gpu-operator/controllers/clusterinfo"
45
        "github.com/NVIDIA/gpu-operator/internal/conditions"
46
        "github.com/NVIDIA/gpu-operator/internal/consts"
47
        "github.com/NVIDIA/gpu-operator/internal/state"
48
        "github.com/NVIDIA/gpu-operator/internal/utils"
49
)
50

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

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

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

65
        stateManager     state.Manager
66
        conditionUpdater conditions.Updater
67
        recorder         events.EventRecorder
68

69
        // singleton is the GPUCluster that owns reconciliation; the first instance to
70
        // reconcile claims it (first-wins), mirroring ClusterPolicy.
71
        singleton *nvidiav1alpha1.GPUCluster
72
}
73

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

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

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

98
        if !instance.DeletionTimestamp.IsZero() {
2✔
99
                return r.reconcileDelete(ctx, instance)
1✔
100
        }
1✔
101

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

106
        // GPUCluster (DRA stack) may coexist with a ClusterPolicy (device-plugin
107
        // stack): every operand DaemonSet of both stacks gates on the per-node
108
        // nvidia.com/gpu-operator.resource-allocation.mode label, so each node is served by exactly one stack.
109

110
        // Singleton, first-wins (mirroring ClusterPolicy): the first instance to reconcile
111
        // claims ownership; any other instance is marked Ignored and skipped. The owner is
112
        // held in memory, so the choice resets on operator restart.
113
        if r.singleton != nil && r.singleton.Name != instance.Name {
2✔
114
                logger.V(consts.LogLevelWarning).Info("Multiple GPUCluster instances found, ignoring this one",
1✔
115
                        "name", instance.Name, "owner", r.singleton.Name)
1✔
116
                if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.Ignored); err != nil {
1✔
117
                        return ctrl.Result{}, err
×
118
                }
×
119
                return ctrl.Result{}, nil
1✔
120
        }
121
        r.singleton = instance
1✔
122

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

129
        infoCatalog := state.NewInfoCatalog()
1✔
130
        infoCatalog.Add(state.InfoTypeClusterInfo, r.ClusterInfo)
1✔
131

1✔
132
        managerStatus := r.stateManager.SyncState(ctx, instance, infoCatalog)
1✔
133

1✔
134
        if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.State(managerStatus.Status)); err != nil {
1✔
135
                return ctrl.Result{}, err
×
136
        }
×
137

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

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

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

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

1✔
192
        if !controllerutil.ContainsFinalizer(instance, gpuClusterFinalizer) {
1✔
193
                return ctrl.Result{}, nil
×
194
        }
×
195

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

220
        controllerutil.RemoveFinalizer(instance, gpuClusterFinalizer)
1✔
221
        if err := r.Update(ctx, instance); err != nil {
1✔
222
                return ctrl.Result{}, fmt.Errorf("error removing finalizer: %w", err)
×
223
        }
×
224
        return ctrl.Result{}, nil
1✔
225
}
226

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

1✔
234
        // Refetch to avoid a resourceVersion conflict.
1✔
235
        instance := &nvidiav1alpha1.GPUCluster{}
1✔
236
        if err := r.Get(ctx, types.NamespacedName{Name: cr.Name}, instance); err != nil {
1✔
237
                reqLogger.Error(err, "Failed to get GPUCluster instance for status update")
×
238
                return err
×
239
        }
×
240
        cr.Status.State = desired
1✔
241
        cr.Status.Namespace = r.Namespace
1✔
242

1✔
243
        if instance.Status.State == desired && instance.Status.Namespace == r.Namespace {
1✔
244
                return nil
×
245
        }
×
246
        instance.Status.State = desired
1✔
247
        instance.Status.Namespace = r.Namespace
1✔
248

1✔
249
        reqLogger.V(consts.LogLevelInfo).Info("Updating CR Status", "Status", instance.Status)
1✔
250
        if err := r.Status().Update(ctx, instance); err != nil {
1✔
251
                reqLogger.Error(err, "Failed to update CR status")
×
252
                return err
×
253
        }
×
254
        return nil
1✔
255
}
256

257
// enqueueAllGPUClusters enqueues every instance so each is reconciled when any
258
// instance or owned resource changes.
259
func (r *GPUClusterReconciler) enqueueAllGPUClusters(ctx context.Context, _ *nvidiav1alpha1.GPUCluster) []reconcile.Request {
1✔
260
        logger := log.FromContext(ctx)
1✔
261
        list := &nvidiav1alpha1.GPUClusterList{}
1✔
262

1✔
263
        if err := r.List(ctx, list); err != nil {
1✔
264
                logger.Error(err, "Unable to list GPUCluster resources")
×
265
                return []reconcile.Request{}
×
266
        }
×
267

268
        reconcileRequests := make([]reconcile.Request, 0, len(list.Items))
1✔
269
        for _, config := range list.Items {
2✔
270
                reconcileRequests = append(reconcileRequests,
1✔
271
                        reconcile.Request{
1✔
272
                                NamespacedName: types.NamespacedName{
1✔
273
                                        Name: config.GetName(),
1✔
274
                                },
1✔
275
                        })
1✔
276
        }
1✔
277

278
        return reconcileRequests
1✔
279
}
280

281
func (r *GPUClusterReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
×
282
        // The state manager renders the DRA driver operand for the GPUCluster.
×
283
        stateManager, err := state.NewManager(
×
284
                nvidiav1alpha1.GPUClusterCRDName,
×
285
                r.Namespace,
×
286
                mgr.GetClient(),
×
287
                mgr.GetScheme())
×
288
        if err != nil {
×
289
                return fmt.Errorf("error creating state manager: %w", err)
×
290
        }
×
291
        r.stateManager = stateManager
×
292

×
293
        r.conditionUpdater = conditions.NewGPUClusterUpdater(mgr.GetClient())
×
294
        r.recorder = mgr.GetEventRecorder("nvidia-gpu-operator")
×
295

×
296
        c, err := controller.New("gpu-cluster-controller", mgr, controller.Options{
×
297
                Reconciler:              r,
×
298
                MaxConcurrentReconciles: 1,
×
299
                RateLimiter:             workqueue.NewTypedItemExponentialFailureRateLimiter[reconcile.Request](minDelayCR, maxDelayCR),
×
300
        })
×
301
        if err != nil {
×
302
                return err
×
303
        }
×
304

305
        err = c.Watch(source.Kind(
×
306
                mgr.GetCache(),
×
307
                &nvidiav1alpha1.GPUCluster{},
×
308
                handler.TypedEnqueueRequestsFromMapFunc(r.enqueueAllGPUClusters),
×
309
                predicate.TypedGenerationChangedPredicate[*nvidiav1alpha1.GPUCluster]{},
×
310
        ),
×
311
        )
×
312
        if err != nil {
×
313
                return err
×
314
        }
×
315

316
        // Watch the secondary resources each state manager owns.
317
        watchSources := stateManager.GetWatchSources(mgr)
×
318
        for _, watchSource := range watchSources {
×
319
                err = c.Watch(
×
320
                        watchSource,
×
321
                )
×
322
                if err != nil {
×
323
                        return fmt.Errorf("error setting up Watch for source type %v: %w", watchSource, err)
×
324
                }
×
325
        }
326

327
        return nil
×
328
}
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