Skip to content

Commit 3c60f66

Browse files
Merge pull request #882 from redis/DOC-4561-rdi-helm-fixes
DOC-4561 fixes for RDI Helm docs
2 parents 77149f2 + 807292b commit 3c60f66

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

content/integrate/redis-data-integration/installation/install-k8s.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ To pull images from a local registry, you must provide the image pull secret and
9494
1. Decompress the tar file:
9595
9696
```bash
97-
tar -xvf rdi-k8s-<rdi-tag>.tar.gz
97+
tar -xvf rdi-<rdi-tag>.tar.gz
9898
```
9999

100100
1. Open the `values.yaml` file and set the appropriate values for your installation
@@ -104,13 +104,25 @@ To pull images from a local registry, you must provide the image pull secret and
104104
1. Start the installation:
105105

106106
```bash
107-
helm install <The logical chart name> rdi-k8s/<rdi-tag>/helm --create-namespace -n rdi
107+
helm install <The logical chart name> ./rdi --create-namespace -n rdi
108108
```
109109

110110
### The `values.yaml` file
111111

112112
The annotated [`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and-values)
113-
file below describes the values you can set for the RDI Helm installation:
113+
file below describes the values you can set for the RDI Helm installation.
114+
115+
At a minimum, you must set the values of `RDI_REDIS_HOST` and `RDI_REDIS_PORT`
116+
in the `global.rdiSysConfig` section and also `RDI_REDIS_PASSWORD` in
117+
`global.rdiSysSecret` to enable the basic connection to the RDI database.
118+
119+
{{< note >}}If you want to use
120+
[Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}})
121+
to connect to your RDI deployment from outside the K8s cluster, you
122+
must enable TLS.
123+
{{< /note >}}
124+
125+
The full `values.yaml` file is shown below:
114126

115127
```yaml
116128
# Default RDI values in YAML format.
@@ -134,7 +146,7 @@ global:
134146
135147
image:
136148
# Overrides the image tag for all RDI components.
137-
tag: 0.0.0
149+
# tag: 0.0.0
138150
139151
# If using a private repository, update the default values accordingly.
140152
# Docker registry.
@@ -195,15 +207,16 @@ global:
195207
# DO NOT modify this value.
196208
# RDI_REDIS_CACERT: /etc/certificates/rdi_db/cacert
197209
198-
# Uncomment these properties when using a TLS connection from RDI to its Redis database.
210+
# Uncomment these properties when using an mTLS connection from RDI to its Redis database.
199211
# DO NOT modify these values.
200212
# RDI_REDIS_CERT: /etc/certificates/rdi_db/cert
201213
# RDI_REDIS_KEY: /etc/certificates/rdi_db/key
202214
203215
# The passphrase used to get the private key stored in the secret store when using mTLS.
204216
# RDI_REDIS_KEY_PASSPHRASE: ""
205217
206-
# The key used to encrypt the JWT token used by RDI API.
218+
# The key used to encrypt the JWT token used by RDI API. Best practice is for this
219+
# to contain 32 ASCII characters (equivalent to 256 bits of data).
207220
# JWT_SECRET_KEY: ""
208221
209222
rdiDbSSLSecret:
@@ -215,11 +228,11 @@ global:
215228
# cacert: ""
216229

217230
# The content of the certificate PEM file.
218-
# Uncomment and set this property when using a TLS connection from RDI to its Redis database.
231+
# Uncomment and set this property when using an mTLS connection from RDI to its Redis database.
219232
# cert: ""
220233

221234
# The content of the private key PEM file.
222-
# Uncomment and set this property when using a TLS connection from RDI to its Redis database.
235+
# Uncomment and set this property when using an mTLS connection from RDI to its Redis database.
223236
# key: ""
224237

225238
# Container default security context.
@@ -436,11 +449,10 @@ NAME NAMESPACE REVISION UPDATED STATUS CHA
436449
<logical_chart_name> rdi 1 2024-10-10 16:53... +0300 IDT deployed rdi-1.0.0
437450
```
438451

439-
440452
Also, check that the following pods have `Running` status:
441453

442454
```bash
443-
sudo k3s kubectl get pod -n rdi
455+
kubectl get pod -n rdi
444456

445457
NAME READY STATUS RESTARTS AGE
446458
rdi-api-<id> 1/1 Running 0 29m

0 commit comments

Comments
 (0)