mirrors/node-feature-discovery
mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-15 04:57:56 +00:00
Code Activity

docs: improve documentation of the custom source

Browse source 
Better explain where the rules configuration is supposed to be
specified.
This commit is contained in:
Markus Lehtonen 2020-11-20 12:10:02 +02:00
parent 265454c405
commit 417bc6cdcf
1 changed files with 19 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/get-started/features.md
View file

@ -124,7 +124,10 @@ capability might be supported but not enabled.
The Custom feature source allows the user to define features based on a mix of The Custom feature source allows the user to define features based on a mix of
predefined rules. A rule is provided input witch affects its process of predefined rules. A rule is provided input witch affects its process of
matching for a defined feature. matching for a defined feature. The rules are specified in the
nfd-worker configuration file. See
[configuration](deployment-and-usage.md#configuration) for instructions and
examples how to set-up and manage the worker configuration.
To aid in making Custom Features clearer, we define a general and a per rule To aid in making Custom Features clearer, we define a general and a per rule
nomenclature, keeping things as consistent as possible. nomenclature, keeping things as consistent as possible.
@ -139,19 +142,24 @@ Matcher :A composition of Rules, each Matcher may be composed of at most one
#### Custom Features Format (using the Nomenclature defined above) #### Custom Features Format (using the Nomenclature defined above)
Rules are specified under `sources.custom` in the nfd-worker configuration
file.
```yaml ```yaml
- name: <feature name> sources:
matchOn: custom:
- <Rule-1>: <Rule-1 Input> - name: <feature name>
[<Rule-2>: <Rule-2 Input>] matchOn:
- <Matcher-2> - <Rule-1>: <Rule-1 Input>
[<Rule-2>: <Rule-2 Input>]
- <Matcher-2>
- ...
- ...
- <Matcher-N>
- <custom feature 2>
- ... - ...
- ... - ...
- <Matcher-N> - <custom feature M>
- <custom feature 2>
- ...
- ...
- <custom feature M>
``` ```
#### Matching process #### Matching process