30391712232

Committed 28 Jul 2026 07:23PM UTC coverage: 35.907%. First build

Build # 30391712232

Build Type

Pull #2689

github

Committed by

karthikvetrivel

Commit Message

Enforce singleton GPUCluster name and elect ClusterPolicy by creation time

Signed-off-by: Karthik Vetrivel <kvetrivel@nvidia.com>

Pull Request Pull Request #2689: Enforce singleton GPUCluster name and elect ClusterPolicy by creation time

Coverage Stats

24 of 28 new or added lines in 3 files covered. (85.71%)

5200 of 14482 relevant lines covered (35.91%)

0.41 hits per line

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

52.43

/controllers/gpucluster_controller.go

/**
# 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 controllers

import (
        "context"
        "fmt"
        "strings"
        "time"

        appsv1 "k8s.io/api/apps/v1"
        corev1 "k8s.io/api/core/v1"
        apierrors "k8s.io/apimachinery/pkg/api/errors"
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
        "k8s.io/apimachinery/pkg/runtime"
        "k8s.io/apimachinery/pkg/types"
        "k8s.io/client-go/tools/events"
        "k8s.io/client-go/util/workqueue"
        ctrl "sigs.k8s.io/controller-runtime"
        "sigs.k8s.io/controller-runtime/pkg/client"
        "sigs.k8s.io/controller-runtime/pkg/controller"
        "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
        "sigs.k8s.io/controller-runtime/pkg/handler"
        "sigs.k8s.io/controller-runtime/pkg/log"
        "sigs.k8s.io/controller-runtime/pkg/predicate"
        "sigs.k8s.io/controller-runtime/pkg/reconcile"
        "sigs.k8s.io/controller-runtime/pkg/source"

        gpuv1 "github.com/NVIDIA/gpu-operator/api/nvidia/v1"
        nvidiav1alpha1 "github.com/NVIDIA/gpu-operator/api/nvidia/v1alpha1"
        "github.com/NVIDIA/gpu-operator/controllers/clusterinfo"
        "github.com/NVIDIA/gpu-operator/internal/conditions"
        "github.com/NVIDIA/gpu-operator/internal/consts"
        "github.com/NVIDIA/gpu-operator/internal/state"
        "github.com/NVIDIA/gpu-operator/internal/utils"
)

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

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

// GPUClusterReconciler reconciles a GPUCluster object
type GPUClusterReconciler struct {
        client.Client
        Scheme      *runtime.Scheme
        ClusterInfo clusterinfo.Interface
        Namespace   string

        stateManager     state.Manager
        conditionUpdater conditions.Updater
        recorder         events.EventRecorder
}

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

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

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

        if !instance.DeletionTimestamp.IsZero() {
                return r.reconcileDelete(ctx, instance)
        }

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

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

        // Singleton election (mirroring ClusterPolicy): the GPUCluster with the oldest
        // creationTimestamp (name as tie-breaker) is the active instance. The CRD's CEL
        // rule pins metadata.name, so multiple instances can only predate that rule.
        gpuClusters := &nvidiav1alpha1.GPUClusterList{}
        if err := r.List(ctx, gpuClusters); err != nil {
                return ctrl.Result{}, fmt.Errorf("error listing GPUCluster objects: %w", err)
        }
        if active := electSingleton(gpuClusters.Items); active != nil && active.Name != instance.Name {
                logger.V(consts.LogLevelWarning).Info("Multiple GPUCluster instances found, ignoring this one",
                        "name", instance.Name, "owner", active.Name)
                if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.Ignored); err != nil {
                        return ctrl.Result{}, err
                }
                return ctrl.Result{}, nil
        }

        // DRA requires all driver management through NVIDIADriver CRs: surface an unmet
        // prerequisite on this CR's status and hold off deploying operands until it is met.
        if msg, err := r.validatePrerequisites(ctx); err != nil {
                return ctrl.Result{}, err
        } else if msg != "" {
                logger.V(consts.LogLevelWarning).Info("GPUCluster prerequisite not met", "reason", msg)
                if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.NotReady); err != nil {
                        return ctrl.Result{}, err
                }
                if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.PrerequisiteNotMet, msg); condErr != nil {
                        logger.Error(condErr, "failed to set condition")
                }
                return ctrl.Result{RequeueAfter: time.Minute}, nil
        }

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

        infoCatalog := state.NewInfoCatalog()
        infoCatalog.Add(state.InfoTypeClusterInfo, r.ClusterInfo)

        managerStatus := r.stateManager.SyncState(ctx, instance, infoCatalog)

        if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.State(managerStatus.Status)); err != nil {
                return ctrl.Result{}, err
        }

        if managerStatus.Status != state.SyncStateReady {
                logger.Info("GPUCluster instance is not ready")
                for _, result := range managerStatus.StatesStatus {
                        if result.Status != state.SyncStateReady && result.ErrInfo != nil {
                                if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.ReconcileFailed, fmt.Sprintf("Error syncing state %s: %v", result.StateName, result.ErrInfo)); condErr != nil {
                                        logger.Error(condErr, "failed to set condition")
                                }
                                return ctrl.Result{RequeueAfter: time.Second * 5}, nil
                        }
                }
                // no state reported an error, so we are waiting on operand pods
                if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.OperandNotReady, "Waiting for operand pods to be ready"); condErr != nil {
                        logger.Error(condErr, "failed to set condition")
                }
                return ctrl.Result{RequeueAfter: time.Second * 5}, nil
        }

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

// validatePrerequisites checks the cross-CR rules that gate DRA enablement, returning
// a message describing the first unmet prerequisite or an empty string when all are met.
func (r *GPUClusterReconciler) validatePrerequisites(ctx context.Context) (string, error) {
        clusterPolicies := &gpuv1.ClusterPolicyList{}
        if err := r.List(ctx, clusterPolicies); err != nil {
                return "", fmt.Errorf("error listing ClusterPolicy objects: %w", err)
        }
        // Only the active singleton ClusterPolicy matters here: an Ignored instance
        // deploys nothing, so it cannot own driver daemonsets.
        if active := electSingleton(clusterPolicies.Items); active != nil && !active.Spec.Driver.UseNvidiaDriverCRDType() {
                return fmt.Sprintf("ClusterPolicy %s does not have driver.useNvidiaDriverCRD enabled; migrate driver management to NVIDIADriver CRs before enabling DRA", active.Name), nil
        }
        return "", nil
}

// ensureAdminAccessLabel patches the operator namespace with the label required by the
// kube-scheduler to allow adminAccess: true in ResourceClaim/ResourceClaimTemplate
// objects. The label is deliberately never removed: it is namespace-level configuration
// that other adminAccess consumers in the namespace may rely on.
func (r *GPUClusterReconciler) ensureAdminAccessLabel(ctx context.Context) error {
        ns := &corev1.Namespace{}
        if err := r.Get(ctx, client.ObjectKey{Name: r.Namespace}, ns); err != nil {
                return fmt.Errorf("could not get namespace %s: %w", r.Namespace, err)
        }
        if ns.Labels[draAdminNamespaceLabelKey] == "true" {
                return nil
        }
        patch := client.MergeFrom(ns.DeepCopy())
        if ns.Labels == nil {
                ns.Labels = make(map[string]string)
        }
        ns.Labels[draAdminNamespaceLabelKey] = "true"
        return r.Patch(ctx, ns, patch)
}

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

        if !controllerutil.ContainsFinalizer(instance, gpuClusterFinalizer) {
                return ctrl.Result{}, nil
        }

        dsList := &appsv1.DaemonSetList{}
        if err := r.List(ctx, dsList, client.InNamespace(r.Namespace)); err != nil {
                return ctrl.Result{}, fmt.Errorf("error listing DaemonSets: %w", err)
        }
        var draining []string
        for i := range dsList.Items {
                ds := &dsList.Items[i]
                if !metav1.IsControlledBy(ds, instance) || len(ds.Spec.Template.Spec.ResourceClaims) == 0 {
                        continue
                }
                draining = append(draining, ds.Name)
                if ds.DeletionTimestamp.IsZero() {
                        logger.V(consts.LogLevelInfo).Info("Draining ResourceClaim-consuming DaemonSet before teardown", "DaemonSet", ds.Name)
                        if err := r.Delete(ctx, ds, client.PropagationPolicy(metav1.DeletePropagationForeground)); err != nil && !apierrors.IsNotFound(err) {
                                return ctrl.Result{}, fmt.Errorf("error deleting DaemonSet %s: %w", ds.Name, err)
                        }
                }
        }
        if len(draining) > 0 {
                r.recorder.Eventf(instance, nil, corev1.EventTypeNormal, "DrainingClaimConsumers", "Delete",
                        "Waiting for ResourceClaim-consuming DaemonSet(s) to terminate: %s", strings.Join(draining, ", "))
                return ctrl.Result{RequeueAfter: time.Second * 5}, nil
        }

        controllerutil.RemoveFinalizer(instance, gpuClusterFinalizer)
        if err := r.Update(ctx, instance); err != nil {
                return ctrl.Result{}, fmt.Errorf("error removing finalizer: %w", err)
        }
        return ctrl.Result{}, nil
}

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

        // Refetch to avoid a resourceVersion conflict.
        instance := &nvidiav1alpha1.GPUCluster{}
        if err := r.Get(ctx, types.NamespacedName{Name: cr.Name}, instance); err != nil {
                reqLogger.Error(err, "Failed to get GPUCluster instance for status update")
                return err
        }
        cr.Status.State = desired
        cr.Status.Namespace = r.Namespace

        if instance.Status.State == desired && instance.Status.Namespace == r.Namespace {
                return nil
        }
        instance.Status.State = desired
        instance.Status.Namespace = r.Namespace

        reqLogger.V(consts.LogLevelInfo).Info("Updating CR Status", "Status", instance.Status)
        if err := r.Status().Update(ctx, instance); err != nil {
                reqLogger.Error(err, "Failed to update CR status")
                return err
        }
        return nil
}

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

        if err := r.List(ctx, list); err != nil {
                logger.Error(err, "Unable to list GPUCluster resources")
                return []reconcile.Request{}
        }

        reconcileRequests := make([]reconcile.Request, 0, len(list.Items))
        for _, config := range list.Items {
                reconcileRequests = append(reconcileRequests,
                        reconcile.Request{
                                NamespacedName: types.NamespacedName{
                                        Name: config.GetName(),
                                },
                        })
        }

        return reconcileRequests
}

func (r *GPUClusterReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
        // The state manager renders the DRA driver operand for the GPUCluster.
        stateManager, err := state.NewManager(
                nvidiav1alpha1.GPUClusterCRDName,
                r.Namespace,
                mgr.GetClient(),
                mgr.GetScheme())
        if err != nil {
                return fmt.Errorf("error creating state manager: %w", err)
        }
        r.stateManager = stateManager

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

        c, err := controller.New("gpu-cluster-controller", mgr, controller.Options{
                Reconciler:              r,
                MaxConcurrentReconciles: 1,
                RateLimiter:             workqueue.NewTypedItemExponentialFailureRateLimiter[reconcile.Request](minDelayCR, maxDelayCR),
        })
        if err != nil {
                return err
        }

        err = c.Watch(source.Kind(
                mgr.GetCache(),
                &nvidiav1alpha1.GPUCluster{},
                handler.TypedEnqueueRequestsFromMapFunc(r.enqueueAllGPUClusters),
                predicate.TypedGenerationChangedPredicate[*nvidiav1alpha1.GPUCluster]{},
        ),
        )
        if err != nil {
                return err
        }

        // Watch the secondary resources each state manager owns.
        watchSources := stateManager.GetWatchSources(mgr)
        for _, watchSource := range watchSources {
                err = c.Watch(
                        watchSource,
                )
                if err != nil {
                        return fmt.Errorf("error setting up Watch for source type %v: %w", watchSource, err)
                }
        }

        return nil
}

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	// GPUCluster (DRA stack) may coexist with a ClusterPolicy (device-plugin
104	// stack): every operand DaemonSet of both stacks gates on the per-node
105	// nvidia.com/gpu-operator.resource-allocation.mode label, so each node is served by exactly one stack.
106
107	// Singleton election (mirroring ClusterPolicy): the GPUCluster with the oldest
108	// creationTimestamp (name as tie-breaker) is the active instance. The CRD's CEL
109	// rule pins metadata.name, so multiple instances can only predate that rule.
110	gpuClusters := &nvidiav1alpha1.GPUClusterList{}	1✔
111	if err := r.List(ctx, gpuClusters); err != nil {	1✔
NEW 112	return ctrl.Result{}, fmt.Errorf("error listing GPUCluster objects: %w", err)	×
NEW 113	}	×
114	if active := electSingleton(gpuClusters.Items); active != nil && active.Name != instance.Name {	2✔
115	logger.V(consts.LogLevelWarning).Info("Multiple GPUCluster instances found, ignoring this one",	1✔
116	"name", instance.Name, "owner", active.Name)	1✔
117	if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.Ignored); err != nil {	1✔
118	return ctrl.Result{}, err	×
119	}	×
120	return ctrl.Result{}, nil	1✔
121	}
122
123	// DRA requires all driver management through NVIDIADriver CRs: surface an unmet
124	// prerequisite on this CR's status and hold off deploying operands until it is met.
125	if msg, err := r.validatePrerequisites(ctx); err != nil {	1✔
126	return ctrl.Result{}, err	×
127	} else if msg != "" {	2✔
128	logger.V(consts.LogLevelWarning).Info("GPUCluster prerequisite not met", "reason", msg)	1✔
129	if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.NotReady); err != nil {	1✔
130	return ctrl.Result{}, err	×
131	}	×
132	if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.PrerequisiteNotMet, msg); condErr != nil {	1✔
133	logger.Error(condErr, "failed to set condition")	×
134	}	×
135	return ctrl.Result{RequeueAfter: time.Minute}, nil	1✔
136	}
137
138	// The operand states render ResourceClaimTemplates with adminAccess: true, which the
139	// kube-scheduler only admits from a labeled namespace; label it before syncing states.
140	if err := r.ensureAdminAccessLabel(ctx); err != nil {	1✔
141	return ctrl.Result{}, fmt.Errorf("failed to label namespace for admin access: %w", err)	×
142	}	×
143
144	infoCatalog := state.NewInfoCatalog()	1✔
145	infoCatalog.Add(state.InfoTypeClusterInfo, r.ClusterInfo)	1✔
146		1✔
147	managerStatus := r.stateManager.SyncState(ctx, instance, infoCatalog)	1✔
148		1✔
149	if err := r.updateCRStatus(ctx, instance, nvidiav1alpha1.State(managerStatus.Status)); err != nil {	1✔
150	return ctrl.Result{}, err	×
151	}	×
152
153	if managerStatus.Status != state.SyncStateReady {	1✔
154	logger.Info("GPUCluster instance is not ready")	×
155	for _, result := range managerStatus.StatesStatus {	×
156	if result.Status != state.SyncStateReady && result.ErrInfo != nil {	×
157	if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.ReconcileFailed, fmt.Sprintf("Error syncing state %s: %v", result.StateName, result.ErrInfo)); condErr != nil {	×
158	logger.Error(condErr, "failed to set condition")	×
159	}	×
160	return ctrl.Result{RequeueAfter: time.Second * 5}, nil	×
161	}
162	}
163	// no state reported an error, so we are waiting on operand pods
164	if condErr := r.conditionUpdater.SetConditionsError(ctx, instance, conditions.OperandNotReady, "Waiting for operand pods to be ready"); condErr != nil {	×
165	logger.Error(condErr, "failed to set condition")	×
166	}	×
167	return ctrl.Result{RequeueAfter: time.Second * 5}, nil	×
168	}
169
170	if condErr := r.conditionUpdater.SetConditionsReady(ctx, instance, conditions.Reconciled, "All resources have been successfully reconciled"); condErr != nil {	1✔
171	logger.Error(condErr, "failed to set condition")	×
172	return ctrl.Result{}, condErr	×
173	}	×
174	// Resync periodically so out-of-band changes (a deleted DeviceClass/VAP, or a
175	// newly-created ClusterPolicy) are detected and reconciled even while ready;
176	// only DaemonSets are watched, and the ready path is otherwise event-driven.
177	return ctrl.Result{RequeueAfter: time.Minute}, nil	1✔
178	}
179
180	// validatePrerequisites checks the cross-CR rules that gate DRA enablement, returning
181	// a message describing the first unmet prerequisite or an empty string when all are met.
182	func (r *GPUClusterReconciler) validatePrerequisites(ctx context.Context) (string, error) {	1✔
183	clusterPolicies := &gpuv1.ClusterPolicyList{}	1✔
184	if err := r.List(ctx, clusterPolicies); err != nil {	1✔
185	return "", fmt.Errorf("error listing ClusterPolicy objects: %w", err)	×
186	}	×
187	// Only the active singleton ClusterPolicy matters here: an Ignored instance
188	// deploys nothing, so it cannot own driver daemonsets.
189	if active := electSingleton(clusterPolicies.Items); active != nil && !active.Spec.Driver.UseNvidiaDriverCRDType() {	2✔
190	return fmt.Sprintf("ClusterPolicy %s does not have driver.useNvidiaDriverCRD enabled; migrate driver management to NVIDIADriver CRs before enabling DRA", active.Name), nil	1✔
191	}	1✔
192	return "", nil	1✔
193	}
194
195	// ensureAdminAccessLabel patches the operator namespace with the label required by the
196	// kube-scheduler to allow adminAccess: true in ResourceClaim/ResourceClaimTemplate
197	// objects. The label is deliberately never removed: it is namespace-level configuration
198	// that other adminAccess consumers in the namespace may rely on.
199	func (r *GPUClusterReconciler) ensureAdminAccessLabel(ctx context.Context) error {	1✔
200	ns := &corev1.Namespace{}	1✔
201	if err := r.Get(ctx, client.ObjectKey{Name: r.Namespace}, ns); err != nil {	1✔
202	return fmt.Errorf("could not get namespace %s: %w", r.Namespace, err)	×
203	}	×
204	if ns.Labels[draAdminNamespaceLabelKey] == "true" {	1✔
205	return nil	×
206	}	×
207	patch := client.MergeFrom(ns.DeepCopy())	1✔
208	if ns.Labels == nil {	2✔
209	ns.Labels = make(map[string]string)	1✔
210	}	1✔
211	ns.Labels[draAdminNamespaceLabelKey] = "true"	1✔
212	return r.Patch(ctx, ns, patch)	1✔
213	}
214
215	// reconcileDelete drains ResourceClaim-consuming DaemonSets before releasing the CR:
216	// garbage collection would otherwise delete the DRA kubelet plugin while their pods
217	// still need it to unprepare claims, leaving them stuck in Terminating. Foreground
218	// propagation keeps each DaemonSet present until its pods are gone, i.e. unprepared.
219	func (r GPUClusterReconciler) reconcileDelete(ctx context.Context, instance nvidiav1alpha1.GPUCluster) (ctrl.Result, error) {	1✔
220	logger := log.FromContext(ctx)	1✔
221		1✔
222	if !controllerutil.ContainsFinalizer(instance, gpuClusterFinalizer) {	1✔
223	return ctrl.Result{}, nil	×
224	}	×
225
226	dsList := &appsv1.DaemonSetList{}	1✔
227	if err := r.List(ctx, dsList, client.InNamespace(r.Namespace)); err != nil {	1✔
228	return ctrl.Result{}, fmt.Errorf("error listing DaemonSets: %w", err)	×
229	}	×
230	var draining []string	1✔
231	for i := range dsList.Items {	2✔
232	ds := &dsList.Items[i]	1✔
233	if !metav1.IsControlledBy(ds, instance) \|\| len(ds.Spec.Template.Spec.ResourceClaims) == 0 {	2✔
234	continue	1✔
235	}
236	draining = append(draining, ds.Name)	1✔
237	if ds.DeletionTimestamp.IsZero() {	2✔
238	logger.V(consts.LogLevelInfo).Info("Draining ResourceClaim-consuming DaemonSet before teardown", "DaemonSet", ds.Name)	1✔
239	if err := r.Delete(ctx, ds, client.PropagationPolicy(metav1.DeletePropagationForeground)); err != nil && !apierrors.IsNotFound(err) {	1✔
240	return ctrl.Result{}, fmt.Errorf("error deleting DaemonSet %s: %w", ds.Name, err)	×
241	}	×
242	}
243	}
244	if len(draining) > 0 {	2✔
245	r.recorder.Eventf(instance, nil, corev1.EventTypeNormal, "DrainingClaimConsumers", "Delete",	1✔
246	"Waiting for ResourceClaim-consuming DaemonSet(s) to terminate: %s", strings.Join(draining, ", "))	1✔
247	return ctrl.Result{RequeueAfter: time.Second * 5}, nil	1✔
248	}	1✔
249
250	controllerutil.RemoveFinalizer(instance, gpuClusterFinalizer)	1✔
251	if err := r.Update(ctx, instance); err != nil {	1✔
252	return ctrl.Result{}, fmt.Errorf("error removing finalizer: %w", err)	×
253	}	×
254	return ctrl.Result{}, nil	1✔
255	}
256
257	// updateCRStatus persists the given state (and the operator namespace) to the GPUCluster's
258	// .status subresource. It refetches the CR first to avoid resourceVersion conflicts and skips
259	// the API write when the status is already current. The desired status is mirrored onto cr
260	// up front so it is set on every non-error path.
261	func (r GPUClusterReconciler) updateCRStatus(ctx context.Context, cr nvidiav1alpha1.GPUCluster, desired nvidiav1alpha1.State) error {	1✔
262	reqLogger := log.FromContext(ctx)	1✔
263		1✔
264	// Refetch to avoid a resourceVersion conflict.	1✔
265	instance := &nvidiav1alpha1.GPUCluster{}	1✔
266	if err := r.Get(ctx, types.NamespacedName{Name: cr.Name}, instance); err != nil {	1✔
267	reqLogger.Error(err, "Failed to get GPUCluster instance for status update")	×
268	return err	×
269	}	×
270	cr.Status.State = desired	1✔
271	cr.Status.Namespace = r.Namespace	1✔
272		1✔
273	if instance.Status.State == desired && instance.Status.Namespace == r.Namespace {	1✔
274	return nil	×
275	}	×
276	instance.Status.State = desired	1✔
277	instance.Status.Namespace = r.Namespace	1✔
278		1✔
279	reqLogger.V(consts.LogLevelInfo).Info("Updating CR Status", "Status", instance.Status)	1✔
280	if err := r.Status().Update(ctx, instance); err != nil {	1✔
281	reqLogger.Error(err, "Failed to update CR status")	×
282	return err	×
283	}	×
284	return nil	1✔
285	}
286
287	// enqueueAllGPUClusters enqueues every instance so each is reconciled when any
288	// instance or owned resource changes.
289	func (r GPUClusterReconciler) enqueueAllGPUClusters(ctx context.Context, _ nvidiav1alpha1.GPUCluster) []reconcile.Request {	1✔
290	logger := log.FromContext(ctx)	1✔
291	list := &nvidiav1alpha1.GPUClusterList{}	1✔
292		1✔
293	if err := r.List(ctx, list); err != nil {	1✔
294	logger.Error(err, "Unable to list GPUCluster resources")	×
295	return []reconcile.Request{}	×
296	}	×
297
298	reconcileRequests := make([]reconcile.Request, 0, len(list.Items))	1✔
299	for _, config := range list.Items {	2✔
300	reconcileRequests = append(reconcileRequests,	1✔
301	reconcile.Request{	1✔
302	NamespacedName: types.NamespacedName{	1✔
303	Name: config.GetName(),	1✔
304	},	1✔
305	})	1✔
306	}	1✔
307
308	return reconcileRequests	1✔
309	}
310
311	func (r *GPUClusterReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {	×
312	// The state manager renders the DRA driver operand for the GPUCluster.	×
313	stateManager, err := state.NewManager(	×
314	nvidiav1alpha1.GPUClusterCRDName,	×
315	r.Namespace,	×
316	mgr.GetClient(),	×
317	mgr.GetScheme())	×
318	if err != nil {	×
319	return fmt.Errorf("error creating state manager: %w", err)	×
320	}	×
321	r.stateManager = stateManager	×
322		×
323	r.conditionUpdater = conditions.NewGPUClusterUpdater(mgr.GetClient())	×
324	r.recorder = mgr.GetEventRecorder("nvidia-gpu-operator")	×
325		×
326	c, err := controller.New("gpu-cluster-controller", mgr, controller.Options{	×
327	Reconciler: r,	×
328	MaxConcurrentReconciles: 1,	×
329	RateLimiter: workqueue.NewTypedItemExponentialFailureRateLimiter[reconcile.Request](minDelayCR, maxDelayCR),	×
330	})	×
331	if err != nil {	×
332	return err	×
333	}	×
334
335	err = c.Watch(source.Kind(	×
336	mgr.GetCache(),	×
337	&nvidiav1alpha1.GPUCluster{},	×
338	handler.TypedEnqueueRequestsFromMapFunc(r.enqueueAllGPUClusters),	×
339	predicate.TypedGenerationChangedPredicate[*nvidiav1alpha1.GPUCluster]{},	×
340	),	×
341	)	×
342	if err != nil {	×
343	return err	×
344	}	×
345
346	// Watch the secondary resources each state manager owns.
347	watchSources := stateManager.GetWatchSources(mgr)	×
348	for _, watchSource := range watchSources {	×
349	err = c.Watch(	×
350	watchSource,	×
351	)	×
352	if err != nil {	×
353	return fmt.Errorf("error setting up Watch for source type %v: %w", watchSource, err)	×
354	}	×
355	}
356
357	return nil	×
358	}

NVIDIA / gpu-operator / 30391712232

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

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