mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2024-12-14 11:57:51 +00:00
docs: update documentation on the image variants
This commit is contained in:
parent
1f8d7be6f0
commit
f4e0c589b8
2 changed files with 24 additions and 0 deletions
|
@ -23,6 +23,27 @@ sort: 3
|
|||
1. [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl)
|
||||
(properly set up and configured to work with your Kubernetes cluster)
|
||||
|
||||
## Image variants
|
||||
|
||||
NFD currently offers two variants of the container image. The "full" variant is
|
||||
currently deployed by default.
|
||||
|
||||
### Full
|
||||
|
||||
This image is based on
|
||||
[debian:buster-slim](https://hub.docker.com/_/debian) and contains a full Linux
|
||||
system for running shell-based nfd-worker hooks and doing live debugging and
|
||||
diagnosis of the NFD images.
|
||||
|
||||
### Minimal
|
||||
|
||||
This is a minimal image based on
|
||||
[gcr.io/distroless/base](https://github.com/GoogleContainerTools/distroless/blob/master/base/README.md)
|
||||
and only supports running statically linked binaries.
|
||||
|
||||
The container image tag has suffix `-minimal`
|
||||
(e.g. `{{ site.container_image }}-minimal`)
|
||||
|
||||
## Deployment options
|
||||
|
||||
### Operator
|
||||
|
|
|
@ -542,6 +542,9 @@ The *local* feature source gets its labels by two different ways:
|
|||
`/etc/kubernetes/node-feature-discovery/features.d/` directory. The file
|
||||
content is expected to be similar to the hook output (described above).
|
||||
|
||||
**NOTE:** The [minimal](deployment-and-usage#minimal) image variant only
|
||||
supports running statically linked binaries.
|
||||
|
||||
These directories must be available inside the Docker image so Volumes and
|
||||
VolumeMounts must be used if standard NFD images are used. The given template
|
||||
files mount by default the `source.d` and the `features.d` directories
|
||||
|
|
Loading…
Reference in a new issue