@@ -15,12 +15,12 @@ The Operator is an Enterprise only feature, please [contact us](https://www.kurr
1515To get the best out of this guide, a basic understanding of [ Kubernetes concepts] ( https://kubernetes.io/docs/concepts/ ) is essential.
1616:::
1717
18- * A Kubernetes cluster running ` v1.23.1 ` or later .
18+ * A Kubernetes cluster running any [ non-EOL version of kubernetes ] ( https://kubernetes.io/releases/ ) .
1919* Permission to create resources, deploy the Operator and install CRDs in the target cluster.
2020* The following CLI tools installed, on your shell’s ` $PATH ` , with ` $KUBECONFIG ` pointing to your cluster:
21- * kubectl [ install guide ] ( https://kubernetes.io/docs/tasks/tools/install-kubectl )
22- * k9s [ install guide ] ( https://k9scli.io/topics/install/ )
23- * Helm 3 CLI [ install guide ] ( https://helm.sh/docs/intro/install/ )
21+ * [ kubectl ] ( https://kubernetes.io/docs/tasks/tools/install-kubectl )
22+ * [ k9s ] ( https://k9scli.io/topics/install/ )
23+ * [ Helm 3 CLI] ( https://helm.sh/docs/intro/install/ )
2424 * A valid Operator license. Please [ contact us] ( https://www.kurrent.io/contact ) for more information.
2525
2626## Configure Helm Repository
@@ -52,16 +52,19 @@ If you prefer to install CRDs yourself:
5252
5353``` bash
5454# Download the kurrentdb-operator Helm chart
55- helm pull kurrent-latest/kurrentdb-operator --version 1.2 .0 --untar
55+ helm pull kurrent-latest/kurrentdb-operator --version 1.3 .0 --untar
5656# Install the CRDs
57- kubectl apply -f kurrentdb-operator/templates/ crds
57+ kubectl apply -f kurrentdb-operator/crds
5858```
5959* Expected Output* :
6060```
6161customresourcedefinition.apiextensions.k8s.io/kurrentdbbackups.kubernetes.kurrent.io created
6262customresourcedefinition.apiextensions.k8s.io/kurrentdbs.kubernetes.kurrent.io created
6363```
6464
65+ After installing CRDs manually, you should include the ` --skip-crds ` flag for the ` helm install ` and
66+ ` helm upgrade ` commands.
67+
6568## Deployment Modes
6669
6770The Operator can be scoped to track Kurrent resources across ** all** or ** specific** namespaces.
@@ -74,18 +77,17 @@ To deploy the Operator in this mode, run:
7477
7578``` bash
7679helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
77- --version 1.2 .0 \
80+ --version 1.3 .0 \
7881 --namespace kurrent \
7982 --create-namespace \
80- --set crds.enabled=true \
8183 --set-file operator.license.key=/path/to/license.key \
8284 --set-file operator.license.file=/path/to/license.lic
8385```
8486
8587This command:
8688- Deploys the Operator into the ` kurrent ` namespace (use ` --create-namespace ` to create it). Feel free to modify this namespace.
8789- Creates the namespace (if it already exists, leave out the ` --create-namespace ` flag)
88- - Deploys CRDs (this can be skipped by removing ` --set crds.enabled=true ` )
90+ - Deploys CRDs (this can be skipped by removing ` --skip- crds ` )
8991- Applys the Operator license
9092- Deploys a new Helm release called ` kurrentdb-operator ` in the ` kurrent ` namespace.
9193
@@ -109,10 +111,9 @@ To deploy the Operator in this mode, the following command can be used:
109111
110112``` bash
111113helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
112- --version 1.2 .0 \
114+ --version 1.3 .0 \
113115 --namespace kurrent \
114116 --create-namespace \
115- --set crds.enabled=true \
116117 --set-file operator.license.key=/path/to/license.key \
117118 --set-file operator.license.file=/path/to/license.lic \
118119 --set operator.namespaces=' {kurrent, foo}'
@@ -121,7 +122,7 @@ helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
121122Here's what the command does:
122123- Sets the namespace of where the Operator will be deployed i.e. ` kurrent ` (feel free to change this)
123124- Creates the namespace (if it already exists, leave out the ` --create-namespace ` flag)
124- - Deploys CRDs (this can be skipped by removing ` --set crds.enabled=true ` )
125+ - Deploys CRDs (this can be skipped by setting ` --skip- crds ` )
125126- Configures the Operator license
126127- Sets the underlying Operator configuration to target the namespaces: ` kurrent ` and ` foo `
127128- Deploys a new Helm release called ` kurrentdb-operator ` in the ` kurrent ` namespace
@@ -148,7 +149,7 @@ The Operator deployment can be updated to adjust which namespaces are watched. F
148149
149150``` bash
150151helm upgrade kurrentdb-operator kurrent-latest/kurrentdb-operator \
151- --version 1.2 .0 \
152+ --version 1.3 .0 \
152153 --namespace kurrent \
153154 --reuse-values \
154155 --set operator.namespaces=' {kurrent,foo,bar}'
@@ -175,3 +176,21 @@ Pods may also be viewed using the `:pods` command, for example:
175176Pressing the ` Return ` key on the selected Operator pod will allow you to drill through the container hosted in the pod, and then finally to the logs:
176177
177178![ Operator Logs] ( images/install/logs.png )
179+
180+
181+ ## Upgrading an Installation
182+
183+ The Operator can be upgraded using the following ` helm ` commands:
184+
185+ ``` bash
186+ helm repo update
187+ helm upgrade kurrentdb-operator kurrentdb-operator-repo/kurrentdb-operator \
188+ --namespace kurrent \
189+ --version {version}
190+ ```
191+
192+ Here's what these commands do:
193+ - Refresh the local Helm repository index
194+ - Locates an existing operator installation in namespace ` kurrent `
195+ - Selects the target upgrade version ` {version} ` e.g. ` 1.3.0 `
196+ - Performs the upgrade, preserving values that were set during installation
0 commit comments