From fa47b0178d32c6f25353110c6659216b1738b685 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Tue, 14 May 2019 20:53:57 +0300 Subject: [PATCH] Use v0.4.0 release in README and deployment templates and script Also, slightly adjust the deployment instructions in README to point out that the templates should now be usable as is to run the latest released version of NFD. --- README.md | 17 ++++++++++------- label-nodes.sh | 12 ++++++++---- nfd-daemonset-combined.yaml.template | 4 ++-- nfd-master.yaml.template | 2 +- nfd-worker-daemonset.yaml.template | 2 +- nfd-worker-job.yaml.template | 2 +- 6 files changed, 23 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1ee29af46..0e1c1c856 100644 --- a/README.md +++ b/README.md @@ -420,7 +420,7 @@ 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)). +[latest released version](https://github.com/kubernetes-sigs/node-feature-discovery/tree/v0.4.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). @@ -437,8 +437,9 @@ If you want to use the latest development version (master branch) you need to #### 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. You only need to update the -template to use the correct image: +use the template spec provided to deploy nfd-master. If deploying a custom +image, you need to update the template to use the correct image (for the latest +released version, omit the `sed` part): ``` sed -E s',^(\s*)image:.+$,\1image: :,' nfd-master.yaml.template > nfd-master.yaml kubectl create -f nfd-master.yaml @@ -456,8 +457,9 @@ 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. Similarly to nfd-master above, you need to update the -template with the correct image: +service. Similarly to nfd-master above, if using a custom-built image you need +to update the template with the correct image (for the latest release, omit the +`sed` part): ``` sed -E s',^(\s*)image:.+$,\1image: :,' nfd-worker-daemonset.yaml.template > nfd-worker-daemonset.yaml kubectl create -f nfd-worker-daemonset.yaml @@ -473,7 +475,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 [:] ``` The label-nodes.sh script tries to launch as many jobs as there are Ready nodes. @@ -482,7 +484,8 @@ For example, if some node is tainted NoSchedule or fails to start a job for some #### nfd-master and nfd-worker in the same Pod -You can also run nfd-master and nfd-worker inside a single pod: +You can also run nfd-master and nfd-worker inside a single pod (skip the `sed` +part if running the latest released version): ``` sed -E s',^(\s*)image:.+$,\1image: :,' nfd-daemonset-combined.yaml.template > nfd-daemonset-combined.yaml kubectl apply -f nfd-daemonset-combined.yaml diff --git a/label-nodes.sh b/label-nodes.sh index aedc01f86..3c60d288d 100755 --- a/label-nodes.sh +++ b/label-nodes.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash this=`basename $0` -if [ $# -ne 1 ]; then - echo Usage: $this IMAGE[:TAG] +if [ $# -gt 1 ]; then + echo Usage: $this [IMAGE[:TAG]] exit 1 fi @@ -12,8 +12,12 @@ 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 -e "s/COMPLETION_COUNT/$NumNodes/" \ +sed -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 + +if [ -n "$1" ]; then + sed -E "s,^(\s*)image:.+$,\1image: $1," -i nfd-worker-job.yaml +fi + kubectl create -f nfd-worker-job.yaml diff --git a/nfd-daemonset-combined.yaml.template b/nfd-daemonset-combined.yaml.template index b26dbd4df..8b7e53d5a 100644 --- a/nfd-daemonset-combined.yaml.template +++ b/nfd-daemonset-combined.yaml.template @@ -57,7 +57,7 @@ spec: valueFrom: fieldRef: fieldPath: spec.nodeName - image: : + image: quay.io/kubernetes_incubator/node-feature-discovery:v0.4.0 name: nfd-master command: - "nfd-master" @@ -66,7 +66,7 @@ spec: valueFrom: fieldRef: fieldPath: spec.nodeName - image: : + image: quay.io/kubernetes_incubator/node-feature-discovery:v0.4.0 name: nfd-worker command: - "nfd-worker" diff --git a/nfd-master.yaml.template b/nfd-master.yaml.template index ab3d15f76..86d9063e2 100644 --- a/nfd-master.yaml.template +++ b/nfd-master.yaml.template @@ -60,7 +60,7 @@ spec: valueFrom: fieldRef: fieldPath: spec.nodeName - image: : + image: quay.io/kubernetes_incubator/node-feature-discovery:v0.4.0 name: nfd-master command: - "nfd-master" diff --git a/nfd-worker-daemonset.yaml.template b/nfd-worker-daemonset.yaml.template index 5e13233f2..680dc5d64 100644 --- a/nfd-worker-daemonset.yaml.template +++ b/nfd-worker-daemonset.yaml.template @@ -21,7 +21,7 @@ spec: valueFrom: fieldRef: fieldPath: spec.nodeName - image: : + image: quay.io/kubernetes_incubator/node-feature-discovery:v0.4.0 name: nfd-worker command: - "nfd-worker" diff --git a/nfd-worker-job.yaml.template b/nfd-worker-job.yaml.template index e064989a8..dacf43eb1 100644 --- a/nfd-worker-job.yaml.template +++ b/nfd-worker-job.yaml.template @@ -20,7 +20,7 @@ spec: valueFrom: fieldRef: fieldPath: spec.nodeName - image: : + image: quay.io/kubernetes_incubator/node-feature-discovery:v0.4.0 name: nfd-worker command: - "nfd-worker"