mirrors/node-feature-discovery
mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-06 00:37:01 +00:00
Code Activity
node-feature-discovery/docs/get-started/features.md

257 lines
12 KiB
Markdown
Raw Normal View History

docs: fix mistake in md format Accidentally introduced in a57a25f63cb37c6e3aad45be52343c4b175a58f0.
2021-12-08 14:37:55 +02: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 15:58:45 +03: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 20:16:17 +03:00
layout: default
sort: 4
---
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 15:58:45 +03: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 15:31:49 +03: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 20:16:17 +03:00
docs: unify capitalization of headings
2021-03-09 13:38:09 +02: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 15:31:49 +03: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 20:16:17 +03: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 15:58:45 +03: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 20:50:46 +03: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 15:58:45 +03: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 20:50:46 +03: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 15:58:45 +03:00
Label creation in nfd-worker is performed by a set of separate modules called
label sources. The
[`core.labelSources`](../advanced/worker-configuration-reference#corelabelsources)
configuration option (or
[`-label-sources`](../advanced/worker-commandline-reference#-label-sources)
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 20:16:17 +03: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 15:58:45 +03: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 20:16:17 +03: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,
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 14:29:07 +02:00
such as restricting discovered features with the -label-whitelist option.*
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 20:16:17 +03:00
### CPU
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 15:58:45 +03: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-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 | [Intel RDT][intel-rdt] capability is supported. See [RDT flags](#intel-rdt-flags) for details.
| **`cpu-sgx.enabled`** | true | Set to 'true' if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes).
Add cpu-model feature detection (#792) * Add cpu-model feature detection Signed-off-by: Carlos Eduardo Arango Gutierrez <carangog@redhat.com> * Apply suggestions from code review Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com> Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com>
2022-03-28 05:51:23 -04:00
| **`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 15:58:45 +03:00
The CPU label source is configurable, see
[worker configuration](deployment-and-usage#worker-configuration) and
[`sources.cpu`](../advanced/worker-configuration-reference#sourcescpu)
configuration options for details.
#### X86 CPUID flags (partial list)
| 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 20:16:17 +03: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)
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 15:58:45 +03: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,
RDTSCP, SGX, SSE, SSE2, SSE3, SSE4, SSE42 and SSSE3. See
[`sources.cpu`](../advanced/worker-configuration-reference#sourcescpu)
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 19:04:31 +02: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 15:58:45 +03: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 20:16:17 +03: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 15:58:45 +03: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 20:16:17 +03: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
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 15:58:45 +03: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 20:16:17 +03: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 15:58:45 +03: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 20:16:17 +03: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
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 15:58:45 +03:00
#### Intel RDT flags
source/custom: Add nodename rule There are cases when the only available metadata for discovering features is the node's name. The "nodename" rule extends the custom source and matches when the node's name matches one of the given nodename regexp patterns. It is also possible now to set an optional "value" on custom rules, which overrides the default "true" label value in case the rule matches. In order to allow more dynamic configurations without having to modify the complete worker configuration, custom rules are additionally read from a "custom.d" directory now. Typically that directory will be filled by mounting one or more ConfigMaps. Signed-off-by: Marc Sluiter <msluiter@redhat.com>
2021-01-21 00:48:40 +01: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 15:58:45 +03:00
| 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
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 20:16:17 +03:00
source/iommu: deprecate and disable by default Deprecate the iommu source and disable it by default.
2021-11-26 11:37:47 +02:00
### IOMMU (deprecated)
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 20:16:17 +03: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 15:58:45 +03:00
| Feature | Value | Description
| ------------------- | ----- | -----------
| **`iommu.enabled`** | true | IOMMU is present and enabled in the kernel
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 20:16:17 +03:00
source/iommu: deprecate and disable by default Deprecate the iommu source and disable it by default.
2021-11-26 11:37:47 +02:00
**DEPRECATED**: The **iommu** source is deprecated and not enabled by default.
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 20:16:17 +03:00
### Kernel
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 15:58:45 +03: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 20:16:17 +03: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 15:58:45 +03:00
The kernel label source is configurable, see
[worker configuration](deployment-and-usage#worker-configuration) and
[`sources.kernel`](../advanced/worker-configuration-reference#sourceskernel)
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 20:16:17 +03:00
### Memory
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 15:58:45 +03: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 20:16:17 +03:00
### Network
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 15:58:45 +03: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 20:16:17 +03:00
### PCI
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 15:58:45 +03: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 20:16:17 +03: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 15:58:45 +03: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
[`sources.pci`](../advanced/worker-configuration-reference#sourcespci) options
and [worker configuration](deployment-and-usage#worker-configuration)
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 20:16:17 +03:00
### USB
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 15:58:45 +03: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 20:16:17 +03: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 15:58:45 +03: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
[`sources.usb`](../advanced/worker-configuration-reference#sourcesusb) options
and [worker configuration](deployment-and-usage#worker-configuration)
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 20:16:17 +03:00
### Storage
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 15:58:45 +03: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 20:16:17 +03:00
### System
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 15:58:45 +03: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 20:16:17 +03: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 15:58:45 +03: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 20:50:46 +03: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 15:58:45 +03: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 20:50:46 +03: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 15:58:45 +03: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 20:50:46 +03: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 15:58:45 +03: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 20:16:17 +03: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 15:58:45 +03:00
NFD has many extension points for creating vendor and application specific
labels. See the [customization guide](../advanced/customization-guide.md) for
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 20:16:17 +03: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 14:29:07 +02: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 20:16:17 +03: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 14:29:07 +02: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 20:16:17 +03: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 14:29:07 +02: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 20:16:17 +03: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 20:50:46 +03:00
docs: fix mdlint issues
2021-02-25 13:49:02 +02: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 20:16:17 +03: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 19:04:31 +02: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 20:16:17 +03: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