Skip to content

Commit 8ffe9f9

Browse files
authored
Merge pull request #1807 from ArangoGutierrez/upgrade
Add helm migration guide
2 parents 6929e03 + cb53f9f commit 8ffe9f9

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

docs/deployment/helm.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,67 @@ export NFD_NS=node-feature-discovery
6565
helm install nfd/node-feature-discovery --set nameOverride=NFDinstance --set master.replicaCount=2 --namespace $NFD_NS --create-namespace
6666
```
6767

68+
## Upgrading the chart
69+
70+
To upgrade the `node-feature-discovery` deployment to {{ site.release }} via Helm.
71+
72+
### From v0.7 and older
73+
74+
Please see the [uninstallation guide](https://kubernetes-sigs.github.io/node-feature-discovery/v0.7/get-started/deployment-and-usage.html#uninstallation).
75+
And then follow the standard [deployment instructions](#deployment).
76+
77+
### From v0.8 - v0.11
78+
79+
Helm deployment of NFD was introduced in v0.8.0.
80+
81+
```bash
82+
export NFD_NS=node-feature-discovery
83+
# Uninstall the old NFD deployment
84+
helm uninstall node-feature-discovery --namespace $NFD_NS
85+
# Update Helm repository
86+
helm repo update
87+
# Install the new NFD deployment
88+
helm upgrade --install node-feature-discovery nfd/node-feature-discovery --namespace $NFD_NS --set master.enable=false
89+
# Wait for NFD Worker to be ready
90+
kubectl wait --timeout=-1s --for=condition=ready pod -l app.kubernetes.io/name=node-feature-discovery --namespace $NFD_NS
91+
# Enable the NFD Master
92+
helm upgrade --install node-feature-discovery nfd/node-feature-discovery --namespace $NFD_NS --set master.enable=true
93+
```
94+
95+
### From v0.12 - v0.13
96+
97+
In v0.12 the `NodeFeature` CRD was introduced as experimental.
98+
The API was not enabled by default.
99+
100+
```bash
101+
export NFD_NS=node-feature-discovery
102+
# Update Helm repository
103+
helm repo update
104+
# Install and upgrade CRD's
105+
kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/node-feature-discovery/master/deployment/base/nfd-crds/nfd-api-crds.yaml
106+
# Install the new NFD deployment
107+
helm upgrade node-feature-discovery nfd/node-feature-discovery --namespace $NFD_NS --set master.enable=false
108+
# Wait for NFD Worker to be ready
109+
kubectl wait --timeout=-1s --for=condition=ready pod -l app.kubernetes.io/name=node-feature-discovery --namespace $NFD_NS
110+
# Enable the NFD Master
111+
helm upgrade node-feature-discovery nfd/node-feature-discovery --namespace $NFD_NS --set master.enable=true
112+
```
113+
114+
### From v0.14+
115+
116+
As of version v0.14 the Helm chart is the primary deployment method for NFD,
117+
and the CRD `NodeFeature` is enabled by default.
118+
119+
```bash
120+
export NFD_NS=node-feature-discovery
121+
# Update Helm repository
122+
helm repo update
123+
# Install and upgrade CRD's
124+
kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/node-feature-discovery/{{ site.release }}/deployment/base/nfd-crds/nfd-api-crds.yaml
125+
# Install the new NFD deployment
126+
helm upgrade node-feature-discovery nfd/node-feature-discovery --namespace $NFD_NS
127+
```
128+
68129
## Uninstalling the chart
69130

70131
To uninstall the `node-feature-discovery` deployment:

0 commit comments

Comments
 (0)