source/cpu: deprecate cpu-rdt.* labels

Document built-in RDT labels to be deprecated and removed in a future release. The plan is that the default built-in RDT labels would not be created anymore, but the RDT features would still be available for NodeFeatureRules to consume. The RDT labels are not very useful (they don't e.g indicate if the features are really enabled in kernel or if the resctrlfs is mounted).
kubernetes-sigs · Apr 4, 2023 · 6cb5e99 · 6cb5e99
1 parent 27e0788
commit 6cb5e99
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 13 deletions.
diff --git a/docs/usage/customization-guide.md b/docs/usage/customization-guide.md
@@ -602,7 +602,7 @@ The following features are available for matching:
 |                  |              | **`turbo`**  | bool   | 'true' if turbo frequencies are enabled, otherwise 'false'
 |                  |              | **`scaling`** | string | Active scaling_governor, possible values are 'powersave' or 'performance'.
 | **`cpu.rdt`**    | flag         |          |            | Intel RDT capabilities supported by the system
-|                  |              | **`<rdt-flag>`** |    | RDT capability is supported, see [RDT flags](features.md#intel-rdt-flags) for details
+|                  |              | **`<rdt-flag>`** |    | RDT capability is supported, see [RDT flags](#intel-rdt-flags) for details
 | **`cpu.security`** | attribute  |          |            | Features related to security and trusted execution environments
 |                  |              | **`sgx.enabled`** | bool | `true` if Intel SGX (Software Guard Extensions) has been enabled, otherwise does not exist
 |                  |              | **`se.enabled`** | bool  | `true` if IBM Secure Execution for Linux is available and has been enabled, otherwise does not exist
@@ -656,6 +656,17 @@ The following features are available for matching:
 | **`rule.matched`** | attribute  |          |            | Previously matched rules
 |                  |              | **`<label-or-var>`** | string | Label or var from a preceding rule that matched
 
+#### Intel RDT flags
+
+| Flag      | Description                                                      |
+| --------- | ---------------------------------------------------------------- |
+| RDTMON    | Intel RDT Monitoring Technology
+| RDTCMT    | Intel Cache Monitoring (CMT)
+| RDTMBM    | Intel Memory Bandwidth Monitoring (MBM)
+| RDTL3CA   | Intel L3 Cache Allocation Technology
+| RDTl2CA   | Intel L2 Cache Allocation Technology
+| RDTMBA    | Intel Memory Bandwidth Allocation (MBA) Technology
+
 ### Templating
 
 Rules support template-based creation of labels and vars with the

diff --git a/docs/usage/features.md b/docs/usage/features.md
@@ -54,7 +54,7 @@ option of nfd-worker.
 | **`cpu-pstate.turbo`**            | bool   | Set to 'true' if turbo frequencies are enabled in Intel pstate driver, set to 'false' if they have been disabled.
 | **`cpu-pstate.scaling_governor`** | string | The value of the Intel pstate scaling_governor when in use, either 'powersave' or 'performance'.
 | **`cpu-cstate.enabled`**          | bool   | Set to 'true' if cstates are set in the intel_idle driver, otherwise set to 'false'. Unset if intel_idle cpuidle driver is not active.
-| **`cpu-rdt.<rdt-flag>`**          | true   | [Intel RDT][intel-rdt] capability is supported. See [RDT flags](#intel-rdt-flags) for details.
+| **`cpu-rdt.<rdt-flag>`**          | true   | **DEPRECATED** [Intel RDT][intel-rdt] capability is supported. See [RDT flags](customization-guide.md#intel-rdt-flags) for details.
 | **`cpu-security.sgx.enabled`**    | true   | Set to 'true' if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes).
 | **`cpu-security.se.enabled`**     | true   | Set to 'true' if IBM Secure Execution for Linux (IBM Z & LinuxONE) is available and enabled (requires `/sys/firmware/uv/prot_virt_host` facility)
 | **`cpu-security.tdx.enabled`**    | true   | Set to 'true' if Intel TDX is available on the host and has been enabled (requires `/sys/module/kvm_intel/parameters/tdx`).
@@ -68,6 +68,12 @@ option of nfd-worker.
 | **`cpu-model.family`**            | int    | CPU family.
 | **`cpu-model.id`**                | int    | CPU model number.
 
+> NOTE: the `cpu-rdt.<rdt-flag>` labels are deprecated and will be removed in a
+> future release. They will remain to be available as features
+> for [NodeFeatureRule](custom-resources.md#nodefeaturerule) to consume.
+> See [customization guide](customization-guide.md#nodefeaturerule-custom-resource)
+> for details how to use NodeFeatureRule objects to create labels.
+
 The CPU label source is configurable, see
 [worker configuration](nfd-worker.md#worker-configuration) and
 [`sources.cpu`](../reference/worker-configuration-reference.md#sourcescpu)
@@ -154,17 +160,6 @@ See the full list in [github.com/klauspost/cpuid][klauspost-cpuid].
 | JSCVT     | Perform Conversion to Match Javascript
 | DCPOP     | Persistent Memory Support
 
-#### Intel RDT flags
-
-| Flag      | Description                                                      |
-| --------- | ---------------------------------------------------------------- |
-| RDTMON    | Intel RDT Monitoring Technology
-| RDTCMT    | Intel Cache Monitoring (CMT)
-| RDTMBM    | Intel Memory Bandwidth Monitoring (MBM)
-| RDTL3CA   | Intel L3 Cache Allocation Technology
-| RDTl2CA   | Intel L2 Cache Allocation Technology
-| RDTMBA    | Intel Memory Bandwidth Allocation (MBA) Technology
-
 ### Kernel
 
 | Feature | Value  | Description