Skip to content

Commit e708990

Browse files
authored
chore: document crd upgrades (#361)
Signed-off-by: Todd Baert <[email protected]>
1 parent 17ac016 commit e708990

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

docs/installation.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,41 @@ Install the latest helm release:
1919
```sh
2020
helm repo add openfeature https://open-feature.github.io/open-feature-operator/
2121
helm repo update
22-
helm upgrade -i openfeature openfeature/open-feature-operator
22+
helm upgrade --install openfeature openfeature/open-feature-operator
2323
```
24+
### Upgrading
25+
26+
```sh
27+
helm upgrade --install openfeature openfeature/open-feature-operator
28+
```
29+
30+
#### Upgrading CRDs
31+
32+
CRDs are not upgraded automatically with helm (https://helm.sh/docs/chart_best_practices/custom_resource_definitions/).
33+
OpenFeature Operator's CRDs are templated, and can be updated apart from the operator itself by using helm's template functionality and piping the output to `kubectl`:
34+
35+
```sh
36+
helm template openfeature/open-feature-operator -s templates/{CRD} | kubectl apply -f -
37+
```
38+
39+
For the `featureflagconfigurations.core.openfeature.dev` CRD:
40+
41+
```sh
42+
helm template openfeature/open-feature-operator -s templates/apiextensions.k8s.io_v1_customresourcedefinition_featureflagconfigurations.core.openfeature.dev.yaml | kubectl apply -f -
43+
```
44+
45+
For the `flagsourceconfigurations.core.openfeature.dev` CRD:
46+
47+
```sh
48+
helm template openfeature/open-feature-operator -s templates/apiextensions.k8s.io_v1_customresourcedefinition_flagsourceconfigurations.core.openfeature.dev.yaml | kubectl apply -f -
49+
```
50+
51+
Keep in mind, you can set values as usual during this process:
52+
53+
```sh
54+
helm template openfeature/open-feature-operator -s templates/{CRD} --set defaultNamespace=myns | kubectl apply -f -
55+
```
56+
2457
### Uninstall
2558
```sh
2659
helm uninstall ofo

0 commit comments

Comments
 (0)