mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
Code Activity
node-feature-discovery/docs/usage/features.md

292 lines
18 KiB
Markdown
Raw Normal View History

docs: fix mistake in md format Accidentally introduced in a57a25f63cb37c6e3aad45be52343c4b175a58f0.
2021-12-08 12:37:55 +00:00
---
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
title: "Feature labels"
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
layout: default
docs: restructure docs Introduce two main sections "Deployment" and "Usage" and move "Developer guide" to the top level, too. In particular, split the huge deployment-and-usage file into multiple parts under the new main sections. Move customization guide from "Advanced" to "Usage". This patch also renames "Advanced" to "Reference" as only that is left there is reference documentation.
2022-11-02 12:34:37 +00:00
sort: 1
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
---
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
# Feature labels
docs: fix TOCs Make table of contents in the pages cleaner and more readable by dropping the main heading (H1 level) from TOCs. This was the original intention with the usage of "no_toc" kramdown magic, which was broken, however. The kramdown class magic needs to be specified on the line immediately following the headinds, otherwise it has no effect. We need to disable MD022 rule of mdlint as it does not understand this magic.
2021-09-27 12:31:49 +00:00
{: .no_toc}
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: unify capitalization of headings
2021-03-09 11:38:09 +00:00
## Table of contents
docs: fix TOCs Make table of contents in the pages cleaner and more readable by dropping the main heading (H1 level) from TOCs. This was the original intention with the usage of "no_toc" kramdown magic, which was broken, however. The kramdown class magic needs to be specified on the line immediately following the headinds, otherwise it has no effect. We need to disable MD022 rule of mdlint as it does not understand this magic.
2021-09-27 12:31:49 +00:00
{: .no_toc .text-delta}
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
1. TOC
{:toc}
---
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
Features are advertised as labels in the Kubernetes Node object.
docs: markdown style fixes Fix markdown syntax and style for content that was moved from README.md to docs/: - get-started/introduction - examples-and-demos - get-started/features - contributing Unify the spelling of master and worker in headings and beginning of senctences. Also, env variable for container name in developers-guide.
2020-10-20 17:50:46 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
## Built-in labels
docs: markdown style fixes Fix markdown syntax and style for content that was moved from README.md to docs/: - get-started/introduction - examples-and-demos - get-started/features - contributing Unify the spelling of master and worker in headings and beginning of senctences. Also, env variable for container name in developers-guide.
2020-10-20 17:50:46 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
Label creation in nfd-worker is performed by a set of separate modules called
label sources. The
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[`core.labelSources`](../reference/worker-configuration-reference.md#corelabelsources)
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
configuration option (or
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[`-label-sources`](../reference/worker-commandline-reference.md#-label-sources)
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
flag) of nfd-worker controls which sources to enable for label generation.
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
All built-in labels use the `feature.node.kubernetes.io` label namespace and
have the following format.
```plaintext
feature.node.kubernetes.io/<feature> = <value>
```
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: unify formatting of NOTEs
2023-08-03 10:38:07 +00:00
> **NOTE:** Consecutive runs of nfd-worker will update the labels on a given
> node. If features are not discovered on a consecutive run, the corresponding
> label will be removed. This includes any restrictions placed on the
> consecutive run, such as restricting discovered features with the
> [`-label-whitelist`](../reference/master-commandline-reference.md#-label-whitelist)
> flag of nfd-master or
> [`core.labelWhiteList`](../reference/worker-configuration-reference.md#corelabelwhitelist)
> option of nfd-worker.
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### CPU
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature name | Value | Description |
| ----------------------------------- | ------ | --------------------------------------------------------------------------- |
| **`cpu-cpuid.<cpuid-flag>`** | true | CPU capability is supported. **NOTE:** the capability might be supported but not enabled. |
| **`cpu-hardware_multithreading`** | true | Hardware multithreading, such as Intel HTT, enabled (number of logical CPUs is greater than physical CPUs) |
| **`cpu-coprocessor.nx_gzip`** | true | Nest Accelerator for GZIP is supported(Power). |
| **`cpu-power.sst_bf.enabled`** | true | Intel SST-BF ([Intel Speed Select Technology][intel-sst] - Base frequency) enabled |
| **`cpu-pstate.status`** | string | The status of the [Intel pstate][intel-pstate] driver when in use and enabled, either 'active' or 'passive'. |
| **`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 | **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 on 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`). |
| **`cpu-security.tdx.protected`** | true | Set to 'true' if Intel TDX was used to start the guest node, based on the existence of the "TDX_GUEST" information as part of cpuid features. |
| **`cpu-security.sev.enabled`** | true | Set to 'true' if ADM SEV is available on the host and has been enabled (requires `/sys/module/kvm_amd/parameters/sev`). |
| **`cpu-security.sev.es.enabled`** | true | Set to 'true' if ADM SEV-ES is available on the host and has been enabled (requires `/sys/module/kvm_amd/parameters/sev_es`). |
| **`cpu-security.sev.snp.enabled`** | true | Set to 'true' if ADM SEV-SNP is available on the host and has been enabled (requires `/sys/module/kvm_amd/parameters/sev_snp`). |
| **`cpu-security.sex.asids`** | int | The total amount of AMD SEV address-space identifiers (ASIDs), based on the `/sys/fs/cgroup/misc.capacity` information. |
| **`cpu-security.sex.encrypted_state_ids`** | int | The total amount of AMD SEV-ES and SEV-SNP supported, based on the `/sys/fs/cgroup/misc.capacity` information. |
| **`cpu-model.vendor_id`** | string | Comparable CPU vendor ID. |
| **`cpu-model.family`** | int | CPU family. |
| **`cpu-model.id`** | int | CPU model number. |
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
docs: unify formatting of NOTEs
2023-08-03 10:38:07 +00:00
> **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
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).
2023-04-04 08:47:38 +00:00
> 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.
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
The CPU label source is configurable, see
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[worker configuration](nfd-worker.md#worker-configuration) and
[`sources.cpu`](../reference/worker-configuration-reference.md#sourcescpu)
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
configuration options for details.
#### X86 CPUID flags (partial list)
docs: update x86 cpuid feature list Update the partial list of x86 cpuid features that are presented in the NFD documentation. In particular, the following instructions were left out of the list: AVXSLOW, CETIBT, CETSS, CLDEMOTE, HLE, MPX, RTM, RTM_ALWAYS_ABORT, SERIALIZE, SHA, TSXLDTRK.
2022-06-07 08:56:12 +00:00
| Flag | Description |
| ------------------ | ------------------------------------------------------- |
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| ADX | Multi-Precision Add-Carry Instruction Extensions (ADX) |
| AESNI | Advanced Encryption Standard (AES) New Instructions (AES-NI) |
| AVX | Advanced Vector Extensions (AVX) |
| AVX2 | Advanced Vector Extensions 2 (AVX2) |
| AVXVNNI | AVX (VEX encoded) VNNI neural network instructions |
| AMXBF16 | Advanced Matrix Extension, tile multiplication operations on BFLOAT16 numbers |
| AMXINT8 | Advanced Matrix Extension, tile multiplication operations on 8-bit integers |
| AMXFP16 | Advanced Matrix Extension, tile multiplication operations on FP16 numbers |
| AMXTILE | Advanced Matrix Extension, base tile architecture support |
| AVX512BF16 | AVX-512 BFLOAT16 instructions |
| AVX512BITALG | AVX-512 bit Algorithms |
| AVX512BW | AVX-512 byte and word Instructions |
| AVX512CD | AVX-512 conflict detection instructions |
| AVX512DQ | AVX-512 doubleword and quadword instructions |
| AVX512ER | AVX-512 exponential and reciprocal instructions |
| AVX512F | AVX-512 foundation |
| AVX512FP16 | AVX-512 FP16 instructions |
| AVX512IFMA | AVX-512 integer fused multiply-add instructions |
| AVX512PF | AVX-512 prefetch instructions |
| AVX512VBMI | AVX-512 vector bit manipulation instructions |
| AVX512VBMI2 | AVX-512 vector bit manipulation instructions, version 2 |
| AVX512VL | AVX-512 vector length extensions |
| AVX512VNNI | AVX-512 vector neural network instructions |
| AVX512VP2INTERSECT | AVX-512 intersect for D/Q |
| AVX512VPOPCNTDQ | AVX-512 vector population count doubleword and quadword |
| AVXIFMA | AVX-IFMA instructions |
| AVXNECONVERT | AVX-NE-CONVERT instructions |
| AVXVNNIINT8 | AVX-VNNI-INT8 instructions |
| CMPCCXADD | CMPCCXADD instructions |
| ENQCMD | Enqueue Command |
| GFNI | Galois Field New Instructions |
| HYPERVISOR | Running under hypervisor |
| MSRLIST | Read/Write List of Model Specific Registers |
| PREFETCHI | PREFETCHIT0/1 instructions |
| VAES | AVX-512 vector AES instructions |
| VPCLMULQDQ | Carry-less multiplication quadword |
| WRMSRNS | Non-Serializing Write to Model Specific Register |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
By default, the following CPUID flags have been blacklisted: BMI1, BMI2, CLMUL,
CMOV, CX16, ERMS, F16C, HTT, LZCNT, MMX, MMXEXT, NX, POPCNT, RDRAND, RDSEED,
cpu: Discover TDX guests based on cpuid information NFD already has the capability to discover whether baremetal / host machines support Intel TDX. Now, the next step is to add support for discovering whether a node is TDX protected (as in, a virtual machine started using Intel TDX). In order to do so, we've decided to go for a new `cpu-security.tdx` property, called `protected` (`cpu-security.tdx.protected`). Signed-off-by: Hairong Chen <hairong.chen@intel.com> Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-06-02 09:01:10 +00:00
RDTSCP, SGX, SSE, SSE2, SSE3, SSE4, SSE42, SSSE3 and TDX_GUEST. See
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[`sources.cpu`](../reference/worker-configuration-reference.md#sourcescpu)
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
configuration options to change the behavior.
go.mod: update klauspost/cpuid The latest changes in klauspost/cpuid add detection for Sapphire Rapids new instructions. Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-11-30 17:04:31 +00:00
See the full list in [github.com/klauspost/cpuid][klauspost-cpuid].
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
#### Arm CPUID flags (partial list)
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
| Flag | Description |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
| --------- | ---------------------------------------------------------------- |
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| IDIVA | Integer divide instructions available in ARM mode |
| IDIVT | Integer divide instructions available in Thumb mode |
| THUMB | Thumb instructions |
| FASTMUL | Fast multiplication |
| VFP | Vector floating point instruction extension (VFP) |
| VFPv3 | Vector floating point extension v3 |
| VFPv4 | Vector floating point extension v4 |
| VFPD32 | VFP with 32 D-registers |
| HALF | Half-word loads and stores |
| EDSP | DSP extensions |
| NEON | NEON SIMD instructions |
| LPAE | Large Physical Address Extensions |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
#### Arm64 CPUID flags (partial list)
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
| Flag | Description |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
| --------- | ---------------------------------------------------------------- |
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| AES | Announcing the Advanced Encryption Standard |
| EVSTRM | Event Stream Frequency Features |
| FPHP | Half Precision(16bit) Floating Point Data Processing Instructions |
| ASIMDHP | Half Precision(16bit) Asimd Data Processing Instructions |
| ATOMICS | Atomic Instructions to the A64 |
| ASIMRDM | Support for Rounding Double Multiply Add/Subtract |
| PMULL | Optional Cryptographic and CRC32 Instructions |
| JSCVT | Perform Conversion to Match Javascript |
| DCPOP | Persistent Memory Support |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### Kernel
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| ----------------------------| ------ | --------------------------------------------------------- |
| **`kernel-config.<option>`** | true | Kernel config option is enabled (set 'y' or 'm'). Default options are `NO_HZ`, `NO_HZ_IDLE`, `NO_HZ_FULL` and `PREEMPT` |
| **`kernel-selinux.enabled`** | true | Selinux is enabled on the node |
| **`kernel-version.full`** | string | Full kernel version as reported by `/proc/sys/kernel/osrelease` (e.g. '4.5.6-7-g123abcde') |
| **`kernel-version.major`** | string | First component of the kernel version (e.g. '4') |
| **`kernel-version.minor`** | string | Second component of the kernel version (e.g. '5') |
| **`kernel-version.revision`**| string | Third component of the kernel version (e.g. '6') |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
The kernel label source is configurable, see
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[worker configuration](nfd-worker.md#worker-configuration) and
[`sources.kernel`](../reference/worker-configuration-reference.md#sourceskernel)
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
configuration options for details.
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### Memory
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| --------------------| ----- | --------------------------------------------------------- |
| **`memory-numa`** | true | Multiple memory nodes i.e. NUMA architecture detected |
| **`memory-nv.present`** | true | NVDIMM device(s) are present |
| **`memory-nv.dax`** | true | NVDIMM region(s) configured in DAX mode are present |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### Network
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| ------------------------------| ----- | --------------------------------------------------------------- |
| **`network-sriov.capable`** | true | [Single Root Input/Output Virtualization][sriov] (SR-IOV) enabled Network Interface Card(s) present |
| **`network-sriov.configured`**| true | SR-IOV virtual functions have been configured |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### PCI
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| --------------------------------------- | ----- | ---------------------------------------------------------------- |
| **`pci-<device label>.present`** | true | PCI device is detected |
| **`pci-<device label>.sriov.capable`** | true | [Single Root Input/Output Virtualization][sriov] (SR-IOV) enabled PCI device present |
| | | |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
`<device label>` is format is configurable and set to `<class>_<vendor>` by
default. For more more details about configuration of the pci labels, see
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[`sources.pci`](../reference/worker-configuration-reference.md#sourcespci) options
and [worker configuration](nfd-worker.md#worker-configuration)
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
instructions.
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### USB
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| ----------- | ----- | --------------------------------------------------------- |
| **`usb-<device label>.present`** | true | USB device is detected |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
`<device label>` is format is configurable and set to
`<class>_<vendor>_<device>` by default. For more more details about
configuration of the usb labels, see
docs: fix internal cross-page references by injecting .md
2023-01-12 01:23:36 +00:00
[`sources.usb`](../reference/worker-configuration-reference.md#sourcesusb) options
and [worker configuration](nfd-worker.md#worker-configuration)
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
instructions.
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### Storage
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| --------------------------------| ----- | ----------------------------------------------------------- |
| **`storage-nonrotationaldisk`** | true | Non-rotational disk, like SSD, is present in the node |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
### System
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| --------------------------------------- | ------ | ----------------------------------------------------------- |
| **`system-os_release.ID`** | string | Operating system identifier |
| **`system-os_release.VERSION_ID`** | string | Operating system version identifier (e.g. '6.7') |
| **`system-os_release.VERSION_ID.major`**| string | First component of the OS version id (e.g. '6') |
| **`system-os_release.VERSION_ID.minor`**| string | Second component of the OS version id (e.g. '7') |
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
### Custom
docs: markdown style fixes Fix markdown syntax and style for content that was moved from README.md to docs/: - get-started/introduction - examples-and-demos - get-started/features - contributing Unify the spelling of master and worker in headings and beginning of senctences. Also, env variable for container name in developers-guide.
2020-10-20 17:50:46 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
The custom label source is designed for creating
[user defined labels](#user-defined-labels). However, it has a few statically
defined built-in labels:
docs: markdown style fixes Fix markdown syntax and style for content that was moved from README.md to docs/: - get-started/introduction - examples-and-demos - get-started/features - contributing Unify the spelling of master and worker in headings and beginning of senctences. Also, env variable for container name in developers-guide.
2020-10-20 17:50:46 +00:00
Make mdlint v0.13 happy Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
2023-10-25 19:12:47 +00:00
| Feature | Value | Description |
| ---------------------------- | ----- | ----------------------------------------------------------- |
| **`custom-rdma.capable`** | true | The node has an RDMA capable Network adapter |
| **`custom-rdma.enabled`** | true | The node has the needed RDMA modules loaded to run RDMA traffic |
| | | |
docs: markdown style fixes Fix markdown syntax and style for content that was moved from README.md to docs/: - get-started/introduction - examples-and-demos - get-started/features - contributing Unify the spelling of master and worker in headings and beginning of senctences. Also, env variable for container name in developers-guide.
2020-10-20 17:50:46 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
## User defined labels
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
NFD has many extension points for creating vendor and application specific
docs: add missing .md suffix to internal references Commit bfbc47f55e460ec80bfb8f57125ee3a0d2967486 added a lot of those and this patch tries to cover all that we missed there. Having .md suffixes in references to internal files makes it convenient to browse the document locally, just as text files as the references work correctly.
2023-04-25 12:28:07 +00:00
labels. See the [customization guide](customization-guide.md) for
docs: add customization guide Add a separate customization guide. Move documentation of the custom and local sources there. Also, cover the new NodeFeatureRules custom resource and the new expression-based label rule format. This patch also simplifies the "Feature labels" page, describing built-in labels. Reformat the tables describing feature labels.
2021-09-23 12:58:45 +00:00
detailed documentation.
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
## Extended resources
This feature is experimental and by no means a replacement for the usage of
device plugins.
Labels which have integer values, can be promoted to Kubernetes extended
docs: align docs with the single-dash command line flags After moving to the flags package for command line argument parsing NFD accepts command line arguments (flags) starting with a single dash (e.g. -no-publish in addition to --no-publish). Even if double-dash can be used the single-dash version is printed e.g. in the usage string (from -h, -help) so align documentation with that.
2021-02-24 12:29:07 +00:00
resources by listing them to the master `-resource-labels` command line flag.
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
These labels won't then show in the node label section, they will appear only
as extended resources.
An example use-case for the extended resources could be based on a hook which
creates a label for the node SGX EPC memory section size. By giving the name of
docs: align docs with the single-dash command line flags After moving to the flags package for command line argument parsing NFD accepts command line arguments (flags) starting with a single dash (e.g. -no-publish in addition to --no-publish). Even if double-dash can be used the single-dash version is printed e.g. in the usage string (from -h, -help) so align documentation with that.
2021-02-24 12:29:07 +00:00
that label in the `-resource-labels` flag, that value will then turn into an
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
extended resource of the node, allowing PODs to request that resource and the
Kubernetes scheduler to schedule such PODs to only those nodes which have a
sufficient capacity of said resource left.
Similar to labels, the default namespace `feature.node.kubernetes.io` is
automatically prefixed to the extended resource, if the promoted label doesn't
have a namespace.
Example usage of the command line arguments, using a new namespace:
docs: align docs with the single-dash command line flags After moving to the flags package for command line argument parsing NFD accepts command line arguments (flags) starting with a single dash (e.g. -no-publish in addition to --no-publish). Even if double-dash can be used the single-dash version is printed e.g. in the usage string (from -h, -help) so align documentation with that.
2021-02-24 12:29:07 +00:00
`nfd-master -resource-labels=my_source-my.feature,sgx.some.ns/epc -extra-label-ns=sgx.some.ns`
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
The above would result in following extended resources provided that related
labels exist:
docs: markdown style fixes Fix markdown syntax and style for content that was moved from README.md to docs/: - get-started/introduction - examples-and-demos - get-started/features - contributing Unify the spelling of master and worker in headings and beginning of senctences. Also, env variable for container name in developers-guide.
2020-10-20 17:50:46 +00:00
docs: fix mdlint issues
2021-02-25 11:49:02 +00:00
```plaintext
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
sgx.some.ns/epc: <label value>
feature.node.kubernetes.io/my_source-my.feature: <label value>
```
<!-- Links -->
go.mod: update klauspost/cpuid The latest changes in klauspost/cpuid add detection for Sapphire Rapids new instructions. Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2020-11-30 17:04:31 +00:00
[klauspost-cpuid]: https://github.com/klauspost/cpuid#x86-cpu-instructions
README: move content over to docs/ Move all content from README.md to the Jekyll site under docs/. Also re-organize it into multiple sub-pages. Populate README with fresh content turning it into virtually a big link to the html-based documentation site. Spiced up with super-quick-start instructions.
2020-09-08 17:16:17 +00:00
[intel-rdt]: http://www.intel.com/content/www/us/en/architecture-and-technology/resource-director-technology.html
[intel-pstate]: https://www.kernel.org/doc/Documentation/cpu-freq/intel-pstate.txt
[intel-sst]: https://www.intel.com/content/www/us/en/architecture-and-technology/speed-select-technology-article.html
[sriov]: http://www.intel.com/content/www/us/en/pci-express/pci-sig-sr-iov-primer-sr-iov-technology-paper.html
Copy permalink