Skip to content

Commit 0a30cf9

Browse files
committed
docs: rename fields sub-headings in customization guide
Rename the sub-section headings of the "Fields" section (describing the fields of NodeFeatureRule) to match the actual field names (as in YAML).
1 parent 2581529 commit 0a30cf9

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/usage/customization-guide.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -510,11 +510,11 @@ the matchers):
510510

511511
### Fields
512512

513-
#### Name
513+
#### name
514514

515515
The `.name` field is required and used as an identifier of the rule.
516516

517-
#### Labels
517+
#### labels
518518

519519
The `.labels` is a map of the node labels to create if the rule matches.
520520

@@ -550,7 +550,7 @@ This will yield into the following node label:
550550
feature.node.kubernetes.io/custom-label: "customlabel"
551551
```
552552

553-
#### Labels template
553+
#### labelsTemplate
554554

555555
The `.labelsTemplate` field specifies a text template for dynamically creating
556556
labels based on the matched features. See [templating](#templating) for
@@ -560,9 +560,10 @@ details.
560560
> labels specified in the `labels` field will override anything
561561
> originating from `labelsTemplate`.
562562

563-
#### Node Annotations
563+
#### annotations
564564

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.
566567

567568
Take this rule as a referential example:
568569

@@ -608,7 +609,7 @@ NFD enforces some limitations to the namespace (or prefix)/ of the annotations:
608609
> annotations the features won't be advertised as node labels unless they are
609610
> specified in the `labels` field.
610611

611-
#### Taints
612+
#### taints
612613

613614
*taints* is a list of taint entries and each entry can have `key`, `value` and `effect`,
614615
where the `value` is optional. Effect could be `NoSchedule`, `PreferNoSchedule`
@@ -655,14 +656,14 @@ key:
655656
> **NOTE:** taints field is not available for the custom rules of nfd-worker
656657
> and only for NodeFeatureRule objects.
657658

658-
#### Vars
659+
#### vars
659660

660661
The `.vars` field is a map of values (key-value pairs) to store for subsequent
661662
rules to use. In other words, these are variables that are not advertised as
662663
node labels. See [backreferences](#backreferences) for more details on the
663664
usage of vars.
664665

665-
#### Extended resources
666+
#### extendedResources
666667

667668
The `.extendedResources` field is a list of extended resources to advertise.
668669
See [extended resources](#extended-resources) for more details.
@@ -725,7 +726,7 @@ Resources names:
725726
> [custom feature source](#custom-feature-source) -- it can only be used in
726727
> NodeFeatureRule objects.
727728

728-
#### Vars template
729+
#### varsTemplate
729730

730731
The `.varsTemplate` field specifies a text template for dynamically creating
731732
vars based on the matched features. See [templating](#templating) for details
@@ -736,7 +737,7 @@ the usage of vars.
736737
> vars specified in the `vars` field will override anything originating from
737738
> `varsTemplate`.
738739

739-
#### MatchFeatures
740+
#### matchFeatures
740741

741742
The `.matchFeatures` field specifies a feature matcher, consisting of a list of
742743
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
784785
MatchExpressions are evaluated against the attributes of each instance
785786
separately.
786787

787-
#### MatchAny
788+
#### matchAny
788789

789790
The `.matchAny` field is a list of of [`matchFeatures`](#matchfeatures)
790791
matchers. A logical OR is applied over the matchers, i.e. at least one of them

0 commit comments

Comments
 (0)