@@ -510,11 +510,11 @@ the matchers):
510
510
511
511
# ## Fields
512
512
513
- # ### Name
513
+ # ### name
514
514
515
515
The `.name` field is required and used as an identifier of the rule.
516
516
517
- # ### Labels
517
+ # ### labels
518
518
519
519
The `.labels` is a map of the node labels to create if the rule matches.
520
520
@@ -550,7 +550,7 @@ This will yield into the following node label:
550
550
feature.node.kubernetes.io/custom-label: "customlabel"
551
551
` ` `
552
552
553
- # ### Labels template
553
+ # ### labelsTemplate
554
554
555
555
The `.labelsTemplate` field specifies a text template for dynamically creating
556
556
labels based on the matched features. See [templating](#templating) for
@@ -560,9 +560,10 @@ details.
560
560
> labels specified in the `labels` field will override anything
561
561
> originating from `labelsTemplate`.
562
562
563
- # ### Node Annotations
563
+ # ### annotations
564
564
565
- The `.annotations` field is a list of features to be advertised as annotations.
565
+ The `.annotations` field is a list of features to be advertised as node
566
+ annotations.
566
567
567
568
Take this rule as a referential example :
568
569
@@ -608,7 +609,7 @@ NFD enforces some limitations to the namespace (or prefix)/ of the annotations:
608
609
> annotations the features won't be advertised as node labels unless they are
609
610
> specified in the `labels` field.
610
611
611
- # ### Taints
612
+ # ### taints
612
613
613
614
*taints* is a list of taint entries and each entry can have `key`, `value` and `effect`,
614
615
where the `value` is optional. Effect could be `NoSchedule`, `PreferNoSchedule`
@@ -655,14 +656,14 @@ key:
655
656
> **NOTE:** taints field is not available for the custom rules of nfd-worker
656
657
> and only for NodeFeatureRule objects.
657
658
658
- # ### Vars
659
+ # ### vars
659
660
660
661
The `.vars` field is a map of values (key-value pairs) to store for subsequent
661
662
rules to use. In other words, these are variables that are not advertised as
662
663
node labels. See [backreferences](#backreferences) for more details on the
663
664
usage of vars.
664
665
665
- # ### Extended resources
666
+ # ### extendedResources
666
667
667
668
The `.extendedResources` field is a list of extended resources to advertise.
668
669
See [extended resources](#extended-resources) for more details.
@@ -725,7 +726,7 @@ Resources names:
725
726
> [custom feature source](#custom-feature-source) -- it can only be used in
726
727
> NodeFeatureRule objects.
727
728
728
- # ### Vars template
729
+ # ### varsTemplate
729
730
730
731
The `.varsTemplate` field specifies a text template for dynamically creating
731
732
vars based on the matched features. See [templating](#templating) for details
@@ -736,7 +737,7 @@ the usage of vars.
736
737
> vars specified in the `vars` field will override anything originating from
737
738
> `varsTemplate`.
738
739
739
- # ### MatchFeatures
740
+ # ### matchFeatures
740
741
741
742
The `.matchFeatures` field specifies a feature matcher, consisting of a list of
742
743
feature matcher terms. It implements a logical AND over the terms i.e. all
@@ -784,7 +785,7 @@ element whose name matches the `<key>`. However, for *instance* features all
784
785
MatchExpressions are evaluated against the attributes of each instance
785
786
separately.
786
787
787
- # ### MatchAny
788
+ # ### matchAny
788
789
789
790
The `.matchAny` field is a list of of [`matchFeatures`](#matchfeatures)
790
791
matchers. A logical OR is applied over the matchers, i.e. at least one of them
0 commit comments