@@ -48,22 +48,29 @@ It's recommended to install and manage the CRDs using Helm. See [Deployment Mode
4848
4949### Manual Install
5050
51+ ::: important
52+ Do not ever add ` --set crds.enabled=false ` during a ` helm upgrade ` if you did not set the same flag
53+ during the original ` helm install ` , otherwise the CRD removal will delete every KurrentDB installed
54+ on the cluster!
55+ :::
56+
5157If you prefer to install CRDs yourself:
5258
5359``` bash
5460# Download the kurrentdb-operator Helm chart
55- helm pull kurrent-latest/kurrentdb-operator --version 1.3.0 --untar
61+ helm pull kurrent-latest/kurrentdb-operator --version 1.4.0
5662# Install the CRDs
57- kubectl apply -f kurrentdb-operator/crds
63+ helm template -s ' templates/crds/*.yaml ' kurrentdb-operator-1.4.0.tgz | kubectl apply -f -
5864```
5965* Expected Output* :
6066```
6167customresourcedefinition.apiextensions.k8s.io/kurrentdbbackups.kubernetes.kurrent.io created
6268customresourcedefinition.apiextensions.k8s.io/kurrentdbs.kubernetes.kurrent.io created
6369```
6470
65- After installing CRDs manually, you should include the ` --skip-crds ` flag for the ` helm install ` and
66- ` helm upgrade ` commands.
71+ After installing CRDs manually, you should include the ` --set crds.enabled=false ` flag for the `helm
72+ install` command, and include one of ` --set crds.enabled=false` , ` --reuse-values`, or
73+ ` --reset-then-reuse-values ` for the ` helm upgrade ` command.
6774
6875## Deployment Modes
6976
@@ -77,17 +84,18 @@ To deploy the Operator in this mode, run:
7784
7885``` bash
7986helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
80- --version 1.3 .0 \
87+ --version 1.4 .0 \
8188 --namespace kurrent \
8289 --create-namespace \
90+ --set crds.enabled=true \
8391 --set-file operator.license.key=/path/to/license.key \
8492 --set-file operator.license.file=/path/to/license.lic
8593```
8694
8795This command:
8896- Deploys the Operator into the ` kurrent ` namespace (use ` --create-namespace ` to create it). Feel free to modify this namespace.
8997- Creates the namespace (if it already exists, leave out the ` --create-namespace ` flag).
90- - Deploys CRDs (this can be skipped by adding ` --skip- crds ` ).
98+ - Deploys CRDs (this can be skipped by removing ` --set crds.enabled=true ` ).
9199- Applys the Operator license.
92100- Deploys a new Helm release called ` kurrentdb-operator ` in the ` kurrent ` namespace.
93101
@@ -111,9 +119,10 @@ To deploy the Operator in this mode, the following command can be used:
111119
112120``` bash
113121helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
114- --version 1.3 .0 \
122+ --version 1.4 .0 \
115123 --namespace kurrent \
116124 --create-namespace \
125+ --set crds.enabled=true \
117126 --set-file operator.license.key=/path/to/license.key \
118127 --set-file operator.license.file=/path/to/license.lic \
119128 --set operator.namespaces=' {kurrent, foo}'
@@ -122,7 +131,7 @@ helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
122131Here's what the command does:
123132- Sets the namespace of where the Operator will be deployed i.e. ` kurrent ` (feel free to change this)
124133- Creates the namespace (if it already exists, leave out the ` --create-namespace ` flag)
125- - Deploys CRDs (this can be skipped by adding ` --skip- crds ` )
134+ - Deploys CRDs (this can be skipped by removing ` --set crds.enabled=true ` )
126135- Configures the Operator license
127136- Configures the Operator to operate on resources the namespaces ` kurrent ` and ` foo `
128137- Deploys a new Helm release called ` kurrentdb-operator ` in the ` kurrent ` namespace
@@ -149,7 +158,7 @@ The Operator deployment can be updated to adjust which namespaces are watched. F
149158
150159``` bash
151160helm upgrade kurrentdb-operator kurrent-latest/kurrentdb-operator \
152- --version 1.3 .0 \
161+ --version 1.4 .0 \
153162 --namespace kurrent \
154163 --reuse-values \
155164 --set operator.namespaces=' {kurrent,foo,bar}'
@@ -186,11 +195,18 @@ The Operator can be upgraded using the following `helm` commands:
186195helm repo update
187196helm upgrade kurrentdb-operator kurrentdb-operator-repo/kurrentdb-operator \
188197 --namespace kurrent \
189- --version {version}
198+ --version {version} \
199+ --reset-then-reuse-values
190200```
191201
192202Here's what these commands do:
193203- Refresh the local Helm repository index
194204- Locate an existing operator installation in namespace ` kurrent `
195- - Select the target upgrade version ` {version} ` e.g. ` 1.3 .0 `
205+ - Select the target upgrade version ` {version} ` e.g. ` 1.4 .0 `
196206- Perform the upgrade, preserving values that were set during installation
207+
208+ ::: important
209+ Do not ever add ` --set crds.enabled=false ` during a ` helm upgrade ` if you did not set the same flag
210+ during the original ` helm install ` , otherwise the CRD removal will delete every KurrentDB installed
211+ on the cluster!
212+ :::
0 commit comments