From 84fa1ed6e19a1a36f7f71bc9f221f98cd9057c5e Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Fri, 15 Dec 2023 13:31:47 +0200 Subject: [PATCH] Document the NodeFeatureRule samples and move them under deployment dir --- .../nodefeaturerule/samples}/nodefeaturerule-cpu.yaml | 0 .../samples}/nodefeaturerule-custom.yaml | 0 .../samples}/nodefeaturerule-kernel.yaml | 0 .../samples}/nodefeaturerule-local.yaml | 0 .../samples}/nodefeaturerule-memory.yaml | 0 .../samples}/nodefeaturerule-network.yaml | 0 .../nodefeaturerule/samples}/nodefeaturerule-pci.yaml | 0 .../samples}/nodefeaturerule-storage.yaml | 0 .../samples}/nodefeaturerule-system.yaml | 0 .../nodefeaturerule/samples}/nodefeaturerule-usb.yaml | 0 docs/usage/custom-resources.md | 10 ++++++++++ 11 files changed, 10 insertions(+) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-cpu.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-custom.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-kernel.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-local.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-memory.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-network.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-pci.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-storage.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-system.yaml (100%) rename {samples => deployment/nodefeaturerule/samples}/nodefeaturerule-usb.yaml (100%) diff --git a/samples/nodefeaturerule-cpu.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-cpu.yaml similarity index 100% rename from samples/nodefeaturerule-cpu.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-cpu.yaml diff --git a/samples/nodefeaturerule-custom.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-custom.yaml similarity index 100% rename from samples/nodefeaturerule-custom.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-custom.yaml diff --git a/samples/nodefeaturerule-kernel.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-kernel.yaml similarity index 100% rename from samples/nodefeaturerule-kernel.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-kernel.yaml diff --git a/samples/nodefeaturerule-local.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-local.yaml similarity index 100% rename from samples/nodefeaturerule-local.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-local.yaml diff --git a/samples/nodefeaturerule-memory.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-memory.yaml similarity index 100% rename from samples/nodefeaturerule-memory.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-memory.yaml diff --git a/samples/nodefeaturerule-network.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-network.yaml similarity index 100% rename from samples/nodefeaturerule-network.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-network.yaml diff --git a/samples/nodefeaturerule-pci.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-pci.yaml similarity index 100% rename from samples/nodefeaturerule-pci.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-pci.yaml diff --git a/samples/nodefeaturerule-storage.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-storage.yaml similarity index 100% rename from samples/nodefeaturerule-storage.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-storage.yaml diff --git a/samples/nodefeaturerule-system.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-system.yaml similarity index 100% rename from samples/nodefeaturerule-system.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-system.yaml diff --git a/samples/nodefeaturerule-usb.yaml b/deployment/nodefeaturerule/samples/nodefeaturerule-usb.yaml similarity index 100% rename from samples/nodefeaturerule-usb.yaml rename to deployment/nodefeaturerule/samples/nodefeaturerule-usb.yaml diff --git a/docs/usage/custom-resources.md b/docs/usage/custom-resources.md index b36b447b1..6c2ea0b83 100644 --- a/docs/usage/custom-resources.md +++ b/docs/usage/custom-resources.md @@ -86,6 +86,16 @@ See the [Customization guide](customization-guide.md#node-feature-rule-custom-resource) for full documentation of the NodeFeatureRule resource and its usage. +The +[`deployment/nodefeaturerule/samples/`](https://raw.githubusercontent.com/kubernetes-sigs/node-feature-discovery/{{site.release}}/deployment/nodefeaturerule/samples/) +directory contains sample NodeFeatureRule objects that replicate the built-in +default feature labels generated by NFD. The sample rules can be used as a base +to customize NFD feature labels. To use them in place of the the NFD built-in +labels, the corresponding feature source(s) of nfd-worker should be disabled +with the +(`core.labelSources`)[../reference/worker-configuration-reference.md#corelabelsources]) +configuration option. + ## NodeResourceTopology When run with NFD-Topology-Updater, NFD creates NodeResourceTopology objects