wip: label export

Signed-off-by: vsoch <[email protected]>

Author: vsoch

cmd/nfd/subcmd/export/features.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.
@@ -50,30 +50,8 @@ func NewExportCmd() *cobra.Command {
 				}
 			}
 
-			// Make into flat format.
 			features := source.GetAllFeatures()
-			featureListing := map[string]string{}
-
-			// A flag's presence == true
-			for flagName := range features.Flags {
-				featureListing[flagName] = "true"
-			}
-
-			// Attributes are sets of elements (key value pairs)
-			for featureName, featureSet := range features.Attributes {
-				for elementName, elementValue := range featureSet.Elements {
-					featureListing[fmt.Sprintf("%s.%s", featureName, elementName)] = elementValue
-				}
-			}
-
-			for featureName, featureSet := range features.Instances {
-				for i, element := range featureSet.Elements {
-					for attrName, attrValue := range element.Attributes {
-						featureListing[fmt.Sprintf("%s.%d.%s", featureName, i, attrName)] = attrValue
-					}
-				}
-			}
-			exportedLabels, err := json.MarshalIndent(featureListing, "", "    ")
+			exportedLabels, err := json.MarshalIndent(features, "", "    ")
 			if err != nil {
 				return err
 			}

cmd/nfd/subcmd/export/labels.go

