From c847bb6d747947de7286c65b8b547bbe58c86b81 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Thu, 18 Mar 2021 15:32:15 +0200 Subject: [PATCH 1/4] github: update gh-pages on published releases This will make the Helm repo to be updated at release time. (cherry picked from commit aa9050eca32cd65fe0baa1fef503d6e83396d5e3) --- .github/ISSUE_TEMPLATE/new-release.md | 5 +++++ .github/workflows/gh-pages.yml | 2 ++ 2 files changed, 7 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/new-release.md b/.github/ISSUE_TEMPLATE/new-release.md index 1b09d00e5..568d8a2d7 100644 --- a/.github/ISSUE_TEMPLATE/new-release.md +++ b/.github/ISSUE_TEMPLATE/new-release.md @@ -35,9 +35,14 @@ Please do not remove items from the checklist - [ ] Submit a PR against [k8s.io](https://github.com/kubernetes/k8s.io), updating `k8s.gcr.io/images/k8s-staging-nfd/images.yaml` to promote the container image to production - [ ] Wait for the PR to be merged and verify that the image (`k8s.gcr.io/nfd/node-feature-discovery:$VERSION`) is available. - [ ] Publish the draft release prepared at the [Github releases page](https://github.com/kubernetes-sigs/node-feature-discovery/releases) + which will also trigger a Helm repo index update to add the latest release - [ ] Add a link to the tagged release in this issue. - [ ] Send an announcement email to `kubernetes-dev@googlegroups.com` with the subject `[ANNOUNCE] node-feature-discovery $VERSION is released` - [ ] Add a link to the release announcement in this issue +- [ ] For a major release, update README in master branch + - [ ] Update references e.g. by running `scripts/prepare-release.sh $VERSION` but **only** committing README.md, and, + submit a PR + - [ ] Wait for the PR to be merged - [ ] Close this issue diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 31e77f05c..ebca0b5a6 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -6,6 +6,8 @@ on: - release-* tags: - v[0-9]+.[0-9]+.[0-9]+ + release: + types: [published] jobs: build: name: Update gh-pages From b419fe576915c43bab8f5c1fac9732ffd37c474a Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Tue, 16 Mar 2021 08:00:45 +0200 Subject: [PATCH 2/4] docs: describe Helm repo as the primary option for Helm (cherry picked from commit 11def7b459272eeb0f77219922b1d7f19bc294e4) --- docs/get-started/deployment-and-usage.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/get-started/deployment-and-usage.md b/docs/get-started/deployment-and-usage.md index ad091a2ec..dc3f857f8 100644 --- a/docs/get-started/deployment-and-usage.md +++ b/docs/get-started/deployment-and-usage.md @@ -143,7 +143,17 @@ Node Feature Discovery Helm chart allow to easily deploy and manage NFD. #### Deployment -To install the chart with the release name node-feature-discovery: +To install the latest stable version: + +```bash +export NFD_NS=node-feature-discovery +helm repo add nfd http://kubernetes-sigs.github.io/node-feature-discovery/charts +helm repo update +helm install nfd/node-feature-discovery --namespace $NFD_NS --create-namespace --generate-name +``` + +To install the latest development version you need to clone the NFD Git +repository and install from there. ```bash git clone https://github.com/kubernetes-sigs/node-feature-discovery/ @@ -152,9 +162,8 @@ export NFD_NS=node-feature-discovery helm install node-feature-discovery ./node-feature-discovery/ --namespace $NFD_NS --create-namespace ``` -The command deploys Node Feature Discovery on the Kubernetes cluster in the -default configuration. The Configuration section describes how it can be -configured during installation. +See the [configuration](#configuration) section below for instructions how to +alter the deployment parameters. In order to deploy the [minimal](#minimal) image you need to override the image tag: @@ -169,14 +178,14 @@ You can override values from `values.yaml` and provide a file with custom values ```bash export NFD_NS=node-feature-discovery -helm install node-feature-discovery ./node-feature-discovery/ -f --namespace $NFD_NS --create-namespace +helm install nfd/node-feature-discovery -f --namespace $NFD_NS --create-namespace ``` To specify each parameter separately you can provide them to helm install command: ```bash export NFD_NS=node-feature-discovery -helm install node-feature-discovery ./node-feature-discovery/ --set nameOverride=NFDinstance --set master.replicaCount=2 --namespace $NFD_NS --create-namespace +helm install nfd/node-feature-discovery --set nameOverride=NFDinstance --set master.replicaCount=2 --namespace $NFD_NS --create-namespace ``` #### Uninstalling the chart From ecea38b71a423c2e735e3b824aaf8912135f4271 Mon Sep 17 00:00:00 2001 From: Adrian Chiris Date: Thu, 18 Mar 2021 15:31:41 +0000 Subject: [PATCH 3/4] Docs: Add Table header to master/worker chart parameters While on the project website it looks OK, it does not render correctly in Markdown. Signed-off-by: Adrian Chiris (cherry picked from commit 30dabcf7bf241740fa0255cd9bddb6c016c2f4d4) --- docs/get-started/deployment-and-usage.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/get-started/deployment-and-usage.md b/docs/get-started/deployment-and-usage.md index dc3f857f8..01de2e5f8 100644 --- a/docs/get-started/deployment-and-usage.md +++ b/docs/get-started/deployment-and-usage.md @@ -222,6 +222,8 @@ We have introduced the following Chart parameters. ##### Master pod parameters +| Name | Type | Default | description | +| ---- | ---- | ------- | ----------- | | `master.*` | dict | | NFD master deployment configuration | | `master.instance` | string | | Instance name. Used to separate annotation namespaces for multiple parallel deployments | | `master.replicaCount` | integer | 1 | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified | @@ -236,6 +238,8 @@ We have introduced the following Chart parameters. ##### Worker pod parameters +| Name | Type | Default | description | +| ---- | ---- | ------- | ----------- | | `worker.*` | dict | | NFD master daemonset configuration | | `worker.configmapName` | string | `nfd-worker-conf` | NFD worker pod ConfigMap name | | `worker.config` | string | `` | NFD worker service configuration | From 57bbe54230f0ea46bc09d0fc16f58d8016caa478 Mon Sep 17 00:00:00 2001 From: Moshe Levi Date: Fri, 19 Mar 2021 00:41:45 +0200 Subject: [PATCH 4/4] [helm] fix nfd worker tolerations value the tolerations value is array therefore we need to pass [] and not {} Signed-off-by: Moshe Levi (cherry picked from commit 57575231ab9fd7dba205e048f0b1a86d22444c30) --- deployment/node-feature-discovery/values.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deployment/node-feature-discovery/values.yaml b/deployment/node-feature-discovery/values.yaml index 60a0923a3..55461280f 100644 --- a/deployment/node-feature-discovery/values.yaml +++ b/deployment/node-feature-discovery/values.yaml @@ -208,7 +208,7 @@ worker: nodeSelector: {} - tolerations: {} + tolerations: [] annotations: {}