From e7c752d7544c8cfcb59761587e30f13f52e6cb2d Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Fri, 6 Dec 2024 10:15:12 +0000 Subject: [PATCH 1/2] DOC-4610 updated K8s install instructions --- .../installation/install-k8s.md | 27 ++++++++++++++----- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/content/integrate/redis-data-integration/installation/install-k8s.md b/content/integrate/redis-data-integration/installation/install-k8s.md index f7996e1640..d5571285cb 100644 --- a/content/integrate/redis-data-integration/installation/install-k8s.md +++ b/content/integrate/redis-data-integration/installation/install-k8s.md @@ -95,20 +95,22 @@ To pull images from a local registry, you must provide the image pull secret and ## Install the RDI Helm chart -1. Decompress the tar file: +1. Extract the default `values.yaml` file from the chart into a local + `rdi-values.yaml` file: ```bash - tar -xvf rdi-.tar.gz + helm show values rdi-.tar.gz > rdi-values.yaml ``` -1. Open the `values.yaml` file and set the appropriate values for your installation +1. Open the `rdi-values.yaml` file you just created and set the appropriate + values for your installation (see [The `values.yaml` file](#the-valuesyaml-file) below for the full set of available values). 1. Start the installation: ```bash - helm install ./rdi --create-namespace -n rdi + helm install rdi rdi-.tar.gz -f rdi-values.yaml ``` ### The `values.yaml` file @@ -117,8 +119,18 @@ The annotated [`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and- file below describes the values you can set for the RDI Helm installation. At a minimum, you must set the values of `RDI_REDIS_HOST` and `RDI_REDIS_PORT` -in the `global.rdiSysConfig` section and also `RDI_REDIS_PASSWORD` in -`global.rdiSysSecret` to enable the basic connection to the RDI database. +in the `global.rdiSysConfig` section and also `RDI_REDIS_PASSWORD` and +`JWT_SECRET_KEY` in `global.rdiSysSecret` to enable the basic connection to the +RDI database. RDI uses the value in `JWT_SECRET_KEY` to encrypt the +[JSON web token (JWT)](https://jwt.io/) token used by RDI API. Best practice is +to generate a value containing 32 random bytes of data (equivalent to 256 +bits) and then encode this value as ASCII characters. Use the following +command to generate the random key from the +[`urandom` special file](https://en.wikipedia.org/wiki//dev/random): + +```bash +head -c 32 /dev/urandom | base64 +``` {{< note >}}If you want to use [Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}}) @@ -220,7 +232,8 @@ global: # RDI_REDIS_KEY_PASSPHRASE: "" # The key used to encrypt the JWT token used by RDI API. Best practice is for this - # to contain 32 ASCII characters (equivalent to 256 bits of data). + # to contain 32 random bytes encoded as ASCII characters (equivalent to 256 bits of + # data). See `The values.yaml file` section above to learn how to generate the key. # JWT_SECRET_KEY: "" rdiDbSSLSecret: From ab0bb5f505d0b13f8d9cc85a1c7c0698ea9a0ce3 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Tue, 10 Dec 2024 12:48:59 +0000 Subject: [PATCH 2/2] DOC-4610 implemented feedback --- .../redis-data-integration/installation/install-k8s.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/integrate/redis-data-integration/installation/install-k8s.md b/content/integrate/redis-data-integration/installation/install-k8s.md index d5571285cb..6522433e21 100644 --- a/content/integrate/redis-data-integration/installation/install-k8s.md +++ b/content/integrate/redis-data-integration/installation/install-k8s.md @@ -95,7 +95,7 @@ To pull images from a local registry, you must provide the image pull secret and ## Install the RDI Helm chart -1. Extract the default `values.yaml` file from the chart into a local +1. Scaffold the default `values.yaml` file from the chart into a local `rdi-values.yaml` file: ```bash