@@ -0,0 +1,105 @@
+/*
+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.
+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 export
+
+import (
+	"encoding/json"
+	"fmt"
+	"maps"
+	"os"
+	"regexp"
+	"slices"
+	"sort"
+
+	"github.com/spf13/cobra"
+	"k8s.io/klog/v2"
+
+	worker "sigs.k8s.io/node-feature-discovery/pkg/nfd-worker"
+	"sigs.k8s.io/node-feature-discovery/source"
+)
+
+func NewLabelsCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "labels",
+		Short: "Export feature labels for given node",
+		RunE: func(cmd *cobra.Command, args []string) error {
+
+			// Determine enabled feature sources
+			featureSources := make(map[string]source.FeatureSource)
+			for n, s := range source.GetAllFeatureSources() {
+				if ts, ok := s.(source.SupplementalSource); !ok || !ts.DisableByDefault() {
+					featureSources[n] = s
+				}
+			}
+			featureSourceList := slices.Collect(maps.Values(featureSources))
+			sort.Slice(featureSourceList, func(i, j int) bool { return featureSourceList[i].Name() < featureSourceList[j].Name() })
+
+			// Determine enabled label sources
+			labelSources := make(map[string]source.LabelSource)
+			for n, s := range source.GetAllLabelSources() {
+				if ts, ok := s.(source.SupplementalSource); !ok || !ts.DisableByDefault() {
+					labelSources[n] = s
+				}
+			}
+			labelSourcesList := slices.Collect(maps.Values(labelSources))
+			sort.Slice(labelSourcesList, func(i, j int) bool {
+				iP, jP := labelSourcesList[i].Priority(), labelSourcesList[j].Priority()
+				if iP != jP {
+					return iP < jP
+				}
+				return labelSourcesList[i].Name() < labelSourcesList[j].Name()
+			})
+
+			labels := worker.Labels{}
+			labelWhiteList := *regexp.MustCompile("")
+
+			// Get labels from all enabled label sources
+			for _, source := range labelSourcesList {
+				labelsFromSource, err := worker.GetFeatureLabels(source, labelWhiteList)
+				if err != nil {
+					klog.ErrorS(err, "discovery failed", "source", source.Name())
+					continue
+				}
+				maps.Copy(labels, labelsFromSource)
+			}
+
+			exportedLabels, err := json.MarshalIndent(labels, "", "    ")
+			if err != nil {
+				return err
+			}
+
+			if outputPath != "" {
+				fd, err := os.Create(outputPath)
+				if err != nil {
+					return err
+				}
+				defer fd.Close()
+				_, err = fmt.Fprint(fd, string(exportedLabels))
+				return err
+			} else {
+				fmt.Println(string(exportedLabels))
+			}
+			return nil
+		},
+	}
+	cmd.Flags().StringVar(&outputPath, "path", "", "export to this JSON path")
+	return cmd
+}
+
+func init() {
+	ExportCmd.AddCommand(NewLabelsCmd())
+}

docs/usage/nfd-export.md

@@ -1,5 +1,5 @@
 ---
-title: "Feature Export"
+title: "Export"
 layout: default
 sort: 12
 ---
@@ -15,13 +15,15 @@ sort: 12
 
 ---
 
-## Feature Export
+## Export 
+
+If you are interested in exporting features or labels in a generic context, the nfd client supports an export mode, where both can be derived on the command line.
+
+### Feature Export
 
 **Feature export is in the experimental `v1alpha1` version.**
 
-If you are interested in exporting features in a generic context, the nfd client supports an export mode, where features can be derived without requiring a Kubernetes context.
-This addresses use cases such as high performance computing (HPC) and other environments with compute nodes that warrant assessment, but may not have Kubernetes running, or may not be able to or want to run a central daemon service for data. 
-To use export, you can use `nfd export features`:
+This addresses use cases such as high performance computing (HPC) and other environments with compute nodes that warrant assessment, but may not have Kubernetes running, or may not be able to or want to run a central daemon service for data. To export features, you can use `nfd export features`:
 
 ```bash
 nfd export features
@@ -32,4 +34,18 @@ To save to a file path:
 
 ```bash
 nfd export features --path features.json
+```
+
+### Label Export
+
+To export equivalent labels outside of a Kubernetes context, you can use `nfd export labels`.
+
+```bash
+nfd export labels
+```
+
+Or export to an output file:
+
+```bash
+nfd export labels --path labels.json
 ```

pkg/nfd-worker/nfd-worker-internal_test.go

@@ -54,7 +54,7 @@ func TestGetLabelsWithMockSources(t *testing.T) {
 			mockLabelSource.On("Name").Return(fakeLabelSourceName)
 			mockLabelSource.On("GetLabels").Return(fakeFeatures, nil)
 
-			returnedLabels, err := getFeatureLabels(fakeLabelSource, labelWhiteList.Regexp)
+			returnedLabels, err := GetFeatureLabels(fakeLabelSource, labelWhiteList.Regexp)
 			Convey("Proper label is returned", func() {
 				So(returnedLabels, ShouldResemble, fakeFeatureLabels)
 			})
@@ -67,7 +67,7 @@ func TestGetLabelsWithMockSources(t *testing.T) {
 			expectedError := errors.New("fake error")
 			mockLabelSource.On("GetLabels").Return(nil, expectedError)
 
-			returnedLabels, err := getFeatureLabels(fakeLabelSource, labelWhiteList.Regexp)
+			returnedLabels, err := GetFeatureLabels(fakeLabelSource, labelWhiteList.Regexp)
 			Convey("No label is returned", func() {
 				So(returnedLabels, ShouldBeNil)
 			})

pkg/nfd-worker/nfd-worker.go

@@ -537,7 +537,7 @@ func createFeatureLabels(sources []source.LabelSource, labelWhiteList regexp.Reg
 	// Get labels from all enabled label sources
 	klog.InfoS("starting feature discovery...")
 	for _, source := range sources {
-		labelsFromSource, err := getFeatureLabels(source, labelWhiteList)
+		labelsFromSource, err := GetFeatureLabels(source, labelWhiteList)
 		if err != nil {
 			klog.ErrorS(err, "discovery failed", "source", source.Name())
 			continue
@@ -555,7 +555,7 @@ func createFeatureLabels(sources []source.LabelSource, labelWhiteList regexp.Reg
 
 // getFeatureLabels returns node labels for features discovered by the
 // supplied source.
-func getFeatureLabels(source source.LabelSource, labelWhiteList regexp.Regexp) (labels Labels, err error) {
+func GetFeatureLabels(source source.LabelSource, labelWhiteList regexp.Regexp) (labels Labels, err error) {
 	labels = Labels{}
 	features, err := source.GetLabels()
 	if err != nil {