Add kubectl-nfd

kubectl-nfd is a kubectl plugin for debbuging NodeFeatureRules

Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>

Author: ArangoGutierrez

Makefile

@@ -1,4 +1,4 @@
-.PHONY: all test templates yamls
+.PHONY: all test templates yamls build build-%
 .FORCE:
 
 GO_CMD ?= go
@@ -90,12 +90,17 @@ IMAGE_BUILD_ARGS_MINIMAL = --target minimal \
 
 all: image
 
-build:
-	@mkdir -p bin
-	$(GO_CMD) build -v -o bin $(BUILD_FLAGS) ./cmd/...
+BUILD_BINARIES := nfd-master nfd-worker nfd-topology-updater nfd-gc kubectl-nfd
 
-install:
-	$(GO_CMD) install -v $(BUILD_FLAGS) ./cmd/...
+build-%:
+	$(GO_CMD) build -v -o bin $(BUILD_FLAGS) ./cmd/$*
+
+build:	$(foreach bin, $(BUILD_BINARIES), build-$(bin))
+
+install-%:
+	$(GO_CMD) install -v $(BUILD_FLAGS) ./cmd/$*
+
+install:	$(foreach bin, $(BUILD_BINARIES), install-$(bin))
 
 image: yamls
 	$(IMAGE_BUILD_CMD) $(IMAGE_BUILD_ARGS) $(IMAGE_BUILD_ARGS_FULL)

cmd/kubectl-nfd/main.go

