Skip to content

DOC-4610 updated K8s install instructions #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 10, 2024
Merged

DOC-4610 updated K8s install instructions #960

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7c752d
DOC-4610 updated K8s install instructions
andy-stark-redis Dec 6, 2024
ab0bb5f
DOC-4610 implemented feedback
andy-stark-redis Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions content/integrate/redis-data-integration/installation/install-k8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. Scaffold the default `values.yaml` file from the chart into a local
`rdi-values.yaml` file:

```bash
tar -xvf rdi-<rdi-tag>.tar.gz
helm show values rdi-<rdi-tag>.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 <The logical chart name> ./rdi --create-namespace -n rdi
helm install rdi rdi-<rdi-tag>.tar.gz -f rdi-values.yaml
```

### The `values.yaml` file
Expand All @@ -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" >}})
Expand Down Expand Up @@ -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:
Expand Down
Loading