mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-09 10:17:04 +00:00
f75303ce43
Support backreferencing of output values from previous rules. Enables
complex rule setups where custom features are further combined together
to form even more sophisticated higher level labels. The labels created
by preceding rules are available as a special 'rule.matched' feature
(for matchFeatures to use).
If referencing rules accross multiple configs/CRDs care must be taken
with the ordering. Processing order of rules in nfd-worker:
1. Static rules
2. Files from /etc/kubernetes/node-feature-discovery/custom.d/
in alphabetical order. Subdirectories are processed by reading their
files in alphabetical order.
3. Custom rules from main nfd-worker.conf
In nfd-master, NodeFeatureRule objects are processed in alphabetical
order (based on their metadata.name).
This patch also adds new 'vars' fields to the rule spec. Like 'labels',
it is a map of key-value pairs but no labels are generated from these.
The values specified in 'vars' are only added for backreferencing into
the 'rules.matched' feature. This may by desired in schemes where the
output of certain rules is only used as intermediate variables for other
rules and no labels out of these are wanted.
An example setup:
- name: "kernel feature"
labels:
kernel-feature:
matchFeatures:
- feature: kernel.version
matchExpressions:
major: {op: Gt, value: ["4"]}
- name: "intermediate var feature"
vars:
nolabel-feature: "true"
matchFeatures:
- feature: cpu.cpuid
matchExpressions:
AVX512F: {op: Exists}
- feature: pci.device
matchExpressions:
vendor: {op: In, value: ["8086"]}
device: {op: In, value: ["1234", "1235"]}
- name: top-level-feature
matchFeatures:
- feature: rule.matched
matchExpressions:
kernel-feature: "true"
nolabel-feature: "true"
217 lines
11 KiB
YAML
217 lines
11 KiB
YAML
|
|
---
|
|
apiVersion: apiextensions.k8s.io/v1
|
|
kind: CustomResourceDefinition
|
|
metadata:
|
|
annotations:
|
|
controller-gen.kubebuilder.io/version: v0.7.0
|
|
creationTimestamp: null
|
|
name: nodefeaturerules.nfd.k8s-sigs.io
|
|
spec:
|
|
group: nfd.k8s-sigs.io
|
|
names:
|
|
kind: NodeFeatureRule
|
|
listKind: NodeFeatureRuleList
|
|
plural: nodefeaturerules
|
|
singular: nodefeaturerule
|
|
scope: Cluster
|
|
versions:
|
|
- name: v1alpha1
|
|
schema:
|
|
openAPIV3Schema:
|
|
description: NodeFeatureRule resource specifies a configuration for feature-based
|
|
customization of node objects, such as node labeling.
|
|
properties:
|
|
apiVersion:
|
|
description: 'APIVersion defines the versioned schema of this representation
|
|
of an object. Servers should convert recognized schemas to the latest
|
|
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
|
|
type: string
|
|
kind:
|
|
description: 'Kind is a string value representing the REST resource this
|
|
object represents. Servers may infer this from the endpoint the client
|
|
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
|
|
type: string
|
|
metadata:
|
|
type: object
|
|
spec:
|
|
description: NodeFeatureRuleSpec describes a NodeFeatureRule.
|
|
properties:
|
|
rules:
|
|
description: Rules is a list of node customization rules.
|
|
items:
|
|
description: Rule defines a rule for node customization such as
|
|
labeling.
|
|
properties:
|
|
labels:
|
|
additionalProperties:
|
|
type: string
|
|
description: Labels to create if the rule matches.
|
|
type: object
|
|
labelsTemplate:
|
|
description: LabelsTemplate specifies a template to expand for
|
|
dynamically generating multiple labels. Data (after template
|
|
expansion) must be keys with an optional value (<key>[=<value>])
|
|
separated by newlines.
|
|
type: string
|
|
matchAny:
|
|
description: MatchAny specifies a list of matchers one of which
|
|
must match.
|
|
items:
|
|
description: MatchAnyElem specifies one sub-matcher of MatchAny.
|
|
properties:
|
|
matchFeatures:
|
|
description: MatchFeatures specifies a set of matcher
|
|
terms all of which must match.
|
|
items:
|
|
description: FeatureMatcherTerm defines requirements
|
|
against one feature set. All requirements (specified
|
|
as MatchExpressions) are evaluated against each element
|
|
in the feature set.
|
|
properties:
|
|
feature:
|
|
type: string
|
|
matchExpressions:
|
|
additionalProperties:
|
|
description: "MatchExpression specifies an expression
|
|
to evaluate against a set of input values. It
|
|
contains an operator that is applied when matching
|
|
the input and an array of values that the operator
|
|
evaluates the input against. \n NB: CreateMatchExpression
|
|
or MustCreateMatchExpression() should be used
|
|
for creating new instances. NB: Validate()
|
|
must be called if Op or Value fields are modified
|
|
or if a new instance is created from scratch
|
|
without using the helper functions."
|
|
properties:
|
|
op:
|
|
description: Op is the operator to be applied.
|
|
enum:
|
|
- In
|
|
- NotIn
|
|
- InRegexp
|
|
- Exists
|
|
- DoesNotExist
|
|
- Gt
|
|
- Lt
|
|
- GtLt
|
|
- IsTrue
|
|
- IsFalse
|
|
type: string
|
|
value:
|
|
description: Value is the list of values that
|
|
the operand evaluates the input against.
|
|
Value should be empty if the operator is
|
|
Exists, DoesNotExist, IsTrue or IsFalse.
|
|
Value should contain exactly one element
|
|
if the operator is Gt or Lt and exactly
|
|
two elements if the operator is GtLt. In
|
|
other cases Value should contain at least
|
|
one element.
|
|
items:
|
|
type: string
|
|
type: array
|
|
required:
|
|
- op
|
|
type: object
|
|
description: MatchExpressionSet contains a set of
|
|
MatchExpressions, each of which is evaluated against
|
|
a set of input values.
|
|
type: object
|
|
required:
|
|
- feature
|
|
- matchExpressions
|
|
type: object
|
|
type: array
|
|
required:
|
|
- matchFeatures
|
|
type: object
|
|
type: array
|
|
matchFeatures:
|
|
description: MatchFeatures specifies a set of matcher terms
|
|
all of which must match.
|
|
items:
|
|
description: FeatureMatcherTerm defines requirements against
|
|
one feature set. All requirements (specified as MatchExpressions)
|
|
are evaluated against each element in the feature set.
|
|
properties:
|
|
feature:
|
|
type: string
|
|
matchExpressions:
|
|
additionalProperties:
|
|
description: "MatchExpression specifies an expression
|
|
to evaluate against a set of input values. It contains
|
|
an operator that is applied when matching the input
|
|
and an array of values that the operator evaluates
|
|
the input against. \n NB: CreateMatchExpression or
|
|
MustCreateMatchExpression() should be used for creating
|
|
new instances. NB: Validate() must be called if Op
|
|
or Value fields are modified or if a new instance
|
|
is created from scratch without using the helper functions."
|
|
properties:
|
|
op:
|
|
description: Op is the operator to be applied.
|
|
enum:
|
|
- In
|
|
- NotIn
|
|
- InRegexp
|
|
- Exists
|
|
- DoesNotExist
|
|
- Gt
|
|
- Lt
|
|
- GtLt
|
|
- IsTrue
|
|
- IsFalse
|
|
type: string
|
|
value:
|
|
description: Value is the list of values that the
|
|
operand evaluates the input against. Value should
|
|
be empty if the operator is Exists, DoesNotExist,
|
|
IsTrue or IsFalse. Value should contain exactly
|
|
one element if the operator is Gt or Lt and exactly
|
|
two elements if the operator is GtLt. In other
|
|
cases Value should contain at least one element.
|
|
items:
|
|
type: string
|
|
type: array
|
|
required:
|
|
- op
|
|
type: object
|
|
description: MatchExpressionSet contains a set of MatchExpressions,
|
|
each of which is evaluated against a set of input values.
|
|
type: object
|
|
required:
|
|
- feature
|
|
- matchExpressions
|
|
type: object
|
|
type: array
|
|
name:
|
|
description: Name of the rule.
|
|
type: string
|
|
vars:
|
|
additionalProperties:
|
|
type: string
|
|
description: Vars is the variables to store if the rule matches.
|
|
Variables do not directly inflict any changes in the node
|
|
object. However, they can be referenced from other rules enabling
|
|
more complex rule hierarchies, without exposing intermediary
|
|
output values as labels.
|
|
type: object
|
|
required:
|
|
- name
|
|
type: object
|
|
type: array
|
|
required:
|
|
- rules
|
|
type: object
|
|
required:
|
|
- spec
|
|
type: object
|
|
served: true
|
|
storage: true
|
|
status:
|
|
acceptedNames:
|
|
kind: ""
|
|
plural: ""
|
|
conditions: []
|
|
storedVersions: []
|