Skip to content

Commit

Permalink
docs: small update to customization guide
Browse files Browse the repository at this point in the history
Add a reference to the label rule format in the NodeFeatureRule section.
Also make it explicit in the beginning of Hooks section that hooks are
deprecated.
  • Loading branch information
marquiz committed Dec 1, 2022
1 parent fbce8d7 commit 32b2521
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/usage/customization-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ Now, on X86 platforms the feature label appears after doing `modprobe dummy` on
a system and correspondingly the label is removed after `rmmod dummy`. Note a
re-labeling delay up to the sleep-interval of nfd-worker (1 minute by default).

See [Label rule format](#label-rule-format) for detailed description of
available fields and how to write labeling rules.

### NodeFeatureRule controller

NFD-Master acts as the controller for `NodeFeatureRule` objects. It applies these
Expand Down Expand Up @@ -135,7 +138,7 @@ on the nfd-master command line.

### Hooks

The `local` source executes hooks found in
**DEPRECATED** The `local` source executes hooks found in
`/etc/kubernetes/node-feature-discovery/source.d/`. The hook files must be
executable and they are supposed to print all discovered features in `stdout`.
With ELF binaries static linking is recommended as the selection of system
Expand Down

0 comments on commit 32b2521

Please sign in to comment.