1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
node-feature-discovery/README.md
David Oppenheimer d514d317c6 Added README
2016-07-25 22:44:45 -07:00

1.6 KiB

Node feature discovery for Kubernetes

Overview

This software enables node feature discovery for Kubernetes. It detects hardware features available on each node in a Kubernetes cluster, and advertises those features using node labels.

Feature sources

Feature labels

The published node labels encode a few pieces of information:

  • A "namespace" to denote the vendor/provider (e.g. node.alpha.intel.com).
  • The version of this discovery code that wrote the label, according to git describe --tags --dirty --always.
  • The source for each label (e.g. cpuid).
  • The name of the discovered feature as it appears in the underlying source, (e.g. AESNI from cpuid).

Note: only features that are available on a given node are labeled, so the only label value published for features is the string "true".

{
  "node.alpha.intel.com/dbi-iafeature-discovery.version": "v0.1.0",
  "node.alpha.intel.com/v0.1.0-cpuid-<feature-name>": "true",
  "node.alpha.intel.com/v0.1.0-rdt-<feature-name>": "true",
  "node.alpha.intel.com/v0.1.0-pstate-<feature-name>": "true"
}

License

This is open source software released under the Apache 2.0 License.