From 5fe3f7163f98aaac4ffa3b6abbc466b72a807348 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Wed, 11 Aug 2021 11:25:30 +0300 Subject: [PATCH] helm: add readme Add minimal readme to the helm chart and update scripts/prepare-release.sh to handle references in the readme file. --- deployment/node-feature-discovery/README.md | 10 ++++++++++ scripts/prepare-release.sh | 3 +++ 2 files changed, 13 insertions(+) create mode 100644 deployment/node-feature-discovery/README.md diff --git a/deployment/node-feature-discovery/README.md b/deployment/node-feature-discovery/README.md new file mode 100644 index 000000000..956788531 --- /dev/null +++ b/deployment/node-feature-discovery/README.md @@ -0,0 +1,10 @@ +# Node Feature Discovery + +Node Feature Discovery (NFD) is a Kubernetes add-on for detecting hardware +features and system configuration. Detected features are advertised as node +labels. NFD provides flexible configuration and extension points for a wide +range of vendor and application specific node labeling needs. + +See +[NFD documentation](https://kubernetes-sigs.github.io/node-feature-discovery/master/get-started/deployment-and-usage.html#deployment-with-helm) +for deployment instructions. diff --git a/scripts/prepare-release.sh b/scripts/prepare-release.sh index 6e97dee77..91729d3ae 100755 --- a/scripts/prepare-release.sh +++ b/scripts/prepare-release.sh @@ -102,10 +102,13 @@ if [ -z "$assets_only" ]; then -i *yaml.template # Patch Helm chart + echo "Patching Helm chart" sed -e s"/appVersion:.*/appVersion: $release/" -i deployment/node-feature-discovery/Chart.yaml sed -e s"/pullPolicy:.*/pullPolicy: IfNotPresent/" \ -e s"!gcr.io/k8s-staging-nfd/node-feature-discovery!k8s.gcr.io/nfd/node-feature-discovery!" \ -i deployment/node-feature-discovery/values.yaml + sed -e s"!kubernetes-sigs.github.io/node-feature-discovery/master!kubernetes-sigs.github.io/node-feature-discovery/$docs_version!" \ + -i deployment/node-feature-discovery/README.md # Patch e2e test echo Patching test/e2e/node_feature_discovery.go flag defaults to k8s.gcr.io/nfd/node-feature-discovery and $release