Skip to content

Commit 87dc385

Browse files
cchanningChristopher Channing
andauthored
ESCLOUD-977: Updated Operator docs with license info (#845)
Co-authored-by: Christopher Channing <chris.channing@kurrent.io>
1 parent acd5eef commit 87dc385

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

docs/server/kubernetes-operator/getting-started/installation.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,15 @@ Before installing and executing the Operator, the following requirements should
2323
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl)
2424
* [k9s](https://k9scli.io/topics/install/)
2525
* The [Helm 3 CLI](https://helm.sh/docs/intro/install/) tool is installed and configured to interact with your Kubernetes cluster.
26-
* Credentials for the Operator artifact repository (please [contact us](https://www.kurrent.io/contact) for more information). References to the credentials appear as `$username` and `$password` in the guide.
26+
* Operator license (please [contact us](https://www.kurrent.io/contact) for more information).
2727

2828
## Helm Repository
2929

3030
The Operator deployment process is managed via Helm. The following Kurrent repository must be configured using the command:
3131

3232
```bash
33-
helm repo add kurrentdb-operator-repo \
34-
'https://packages.kurrent.io/basic/kurrentdb-operator/helm/charts/' \
35-
--username $username \
36-
--password $password
33+
helm repo add kurrent-latest \
34+
'https://packages.kurrent.io/basic/kurrent-latest/helm/charts/'
3735
```
3836

3937
## Custom Resource Definitions (CRDs)
@@ -54,7 +52,7 @@ If the CRDs must be installed manually, then the following steps can be used:
5452

5553
```bash
5654
# Download the kurrentdb-operator Helm chart
57-
helm pull kurrentdb-operator-repo/kurrentdb-operator --version 1.0.0 --untar
55+
helm pull kurrent-latest/kurrentdb-operator --version 1.0.0 --untar
5856
# Install the CRDs
5957
kubectl apply -f kurrentdb-operator/templates/crds
6058
```
@@ -75,19 +73,20 @@ In this mode, the Operator will track Kurrent resources across **all** namespace
7573
To deploy the Operator in this mode, the following command can be used:
7674

7775
```bash
78-
helm install kurrentdb-operator kurrentdb-operator-repo/kurrentdb-operator \
76+
helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
7977
--version 1.0.0 \
8078
--namespace kurrent \
8179
--create-namespace \
8280
--set crds.enabled=true \
83-
--set operator.imageRepository.username=$username \
84-
--set operator.imageRepository.password=$password
81+
--set-file operator.license.key=/path/to/license.key \
82+
--set-file operator.license.file=/path/to/license.lic
8583
```
8684

8785
Here's what the command does:
8886
- Sets the namespace of where the Operator will be deployed i.e. `kurrent` (feel free to change this)
8987
- Creates the namespace (if it already exists, leave out the `--create-namespace` flag)
9088
- Deploys CRDs (this can be skipped by removing `--set crds.enabled=true`)
89+
- Configures the Operator license
9190
- Deploys a new Helm release called `kurrentdb-operator` in the `kurrent` namespace.
9291

9392
*Expected Output*:
@@ -109,20 +108,21 @@ In this mode, the Operator will track Kurrent resources across **specific** name
109108
To deploy the Operator in this mode, the following command can be used:
110109

111110
```bash
112-
helm install kurrentdb-operator kurrentdb-operator-repo/kurrentdb-operator \
111+
helm install kurrentdb-operator kurrent-latest/kurrentdb-operator \
113112
--version 1.0.0 \
114113
--namespace kurrent \
115114
--create-namespace \
116115
--set crds.enabled=true \
117-
--set operator.imageRepository.username=$username \
118-
--set operator.imageRepository.password=$password \
116+
--set-file operator.license.key=/path/to/license.key \
117+
--set-file operator.license.file=/path/to/license.lic \
119118
--set operator.namespaces='{kurrent, foo}'
120119
```
121120

122121
Here's what the command does:
123122
- Sets the namespace of where the Operator will be deployed i.e. `kurrent` (feel free to change this)
124123
- Creates the namespace (if it already exists, leave out the `--create-namespace` flag)
125124
- Deploys CRDs (this can be skipped by removing `--set crds.enabled=true`)
125+
- Configures the Operator license
126126
- Sets the underlying Operator configuration to target the namespaces: `kurrent` and `foo`
127127
- Deploys a new Helm release called `kurrentdb-operator` in the `kurrent` namespace
128128

@@ -147,9 +147,10 @@ Once installed, navigate to the [deployment validation](#deployment-validation)
147147
The Operator deployment can be updated to adjust which namespaces are watched. For example, in addition to the `kurrent` and `foo` namespaces (from the example above), a new namespace `bar` may also be watched using the command below:
148148

149149
```bash
150-
helm upgrade kurrentdb-operator kurrentdb-operator-repo/kurrentdb-operator \
150+
helm upgrade kurrentdb-operator kurrent-latest/kurrentdb-operator \
151151
--version 1.0.0 \
152152
--namespace kurrent \
153+
--reuse-values \
153154
--set operator.namespaces='{kurrent,foo,bar}'
154155
```
155156

0 commit comments

Comments
 (0)