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

Better document the difference between latest release and master branch

Browse source 
Point to the latest release in the README, and, point out that a
user-built custom image is required to run the latest development
version. Update the deployment instructions to reflect the need to
specify the container image when using the deployment spec template(s).
Also, update the Job deployment script to set a user-defined container
image.
This commit is contained in:
Markus Lehtonen 2019-05-08 14:31:55 +03:00
parent c9c9a3f0f0
commit a0fb0c6561
2 changed files with 29 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -421,6 +421,13 @@ directory. It is the user's responsibility to review the hooks for e.g.
possible security implications.
## Getting started
For a stable version with ready-built images see the
[latest released version](https://github.com/kubernetes-sigs/node-feature-discovery/tree/v0.3.0) ([release notes](https://github.com/kubernetes-sigs/node-feature-discovery/releases/latest)).
If you want to use the latest development version (master branch) you need to
[build your own custom image](#building-from-source).
### System requirements
1. Linux (x86_64/Arm64)
@ -433,9 +440,11 @@ possible security implications.
#### nfd-master
Nfd-master runs as a DaemonSet, by default in the master node(s) only. You can
use the template spec provided to deploy nfd-master:
use the template spec provided to deploy nfd-master. You only need to update the
template to use the correct image:
```
kubectl create -f nfd-master.yaml.template
sed -E s'/^(\s*)image:.+$/\1image: <YOUR_IMAGE_REPO>:<YOUR_IMAGE_TAG>/' nfd-master.yaml.template > nfd-master.yaml
kubectl create -f nfd-master.yaml
```
Nfd-master listens for connections from nfd-worker(s) and connects to the
Kubernetes API server to adds node labels advertised by them.
@ -450,9 +459,11 @@ labels. The provided template will configure these for you.
Nfd-worker is preferably run as a Kubernetes DaemonSet. There is an
example spec that can be used as a template, or, as is when just trying out the
service:
service. Similarly to nfd-master above, you need to update the
template with the correct image:
```
kubectl create -f nfd-worker-daemonset.yaml.template
sed -E s'/^(\s*)image:.+$/\1image: <YOUR_IMAGE_REPO>:<YOUR_IMAGE_TAG>/' nfd-worker-daemonset.yaml.template > nfd-worker-daemonset.yaml
kubectl create -f nfd-worker-daemonset.yaml
```
Nfd-worker connects to the nfd-master service to advertise hardware features.
@ -465,7 +476,7 @@ Feature discovery can alternatively be configured as a one-shot job. There is
an example script in this repo that demonstrates how to deploy the job in the cluster.
```
./label-nodes.sh
./label-nodes.sh <YOUR_IMAGE_REPO>:<YOUR_IMAGE_TAG>
```
The label-nodes.sh script tries to launch as many jobs as there are Ready nodes.
@ -476,7 +487,8 @@ For example, if some node is tainted NoSchedule or fails to start a job for some
You can also run nfd-master and nfd-worker inside a single pod:
```
kubectl apply -f nfd-daemonset-combined.yaml.template
sed -E s'/^(\s*)image:.+$/\1image: <YOUR_IMAGE_REPO>:<YOUR_IMAGE_TAG>/' nfd-daemonset-combined.yaml.template > nfd-daemonset-combined.yaml
kubectl apply -f nfd-daemonset-combined.yaml
```
Similar to the nfd-worker setup above, this creates a DaemonSet that schedules
an NFD Pod an all worker nodes, with the difference that the Pod also also

13
label-nodes.sh
View file

@ -1,4 +1,10 @@
#!/usr/bin/env bash
this=`basename $0`
if [ $# -ne 1 ]; then
echo Usage: $this IMAGE[:TAG]
exit 1
fi
# Get the number of nodes in Ready state in the Kubernetes cluster
NumNodes=$(kubectl get nodes | grep -i ' ready ' | wc -l)
@ -6,5 +12,8 @@ NumNodes=$(kubectl get nodes | grep -i ' ready ' | wc -l)
# We request a specific hostPort in the job spec to limit the number of pods
# that run on a node to one. As a result, one pod runs on each node in parallel
# We set the NODE_NAME environemnt variable to get the Kubernetes node object.
sed -e "s/COMPLETION_COUNT/$NumNodes/" -e "s/PARALLELISM_COUNT/$NumNodes/" nfd-worker-job.yaml.template > node-feature-discovery-job.yaml
kubectl create -f node-feature-discovery-job.yaml
sed -E -e "s/COMPLETION_COUNT/$NumNodes/" \
-e "s/PARALLELISM_COUNT/$NumNodes/" \
-e "s/^(\s*)image:.+$/\1image: $1/" \
nfd-worker-job.yaml.template > nfd-worker-job.yaml
kubectl create -f nfd-worker-job.yaml