@@ -0,0 +1,28 @@
+/*
+Copyright 2023 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 main
+
+import "sigs.k8s.io/node-feature-discovery/cmd/kubectl-nfd/subcmd"
+
+const (
+	// ProgramName is the canonical name of this program
+	ProgramName = "kubectl-nfd"
+)
+
+func main() {
+	subcmd.Execute()
+}

cmd/kubectl-nfd/subcmd/dryrun.go

@@ -0,0 +1,59 @@
+/*
+Copyright 2023 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 subcmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+	kubectlnfd "sigs.k8s.io/node-feature-discovery/pkg/kubectl-nfd"
+)
+
+var dryrunCmd = &cobra.Command{
+	Use:   "dryrun",
+	Short: "Process a NodeFeatureRule file against a NodeFeature file",
+	Long:  `Process a NodeFeatureRule file against a local NodeFeature file to dry run the rule against a node before applying it to a cluster`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("Evaluating NodeFeatureRule %q against NodeFeature %q\n", nodefeaturerule, nodefeature)
+		err := kubectlnfd.DryRun(nodefeaturerule, nodefeature)
+		if len(err) > 0 {
+			fmt.Printf("NodeFeatureRule %q is not valid for NodeFeature %q\n", nodefeaturerule, nodefeature)
+			for _, e := range err {
+				cmd.PrintErrln(e)
+			}
+			// Return non-zero exit code to indicate failure
+			os.Exit(1)
+		}
+		fmt.Printf("NodeFeatureRule %q is valid for NodeFeature %q\n", nodefeaturerule, nodefeature)
+	},
+}
+
+func init() {
+	RootCmd.AddCommand(dryrunCmd)
+
+	dryrunCmd.Flags().StringVarP(&nodefeaturerule, "nodefeaturerule-file", "f", "", "Path to the NodeFeatureRule file to validate")
+	dryrunCmd.Flags().StringVarP(&nodefeature, "nodefeature-file", "n", "", "Path to the NodeFeature file to validate against")
+	err := dryrunCmd.MarkFlagRequired("nodefeaturerule-file")
+	if err != nil {
+		panic(err)
+	}
+	err = dryrunCmd.MarkFlagRequired("nodefeature-file")
+	if err != nil {
+		panic(err)
+	}
+}

cmd/kubectl-nfd/subcmd/root.go

@@ -0,0 +1,54 @@
+/*
+Copyright 2023 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 subcmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	// Path to the NodeFeatureRule file to validate
+	nodefeaturerule string
+	// Path to the NodeFeature file to run against the NodeFeatureRule
+	nodefeature string
+	// Node to validate against
+	node string
+	// kubeconfig file to use
+	kubeconfig string
+)
+
+// RootCmd represents the base command when called without any subcommands
+var RootCmd = &cobra.Command{
+	Use:   "kubectl-nfd",
+	Short: "NFD kubectl plugin",
+	Long: `kubectl plugin for NFD
+	Debug tool to validate/dryrun/test NodeFeatureRules
+	for more information see: 
+	https://kubernetes-sigs.github.io/node-feature-discovery/v0.14/usage/customization-guide.html#nodefeaturerule-custom-resource`,
+}
+
+// Execute adds all child commands to the root command and sets flags appropriately.
+// This is called by main.main(). It only needs to happen once to the rootCmd.
+func Execute() {
+	if err := RootCmd.Execute(); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+}

cmd/kubectl-nfd/subcmd/test.go

@@ -0,0 +1,56 @@
+/*
+Copyright 2023 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 subcmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+	kubectlnfd "sigs.k8s.io/node-feature-discovery/pkg/kubectl-nfd"
+)
+
+var testCmd = &cobra.Command{
+	Use:   "test",
+	Short: "Test a NodeFeatureRule file against a Node",
+	Long:  `Test a NodeFeatureRule file against a Node to ensure it is valid before applying it to a cluster`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("Evaluating NodeFeatureRule against Node %s\n", node)
+		err := kubectlnfd.Test(nodefeaturerule, node, kubeconfig)
+		if len(err) > 0 {
+			fmt.Printf("NodeFeatureRule is not valid for Node %s\n", node)
+			for _, e := range err {
+				cmd.PrintErrln(e)
+			}
+			// Return non-zero exit code to indicate failure
+			os.Exit(1)
+		}
+		fmt.Printf("NodeFeatureRule is valid for Node %s\n", node)
+	},
+}
+
+func init() {
+	RootCmd.AddCommand(testCmd)
+
+	testCmd.Flags().StringVarP(&nodefeaturerule, "nodefeaturerule-file", "f", "", "Path to the NodeFeatureRule file to validate")
+	testCmd.Flags().StringVarP(&node, "nodename", "n", "", "Node to validate against")
+	testCmd.Flags().StringVarP(&kubeconfig, "kubeconfig", "k", "", "kubeconfig file to use")
+	err := testCmd.MarkFlagRequired("nodefeaturerule-file")
+	if err != nil {
+		panic(err)
+	}
+}

cmd/kubectl-nfd/subcmd/validate.go

@@ -0,0 +1,54 @@
+/*
+Copyright 2023 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 subcmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+	kubectlnfd "sigs.k8s.io/node-feature-discovery/pkg/kubectl-nfd"
+)
+
+var validateCmd = &cobra.Command{
+	Use:   "validate",
+	Short: "Validate a NodeFeatureRule file",
+	Long:  `Validate a NodeFeatureRule file to ensure it is valid before applying it to a cluster`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("Validating NodeFeatureRule %s\n", nodefeaturerule)
+		err := kubectlnfd.ValidateNFR(nodefeaturerule)
+		if len(err) > 0 {
+			fmt.Printf("NodeFeatureRule %s is not valid\n", nodefeaturerule)
+			for _, e := range err {
+				cmd.PrintErrln(e)
+			}
+			// Return non-zero exit code to indicate failure
+			os.Exit(1)
+		}
+		fmt.Printf("NodeFeatureRule %s is valid\n", nodefeaturerule)
+	},
+}
+
+func init() {
+	RootCmd.AddCommand(validateCmd)
+
+	validateCmd.Flags().StringVarP(&nodefeaturerule, "nodefeaturerule-file", "f", "", "Path to the NodeFeatureRule file to validate")
+	err := validateCmd.MarkFlagRequired("nodefeaturerule-file")
+	if err != nil {
+		panic(err)
+	}
+}

docs/reference/plugin-commandline-reference.md

@@ -0,0 +1,68 @@
+---
+title: "Kubectl plugin cmdline reference"
+layout: default
+sort: 8
+---
+
+# Commandline flags of kubectl-nfd (plugin)
+{: .no_toc}
+
+## Table of contents
+{: .no_toc .text-delta}
+
+1. TOC
+{:toc}
+
+---
+
+To quickly view available command line flags execute `kubectl nfd -help`.
+
+### -h, -help
+
+Print usage and exit.
+
+## Validate
+
+Validate a NodeFeatureRule file.
+
+### -f / --nodefeature-file
+
+The `--nodefeature-file` flag specifies the path to the NodeFeatureRule file
+to validate.
+
+## Test
+
+Test a NodeFeatureRule file against a node without applying it.
+
+### -k, --kubeconfig
+
+The `--kubeconfig` flag specifies the path to the kubeconfig file to use for
+CLI requests.
+
+### -s, --namespace
+
+The `--namespace` flag specifies the namespace to use for CLI requests.
+Default: `default`.
+
+### -n, --nodename
+
+The `--nodename` flag specifies the name of the node to test the
+NodeFeatureRule against.
+
+### -f, --nodefeaturerule-file
+
+The `--nodefeaturerule-file` flag specifies the path to the NodeFeatureRule file
+to test.
+
+## DryRun
+
+Process a NodeFeatureRule file against a NodeFeature file.
+
+### -f, --nodefeaturerule-file
+
+The `--nodefeaturerule-file` flag specifies the path to the NodeFeatureRule file
+to test.
+
+### -n, --nodefeature-file
+
+The `--nodefeature-file` flag specifies the path to the NodeFeature file to test.

docs/reference/versions.md

@@ -1,7 +1,7 @@
 ---
 title: "Versions"
 layout: default
-sort: 8
+sort: 9
 ---
 
 # Versions and deprecation