Skip to content

DOC-4561 fixes for RDI Helm docs #882

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 4 commits into from
Nov 20, 2024
Merged

DOC-4561 fixes for RDI Helm docs #882

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
29301ce
DOC-4561 added suggested fixes
andy-stark-redis Nov 15, 2024
143aa6a
DOC-4561 added further fixes suggested by Yaron
andy-stark-redis Nov 15, 2024
4995469
DOC-4561 changed note about Redis Insight
andy-stark-redis Nov 18, 2024
807292b
DOC-4561 implemented feedback
andy-stark-redis Nov 19, 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
32 changes: 22 additions & 10 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 @@ -94,7 +94,7 @@ To pull images from a local registry, you must provide the image pull secret and
1. Decompress the tar file:

```bash
tar -xvf rdi-k8s-<rdi-tag>.tar.gz
tar -xvf rdi-<rdi-tag>.tar.gz
Copy link
Collaborator

@dwdougherty dwdougherty Nov 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like a tab character was used before "tar". I suggest replacing this with spaces. Here's an octal dump of the above snippet:

0000000    1   .           D   e   c   o   m   p   r   e   s   s       t
0000020    h   e       t   a   r       f   i   l   e   :  \n  \n        
0000040            `   `   `   b   a   s   h  \n  \t   t   a   r       -
0000060    x   v   f       r   d   i   -   <   r   d   i   -   t   a   g
0000100    >   .   t   a   r   .   g   z      \n                   `   `
0000120    `                                                            
0000121

In VS Code, the tar line does not line up with the indent of the line above.

Doesn't look like this affects the display, so consider it a quality of life change. :)

```

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

```bash
helm install <The logical chart name> rdi-k8s/<rdi-tag>/helm --create-namespace -n rdi
helm install <The logical chart name> ./rdi --create-namespace -n rdi
```

### The `values.yaml` file

The annotated [`values.yaml`](https://helm.sh/docs/topics/charts/#templates-and-values)
file below describes the values you can set for the RDI Helm installation:
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.

{{< note >}}If you want to use
[Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}})
to connect to your RDI deployment from outside the K8s cluster, you
must enable TLS.
{{< /note >}}

The full `values.yaml` file is shown below:

```yaml
# Default RDI values in YAML format.
Expand All @@ -134,7 +146,7 @@ global:

image:
# Overrides the image tag for all RDI components.
tag: 0.0.0
# tag: 0.0.0

# If using a private repository, update the default values accordingly.
# Docker registry.
Expand Down Expand Up @@ -195,15 +207,16 @@ global:
# DO NOT modify this value.
# RDI_REDIS_CACERT: /etc/certificates/rdi_db/cacert

# Uncomment these properties when using a TLS connection from RDI to its Redis database.
# Uncomment these properties when using an mTLS connection from RDI to its Redis database.
# DO NOT modify these values.
# RDI_REDIS_CERT: /etc/certificates/rdi_db/cert
# RDI_REDIS_KEY: /etc/certificates/rdi_db/key

# The passphrase used to get the private key stored in the secret store when using mTLS.
# RDI_REDIS_KEY_PASSPHRASE: ""

# The key used to encrypt the JWT token used by RDI API.
# 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).
# JWT_SECRET_KEY: ""

rdiDbSSLSecret:
Expand All @@ -215,11 +228,11 @@ global:
# cacert: ""

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

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

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


Also, check that the following pods have `Running` status:

```bash
sudo k3s kubectl get pod -n rdi
kubectl get pod -n rdi

NAME READY STATUS RESTARTS AGE
rdi-api-<id> 1/1 Running 0 29m
Expand Down
Loading