Merge pull request #243 from marquiz/devel/readme

Better document the difference between latest release and master branch

README.md

@@ -405,6 +405,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)
@@ -417,9 +424,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.
@@ -434,9 +443,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.
@@ -449,7 +460,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.
@@ -460,7 +471,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

label-nodes.sh

@@ -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

nfd-daemonset-combined.yaml.template

@@ -57,7 +57,7 @@ spec:
             valueFrom:
               fieldRef:
                 fieldPath: spec.nodeName
-          image: quay.io/kubernetes_incubator/node-feature-discovery:v0.3.0
+          image: <IMAGE_REPO>:<IMAGE_TAG>
           name: nfd-master
           command:
             - "nfd-master"
@@ -66,7 +66,7 @@ spec:
             valueFrom:
               fieldRef:
                 fieldPath: spec.nodeName
-          image: quay.io/kubernetes_incubator/node-feature-discovery:v0.3.0
+          image: <IMAGE_REPO>:<IMAGE_TAG>
           name: nfd-worker
           command:
             - "nfd-worker"

nfd-master.yaml.template

@@ -60,7 +60,7 @@ spec:
             valueFrom:
               fieldRef:
                 fieldPath: spec.nodeName
-          image: quay.io/kubernetes_incubator/node-feature-discovery:v0.3.0
+          image: <IMAGE_REPO>:<IMAGE_TAG>
           name: nfd-master
           command:
             - "nfd-master"

nfd-worker-daemonset.yaml.template

@@ -21,7 +21,7 @@ spec:
             valueFrom:
               fieldRef:
                 fieldPath: spec.nodeName
-          image: quay.io/kubernetes_incubator/node-feature-discovery:v0.3.0
+          image: <IMAGE_REPO>:<IMAGE_TAG>
           name: nfd-worker
           command:
             - "nfd-worker"

nfd-worker-job.yaml.template

@@ -20,7 +20,7 @@ spec:
             valueFrom:
               fieldRef:
                 fieldPath: spec.nodeName
-          image: quay.io/kubernetes_incubator/node-feature-discovery:v0.3.0
+          image: <IMAGE_REPO>:<IMAGE_TAG>
           name: nfd-worker
           command:
             - "nfd-worker"