apis/nfd: Add Status to NodeFeature CRD

Signed-off-by: Oleg Zhurakivskyy <oleg.zhurakivskyy@intel.com>
2025-03-31 04:04:51 +00:00 · 2024-04-16 20:26:34 +03:00 · 2024-04-16 20:26:34 +03:00 · 331fc03b43
commit 331fc03b43
parent 00ecb012d6
36 changed files with 150 additions and 43 deletions
--- a/api/generated/clientset/versioned/clientset.go
+++ b/api/generated/clientset/versioned/clientset.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/fake/clientset_generated.go
+++ b/api/generated/clientset/versioned/fake/clientset_generated.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/fake/doc.go
+++ b/api/generated/clientset/versioned/fake/doc.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/fake/register.go
+++ b/api/generated/clientset/versioned/fake/register.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/scheme/doc.go
+++ b/api/generated/clientset/versioned/scheme/doc.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/scheme/register.go
+++ b/api/generated/clientset/versioned/scheme/register.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/doc.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/doc.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/doc.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/doc.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nfd_client.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nfd_client.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nodefeature.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nodefeature.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nodefeaturegroup.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nodefeaturegroup.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nodefeaturerule.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/fake/fake_nodefeaturerule.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/generated_expansion.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/generated_expansion.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/nfd_client.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/nfd_client.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/nodefeature.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/nodefeature.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@ -39,6 +39,8 @@ type NodeFeaturesGetter interface {
 type NodeFeatureInterface interface {
 	Create(ctx context.Context, nodeFeature *nfdv1alpha1.NodeFeature, opts v1.CreateOptions) (*nfdv1alpha1.NodeFeature, error)
 	Update(ctx context.Context, nodeFeature *nfdv1alpha1.NodeFeature, opts v1.UpdateOptions) (*nfdv1alpha1.NodeFeature, error)
+	// Add a +genclient:noStatus comment above the type to avoid generating UpdateStatus().
+	UpdateStatus(ctx context.Context, nodeFeature *nfdv1alpha1.NodeFeature, opts v1.UpdateOptions) (*nfdv1alpha1.NodeFeature, error)
 	Delete(ctx context.Context, name string, opts v1.DeleteOptions) error
 	DeleteCollection(ctx context.Context, opts v1.DeleteOptions, listOpts v1.ListOptions) error
 	Get(ctx context.Context, name string, opts v1.GetOptions) (*nfdv1alpha1.NodeFeature, error)
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/nodefeaturegroup.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/nodefeaturegroup.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/clientset/versioned/typed/nfd/v1alpha1/nodefeaturerule.go
+++ b/api/generated/clientset/versioned/typed/nfd/v1alpha1/nodefeaturerule.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/factory.go
+++ b/api/generated/informers/externalversions/factory.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/generic.go
+++ b/api/generated/informers/externalversions/generic.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/internalinterfaces/factory_interfaces.go
+++ b/api/generated/informers/externalversions/internalinterfaces/factory_interfaces.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/nfd/interface.go
+++ b/api/generated/informers/externalversions/nfd/interface.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/nfd/v1alpha1/interface.go
+++ b/api/generated/informers/externalversions/nfd/v1alpha1/interface.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/nfd/v1alpha1/nodefeature.go
+++ b/api/generated/informers/externalversions/nfd/v1alpha1/nodefeature.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/nfd/v1alpha1/nodefeaturegroup.go
+++ b/api/generated/informers/externalversions/nfd/v1alpha1/nodefeaturegroup.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/informers/externalversions/nfd/v1alpha1/nodefeaturerule.go
+++ b/api/generated/informers/externalversions/nfd/v1alpha1/nodefeaturerule.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/listers/nfd/v1alpha1/expansion_generated.go
+++ b/api/generated/listers/nfd/v1alpha1/expansion_generated.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/listers/nfd/v1alpha1/nodefeature.go
+++ b/api/generated/listers/nfd/v1alpha1/nodefeature.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/listers/nfd/v1alpha1/nodefeaturegroup.go
+++ b/api/generated/listers/nfd/v1alpha1/nodefeaturegroup.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/generated/listers/nfd/v1alpha1/nodefeaturerule.go
+++ b/api/generated/listers/nfd/v1alpha1/nodefeaturerule.go
@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
--- a/api/nfd/v1alpha1/types.go
+++ b/api/nfd/v1alpha1/types.go
@ -42,7 +42,8 @@ type NodeFeature struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`

 	// Specification of the NodeFeature, containing features discovered for a node.
-	Spec NodeFeatureSpec `json:"spec"`
+	Spec   NodeFeatureSpec   `json:"spec"`
+	Status NodeFeatureStatus `json:"status"`
 }

 // NodeFeatureSpec describes a NodeFeature object.
@ -55,6 +56,22 @@ type NodeFeatureSpec struct {
 	Labels map[string]string `json:"labels"`
 }

+// Status of a NodeFeature object.
+type NodeFeatureStatus struct {
+	// UTC time when the NodeFeature object was last updated.
+	// +optional
+	LastAppliedAt metav1.Time `json:"lastAppliedAt,omitempty"`
+	// +optional
+	// Number of features discovered.
+	NumberOfFeatures int `json:"numberOfFeatures,omitempty"`
+	// +optional
+	// Number of errors during last feature discovery.
+	NumberOfFeatureErrors int `json:"numberOfFeatureErrors,omitempty"`
+	// +optional
+	// Number of labels created.
+	NumberOfLabels int `json:"numberOfLabels,omitempty"`
+}
+
 // Features is the collection of all discovered features.
 type Features struct {
 	// Flags contains all the flag-type features of the node.
--- a/api/nfd/v1alpha1/zz_generated.deepcopy.go
+++ b/api/nfd/v1alpha1/zz_generated.deepcopy.go
@ -2,7 +2,7 @@
 // +build !ignore_autogenerated

 /*
-Copyright 2024 The Kubernetes Authors.
+Copyright 2025 The Kubernetes Authors.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@ -379,6 +379,7 @@ func (in *NodeFeature) DeepCopyInto(out *NodeFeature) {
 	out.TypeMeta = in.TypeMeta
 	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
 	in.Spec.DeepCopyInto(&out.Spec)
+	in.Status.DeepCopyInto(&out.Status)
 	return
 }

@ -645,6 +646,23 @@ func (in *NodeFeatureSpec) DeepCopy() *NodeFeatureSpec {
 	return out
 }

+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *NodeFeatureStatus) DeepCopyInto(out *NodeFeatureStatus) {
+	*out = *in
+	in.LastAppliedAt.DeepCopyInto(&out.LastAppliedAt)
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeFeatureStatus.
+func (in *NodeFeatureStatus) DeepCopy() *NodeFeatureStatus {
+	if in == nil {
+		return nil
+	}
+	out := new(NodeFeatureStatus)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *Rule) DeepCopyInto(out *Rule) {
 	*out = *in
--- a/deployment/base/nfd-crds/nfd-api-crds.yaml
+++ b/deployment/base/nfd-crds/nfd-api-crds.yaml
@ -115,8 +115,26 @@ spec:
                  be created.
                type: object
            type: object
+          status:
+            description: Status of a NodeFeature object.
+            properties:
+              lastAppliedAt:
+                description: UTC time when the NodeFeature object was last updated.
+                format: date-time
+                type: string
+              numberOfFeatureErrors:
+                description: Number of errors during last feature discovery.
+                type: integer
+              numberOfFeatures:
+                description: Number of features discovered.
+                type: integer
+              numberOfLabels:
+                description: Number of labels created.
+                type: integer
+            type: object
        required:
        - spec
+        - status
        type: object
    served: true
    storage: true
--- a/deployment/helm/node-feature-discovery/crds/nfd-api-crds.yaml
+++ b/deployment/helm/node-feature-discovery/crds/nfd-api-crds.yaml
@ -115,8 +115,26 @@ spec:
                  be created.
                type: object
            type: object
+          status:
+            description: Status of a NodeFeature object.
+            properties:
+              lastAppliedAt:
+                description: UTC time when the NodeFeature object was last updated.
+                format: date-time
+                type: string
+              numberOfFeatureErrors:
+                description: Number of errors during last feature discovery.
+                type: integer
+              numberOfFeatures:
+                description: Number of features discovered.
+                type: integer
+              numberOfLabels:
+                description: Number of labels created.
+                type: integer
+            type: object
        required:
        - spec
+        - status
        type: object
    served: true
    storage: true
--- a/pkg/nfd-worker/nfd-worker.go
+++ b/pkg/nfd-worker/nfd-worker.go
@ -113,17 +113,18 @@ type ConfigOverrideArgs struct {
 }

 type nfdWorker struct {
-	args                Args
-	configFilePath      string
-	config              *NFDConfig
-	kubernetesNamespace string
-	healthServer        *grpc.Server
-	k8sClient           k8sclient.Interface
-	nfdClient           nfdclient.Interface
-	stop                chan struct{} // channel for signaling stop
-	featureSources      []source.FeatureSource
-	labelSources        []source.LabelSource
-	ownerReference      []metav1.OwnerReference
+	args                        Args
+	configFilePath              string
+	config                      *NFDConfig
+	kubernetesNamespace         string
+	healthServer                *grpc.Server
+	k8sClient                   k8sclient.Interface
+	nfdClient                   nfdclient.Interface
+	stop                        chan struct{} // channel for signaling stop
+	featureSources              []source.FeatureSource
+	numberOfFeatureSourceErrors int
+	labelSources                []source.LabelSource
+	ownerReference              []metav1.OwnerReference
 }

 // This ticker can represent infinite and normal intervals.
@ -242,9 +243,11 @@ func (w *nfdWorker) startGrpcHealthServer(errChan chan<- error) error {
 // Run feature discovery.
 func (w *nfdWorker) runFeatureDiscovery() error {
 	discoveryStart := time.Now()
+	w.numberOfFeatureSourceErrors = 0
 	for _, s := range w.featureSources {
 		currentSourceStart := time.Now()
 		if err := s.Discover(); err != nil {
+			w.numberOfFeatureSourceErrors++
 			klog.ErrorS(err, "feature discovery failed", "source", s.Name())
 		}
 		klog.V(3).InfoS("feature discovery completed", "featureSource", s.Name(), "duration", time.Since(currentSourceStart))
@ -667,6 +670,13 @@ func (m *nfdWorker) updateNodeFeatureObject(labels Labels) error {
 		}
 		klog.InfoS("creating NodeFeature object", "nodefeature", klog.KObj(nfr))

+		nfr.Status = nfdv1alpha1.NodeFeatureStatus{
+			LastAppliedAt:         metav1.Time{Time: time.Now().UTC()},
+			NumberOfFeatures:      len(m.featureSources),
+			NumberOfFeatureErrors: m.numberOfFeatureSourceErrors,
+			NumberOfLabels:        len(m.labelSources),
+		}
+
 		nfrCreated, err := cli.NfdV1alpha1().NodeFeatures(namespace).Create(context.TODO(), nfr, metav1.CreateOptions{})
 		if err != nil {
 			return fmt.Errorf("failed to create NodeFeature object %q: %w", nfr.Name, err)
@ -684,7 +694,12 @@ func (m *nfdWorker) updateNodeFeatureObject(labels Labels) error {
 			Features: *features,
 			Labels:   labels,
 		}
-
+		nfrUpdated.Status = nfdv1alpha1.NodeFeatureStatus{
+			LastAppliedAt:         metav1.Time{Time: time.Now().UTC()},
+			NumberOfFeatures:      len(m.featureSources),
+			NumberOfFeatureErrors: m.numberOfFeatureSourceErrors,
+			NumberOfLabels:        len(m.labelSources),
+		}
 		if !apiequality.Semantic.DeepEqual(nfr, nfrUpdated) {
 			klog.InfoS("updating NodeFeature object", "nodefeature", klog.KObj(nfr))
 			nfrUpdated, err = cli.NfdV1alpha1().NodeFeatures(namespace).Update(context.TODO(), nfrUpdated, metav1.UpdateOptions{})
--- a/pkg/nfd-worker/nfd-worker_test.go
+++ b/pkg/nfd-worker/nfd-worker_test.go
@ -128,6 +128,12 @@ func TestRun(t *testing.T) {
 							},
 						},
 					},
+					Status: nfdv1alpha1.NodeFeatureStatus{
+						LastAppliedAt:         nf.Status.LastAppliedAt,
+						NumberOfFeatures:      1,
+						NumberOfFeatureErrors: 0,
+						NumberOfLabels:        1,
+					},
 				}
 				So(nf, ShouldResemble, nfExpected)
 			})
--- a/test/e2e/node_feature_discovery_test.go
+++ b/test/e2e/node_feature_discovery_test.go
@ -479,6 +479,19 @@ var _ = NFDDescribe(Label("nfd-master"), func() {
 				}
 				eventuallyNonControlPlaneNodes(ctx, f.ClientSet).Should(MatchLabels(expectedLabels, nodes))

+				By("Verifying the CRD status")
+				nf, err := nfdClient.NfdV1alpha1().NodeFeatures(f.Namespace.Name).Get(ctx, targetNodeName, metav1.GetOptions{})
+				Expect(err).NotTo(HaveOccurred(), "Error getting NodeFeature object: %q", err)
+
+				expectedStatus := nfdv1alpha1.NodeFeatureStatus{
+					LastAppliedAt:         nf.Status.LastAppliedAt,
+					NumberOfFeatures:      nf.Status.NumberOfFeatures,
+					NumberOfFeatureErrors: 0,
+					NumberOfLabels:        len(expectedLabels[targetNodeName]) - 1,
+				}
+				isEqual := (expectedStatus == nf.Status)
+				Expect(isEqual).To(BeTrue())
+
 				By("Deleting nfd-worker daemonset")
 				err = f.ClientSet.AppsV1().DaemonSets(f.Namespace.Name).Delete(ctx, workerDS.Name, metav1.DeleteOptions{})
 				Expect(err).NotTo(HaveOccurred())