1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
node-feature-discovery/docs/usage
Markus Lehtonen 1d012a28cd Option to stop implicitly adding default prefix to names
Add new autoDefaultNs (default is "true") config option to nfd-master.
Setting the config option to false stops NFD from automatically adding
the "feature.node.kubernetes.io/" prefix to labels, annotations and
extended resources. Taints are not affected as for them no prefix is
automatically added. The user-visible part of enabling the option change
is that NodeFeatureRules, local feature files, hooks and configuration
of the "custom" may need to be altereda (if the auto-prefixing is
relied on).

For now, the config option defaults to "true", meaning no change in
default behavior. However, the intent is to change the default to
"false" in a future release, deprecating the option and eventually
removing it (forcing it to "false").

The goal of stopping doing "auto-prefixing" is to simplify the operation
(of nfd and users). Make the naming more straightforward and easier to
understand and debug (kind of WYSIWYG), eliminating peculiar corner
cases:

1. Make validation simpler and unambiguous
2. Remove "overloading" of names, i.e. the mapping two values to the
   same actual name. E.g. previously something like

      labels:
        feature.node.kubernetes.io/foo: bar
        foo: baz

   Could actually result in node label:

     feature.node.kubernetes.io/foo: baz

3. Make the processing/usagee of the "rule.matched" and "local.labels"
   feature in NodeFeatureRules unambiguous and more understadable. E.g.
   previously you could have node label
   "feature.node.kubernetes.io/local-foo: bar" but in the NodeFeatureRule
   you'd need to use the unprefixed name "local-foo" or the fully
   prefixed name, depending on what was specified in the feature file (or
   hook) on the node(s).

NOTE: setting autoDefaultNs to false is a breaking change for users who
rely on automatic prefixing with the default feature.node.kubernetes.io/
namespace. NodeFeatureRules, feature files, hooks and custom rules
(configuration of the "custom" source of nfd-worker) will need to be
altered.  Unprefixed labels, annoations and extended resources will be
denied by nfd-master.
2023-11-24 12:48:20 +02:00
..
custom-resources.md Enable NodeFeature API by default 2023-09-05 20:21:31 +02:00
customization-guide.md Option to stop implicitly adding default prefix to names 2023-11-24 12:48:20 +02:00
examples-and-demos.md Add documentation for topology garbage collector 2023-01-11 10:15:38 +01:00
features.md docs: stop advertising --resource-labels flag 2023-11-08 10:47:37 +02:00
index.md docs: restructure docs 2022-11-03 10:26:56 +02:00
nfd-gc.md docs: update to cover nfd-gc 2023-08-23 10:56:12 +03:00
nfd-master.md Deprecate gRPC API 2023-09-07 06:48:15 +02:00
nfd-topology-updater.md docs: nfd-updater: clarify accounting 2023-09-04 08:51:14 +02:00
nfd-worker.md docs: remove useless TOCs 2023-07-21 16:35:12 +03:00
using-labels.md docs: restructure docs 2022-11-03 10:26:56 +02:00