Add NodeFeatureGroup API

Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
kubernetes-sigs · Dec 1, 2023 · 15fc860 · 15fc860
1 parent bdfef6d
commit 15fc860
Show file tree

Hide file tree

Showing 45 changed files with 5,724 additions and 104 deletions.
diff --git a/cmd/nfd-master/main.go b/cmd/nfd-master/main.go
@@ -133,6 +133,8 @@ func initFlags(flagset *flag.FlagSet) (*master.Args, *master.ConfigOverrideArgs)
 	flagset.BoolVar(&args.EnableNodeFeatureApi, "enable-nodefeature-api", true,
 		"Enable the NodeFeature CRD API for receiving node features. This will automatically disable the gRPC communication."+
 			" DEPRECATED: will be removed in a future release along with the deprecated gRPC API.")
+	flagset.BoolVar(&args.EnableNodeFeatureGroupApi, "enable-nodefeaturegroup-api", true,
+		"Enable the NodeFeatureGroup CRD API for receiving cluster feature rules.")
 	flagset.BoolVar(&args.CrdController, "featurerules-controller", true,
 		"Enable NFD CRD API controller. DEPRECATED: use -crd-controller instead")
 	flagset.BoolVar(&args.CrdController, "crd-controller", true,

diff --git a/deployment/base/nfd-crds/nfd-api-crds.yaml b/deployment/base/nfd-crds/nfd-api-crds.yaml
diff --git a/deployment/base/rbac/master-clusterrole.yaml b/deployment/base/rbac/master-clusterrole.yaml
@@ -22,6 +22,17 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - nfd.k8s-sigs.io
+  resources:
+  - nodefeaturegroups
+  - nodefeaturegrouprules
+  verbs:
+  - get
+  - list
+  - watch
+  - update
+  - create
 - apiGroups:
   - coordination.k8s.io
   resources:

diff --git a/deployment/helm/node-feature-discovery/crds/nfd-api-crds.yaml b/deployment/helm/node-feature-discovery/crds/nfd-api-crds.yaml
diff --git a/deployment/helm/node-feature-discovery/templates/clusterrole.yaml b/deployment/helm/node-feature-discovery/templates/clusterrole.yaml
@@ -25,6 +25,17 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - nfd.k8s-sigs.io
+  resources:
+  - nodefeaturegroups
+  - nodefeaturegrouprules
+  verbs:
+  - get
+  - list
+  - watch
+  - update
+  - create
 - apiGroups:
   - coordination.k8s.io
   resources:

diff --git a/deployment/helm/node-feature-discovery/templates/master.yaml b/deployment/helm/node-feature-discovery/templates/master.yaml
@@ -70,6 +70,9 @@ spec:
             {{- if .Values.master.instance | empty | not }}
             - "-instance={{ .Values.master.instance }}"
             {{- end }}
+            {{- if not .Values.enableNodeFeatureGroup }}
+            - "-enable-nodefeature-group=false"
+            {{- end }}
             {{- if not .Values.enableNodeFeatureApi }}
             - "-port={{ .Values.master.port | default "8080" }}"
             - "-enable-nodefeature-api=false"

diff --git a/deployment/helm/node-feature-discovery/values.yaml b/deployment/helm/node-feature-discovery/values.yaml
@@ -11,6 +11,7 @@ fullnameOverride: ""
 namespaceOverride: ""
 
 enableNodeFeatureApi: true
+enableNodeFeatureGroup: true
 
 master:
   enable: true

diff --git a/docs/reference/master-commandline-reference.md b/docs/reference/master-commandline-reference.md
@@ -181,6 +181,20 @@ Example:
 nfd-master -enable-nodefeature-api=false
 ```
 
+### -enable-nodefeaturegroup-api
+
+The `-enable-nodefeaturegroup-api` flag enables/disables the
+[NodeFeatureGroup](../usage/custom-resources.md#nodefeaturegroup) CRD API for
+working with NodeFeatureGroups.
+
+Default: true
+
+Example:
+
+```bash
+nfd-master -enable-nodefeaturegroup-api=false
+```
+
 ### -enable-leader-election
 
 The `-enable-leader-election` flag enables leader election for NFD-Master.

diff --git a/docs/usage/custom-resources.md b/docs/usage/custom-resources.md
@@ -86,6 +86,54 @@ See the
 [Customization guide](customization-guide.md#node-feature-rule-custom-resource)
 for full documentation of the NodeFeatureRule resource and its usage.
 
+## NodeFeatureGroup
+
+NodeFeatureGroup is an NFD-specific custom resource that is designed for
+grouping Nodes by matching features rules. NFD-Master watches for
+NodeFeatureGroupRules objects in the cluster and creates a NodeFeatureGroup
+object for each NodeFeatureGroupRule. The NodeFeatureGroup object contains a
+list of nodes that match the NodeFeatureGroupRule.
+
+```yaml
+apiVersion: nfd.k8s-sigs.io/v1alpha1
+kind: NodeFeatureGroup
+metadata:
+  name: my-sample-group-resource
+  namespace: node-feature-discovery
+spec:
+  FeatureGroup:
+    name: my-sample-group-resource
+    nodes:
+    - node-1
+    - node-2
+    - node-3
+```
+
+## NodeFeatureGroupRule
+
+NodeFeatureGroupRule is an NFD-specific custom resource that is designed for
+grouping Nodes by matching features rules. NFD-Master watches for
+NodeFeatureGroupRules objects in the cluster and creates a NodeFeatureGroup
+object for each NodeFeatureGroupRule. 
+
+NodeFeatureGroupRule is similar to NodeFeatureRule, but instead of labeling
+nodes, it creates a NodeFeatureGroup object that contains a list of nodes that
+match the NodeFeatureGroupRule.
+
+```yaml
+apiVersion: nfd.k8s-sigs.io/v1alpha1
+kind: NodeFeatureGroupRule
+metadata:
+  name: my-sample-group-resource
+spec:
+  featureGroupRules:
+    - name: dummy-rule
+      matchFeatures:
+        - feature: kernel.version
+          matchExpressions:
+            major: {op: Exists}
+```
+
 ## NodeResourceTopology
 
 When run with NFD-Topology-Updater, NFD creates NodeResourceTopology objects

diff --git a/examples/nodefeaturerule.yaml b/examples/nodefeaturerule.yaml
@@ -29,3 +29,15 @@ spec:
         - feature: kernel.version
           matchExpressions:
             major: {op: Exists}
+---
+apiVersion: nfd.k8s-sigs.io/v1alpha1
+kind: NodeFeatureGroupRule
+metadata:
+  name: my-sample-group-resource
+spec:
+  featureGroupRules:
+    - name: dummy-rule
+      matchFeatures:
+        - feature: kernel.version
+          matchExpressions:
+            major: {op: Exists}