Skip to content

Commit e0fada1

Browse files
Merge pull request #960 from redis/DOC-4610-rdi-fix-helm-install
DOC-4610 updated K8s install instructions
2 parents ead220e + ab0bb5f commit e0fada1

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

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

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,20 +95,22 @@ To pull images from a local registry, you must provide the image pull secret and
9595
9696
## Install the RDI Helm chart
9797
98-
1. Decompress the tar file:
98+
1. Scaffold the default `values.yaml` file from the chart into a local
99+
`rdi-values.yaml` file:
99100

100101
```bash
101-
tar -xvf rdi-<rdi-tag>.tar.gz
102+
helm show values rdi-<rdi-tag>.tar.gz > rdi-values.yaml
102103
```
103104

104-
1. Open the `values.yaml` file and set the appropriate values for your installation
105+
1. Open the `rdi-values.yaml` file you just created and set the appropriate
106+
values for your installation
105107
(see [The `values.yaml` file](#the-valuesyaml-file) below for the full set of
106108
available values).
107109

108110
1. Start the installation:
109111

110112
```bash
111-
helm install <The logical chart name> ./rdi --create-namespace -n rdi
113+
helm install rdi rdi-<rdi-tag>.tar.gz -f rdi-values.yaml
112114
```
113115

114116
### The `values.yaml` file
@@ -117,8 +119,18 @@ The annotated [`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and-
117119
file below describes the values you can set for the RDI Helm installation.
118120

119121
At a minimum, you must set the values of `RDI_REDIS_HOST` and `RDI_REDIS_PORT`
120-
in the `global.rdiSysConfig` section and also `RDI_REDIS_PASSWORD` in
121-
`global.rdiSysSecret` to enable the basic connection to the RDI database.
122+
in the `global.rdiSysConfig` section and also `RDI_REDIS_PASSWORD` and
123+
`JWT_SECRET_KEY` in `global.rdiSysSecret` to enable the basic connection to the
124+
RDI database. RDI uses the value in `JWT_SECRET_KEY` to encrypt the
125+
[JSON web token (JWT)](https://jwt.io/) token used by RDI API. Best practice is
126+
to generate a value containing 32 random bytes of data (equivalent to 256
127+
bits) and then encode this value as ASCII characters. Use the following
128+
command to generate the random key from the
129+
[`urandom` special file](https://en.wikipedia.org/wiki//dev/random):
130+
131+
```bash
132+
head -c 32 /dev/urandom | base64
133+
```
122134

123135
{{< note >}}If you want to use
124136
[Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}})
@@ -220,7 +232,8 @@ global:
220232
# RDI_REDIS_KEY_PASSPHRASE: ""
221233
222234
# The key used to encrypt the JWT token used by RDI API. Best practice is for this
223-
# to contain 32 ASCII characters (equivalent to 256 bits of data).
235+
# to contain 32 random bytes encoded as ASCII characters (equivalent to 256 bits of
236+
# data). See `The values.yaml file` section above to learn how to generate the key.
224237
# JWT_SECRET_KEY: ""
225238

226239
rdiDbSSLSecret:

0 commit comments

Comments
 (0)