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-31 04:04:51 +00:00
Code Activity

Merge pull request from marquiz/devel/readme

Browse source 
README: miscellaneous corrections
This commit is contained in:
Kubernetes Prow Robot 2019-05-17 05:30:08 -07:00 • committed by GitHub
commit c231796c36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 9 deletions

14
README.md
View file

@ -1,6 +1,6 @@
# Node feature discovery for [Kubernetes](https://kubernetes.io) # Node feature discovery for [Kubernetes](https://kubernetes.io)
[![Build Status](https://api.travis-ci.org/kubernetes-sigs/node-feature-discovery.svg?branch=master)](https://travis-ci.com/kubernetes-sigs/node-feature-discovery) [![Build Status](https://api.travis-ci.org/kubernetes-sigs/node-feature-discovery.svg?branch=master)](https://travis-ci.org/kubernetes-sigs/node-feature-discovery)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/node-feature-discovery)](https://goreportcard.com/report/github.com/kubernetes-sigs/node-feature-discovery) [![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/node-feature-discovery)](https://goreportcard.com/report/github.com/kubernetes-sigs/node-feature-discovery)
- [Overview](#overview) - [Overview](#overview)
@ -36,7 +36,7 @@ purposes. This is useful for checking features-detection.
### NFD-Master ### NFD-Master
When running as a standalone container labeling is expected to fail because When running as a standalone container labeling is expected to fail because
Kubernetes API is not available. Thus, it is recommended to use --no-publish Kubernetes API is not available. Thus, it is recommended to use `--no-publish`
command line flag. E.g. command line flag. E.g.
``` ```
$ docker run --rm --name=nfd-test <NFD_CONTAINER_IMAGE> nfd-master --no-publish $ docker run --rm --name=nfd-test <NFD_CONTAINER_IMAGE> nfd-master --no-publish
@ -76,12 +76,11 @@ nfd-master.
publish to the Kubernetes API server. [Default: ] publish to the Kubernetes API server. [Default: ]
--extra-label-ns=<list> Comma separated list of allowed extra label namespaces --extra-label-ns=<list> Comma separated list of allowed extra label namespaces
[Default: ] [Default: ]
``` ```
### NFD-Worker ### NFD-Worker
In order to run `nfd-worker` as a "stand-alone" container against your In order to run nfd-worker as a "stand-alone" container against your
standalone nfd-master you need to run them in the same network namespace: standalone nfd-master you need to run them in the same network namespace:
``` ```
$ docker run --rm --network=container:nfd-test <NFD_CONTAINER_IMAGE> nfd-worker $ docker run --rm --network=container:nfd-test <NFD_CONTAINER_IMAGE> nfd-worker
@ -136,13 +135,12 @@ nfd-worker.
--sleep-interval=<seconds> Time to sleep between re-labeling. Non-positive --sleep-interval=<seconds> Time to sleep between re-labeling. Non-positive
value implies no re-labeling (i.e. infinite value implies no re-labeling (i.e. infinite
sleep). [Default: 60s] sleep). [Default: 60s]
``` ```
**NOTE** Some feature sources need certain directories and/or files from the **NOTE** Some feature sources need certain directories and/or files from the
host mounted inside the NFD container. Thus, you need to provide Docker with the host mounted inside the NFD container. Thus, you need to provide Docker with the
correct `--volume` options in order for them to work correctly when run correct `--volume` options in order for them to work correctly when run
stand-alone directly with `docker run`. See the stand-alone directly with `docker run`. See the
[template spec](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/node-feature-discovery-daemonset.yaml.template) [template spec](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-worker-daemonset.yaml.template)
for up-to-date information about the required volume mounts. for up-to-date information about the required volume mounts.
## Feature discovery ## Feature discovery
@ -179,8 +177,6 @@ The last component (i.e. `attribute-name`) is optional, and only used if a
feature logically has sub-hierarchy, e.g. `sriov.capable` and feature logically has sub-hierarchy, e.g. `sriov.capable` and
`sriov.configure` from the `network` source. `sriov.configure` from the `network` source.
_Note: only features that are available on a given node are labeled, so
the only label value published for features is the string `"true"`._
```json ```json
{ {
@ -198,7 +194,7 @@ the only label value published for features is the string `"true"`._
The `--sources` flag controls which sources to use for discovery. The `--sources` flag controls which sources to use for discovery.
_Note: Consecutive runs of node-feature-discovery will update the labels on a _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 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, label will be removed. This includes any restrictions placed on the consecutive run,
such as restricting discovered features with the --label-whitelist option._ such as restricting discovered features with the --label-whitelist option._