diff --git a/content/integrate/redis-data-integration/installation/install-k8s.md b/content/integrate/redis-data-integration/installation/install-k8s.md index a2a5915e71..c0d2da1b36 100644 --- a/content/integrate/redis-data-integration/installation/install-k8s.md +++ b/content/integrate/redis-data-integration/installation/install-k8s.md @@ -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-.tar.gz + tar -xvf rdi-.tar.gz ``` 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 1. Start the installation: ```bash - helm install rdi-k8s//helm --create-namespace -n rdi + helm install ./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. @@ -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. @@ -195,7 +207,7 @@ 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 @@ -203,7 +215,8 @@ global: # 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: @@ -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. @@ -436,11 +449,10 @@ NAME NAMESPACE REVISION UPDATED STATUS CHA 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- 1/1 Running 0 29m