Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 1d38887

Browse files
authoredMay 12, 2025··
Merge pull request #1538 from stoyanr/RDSC-3533-update-rdi-docs
RDSC-3533 Update RDI documentation, part 1
2 parents 4b1ff1c + 501486c commit 1d38887

File tree

7 files changed

+266
-587
lines changed

7 files changed

+266
-587
lines changed
 

‎content/embeds/rdi-db-reqs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
quickstart or for development, 125MB and a single shard is sufficient.
44
* If you are deploying RDI for a production environment then secure this database with a password
55
and TLS.
6-
* Provide the installation with the required RDI database details.
76
* Set the database's
87
[eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) to `noeviction`. Note that you can't set this using
98
[`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}),

‎content/embeds/rdi-vm-reqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
* **CPU**: A minimum of 4 CPU cores. You should consider adding
22
2-6 extra cores on top of this if your dataset is big and you want to ingest the
33
baseline snapshot as fast as possible.
4-
* **RAM**: 2GB
4+
* **RAM**: 8GB
55
* **Disk**: On top of the OS footprint,
66
RDI requires 20GB in the `/var` folder and 1GB in the `/opt` folder (to
77
store the log files). This allows space for upgrades.

‎content/integrate/redis-data-integration/installation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ weight: 2
1818
---
1919

2020
The guides in this section explain the options you have for installing and upgrading RDI.
21-
Before you use RDI, you must also configure your source database to use the CDC connector. See the
21+
Before you use RDI, you must also configure your source database to enable CDC. See the
2222
[Prepare source databases]({{< relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs" >}})
2323
section to learn how to do this.

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

Lines changed: 127 additions & 371 deletions
Large diffs are not rendered by default.

‎content/integrate/redis-data-integration/installation/install-vm.md

Lines changed: 70 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,25 @@ your source database. You can also
2323
{{< note >}}We recommend you always use the latest version, which is RDI {{< field "rdi_current_version" >}}.
2424
{{< /note >}}
2525

26+
## Create the RDI database
27+
28+
RDI uses a database on your Redis Enterprise cluster to store its state
29+
information. Use the Redis Enterprise Cluster Manager UI to create the RDI database with the following
30+
requirements:
31+
32+
{{< embed-md "rdi-db-reqs.md" >}}
33+
2634
## Hardware sizing
2735

2836
RDI is mainly CPU and network bound.
2937
Each of the RDI VMs should have at least:
3038

3139
{{< embed-md "rdi-vm-reqs.md" >}}
3240

33-
## Install RDI on VMs
41+
## VM Installation Requirements
3442

35-
You would normally install RDI on two VMs for high availability (HA) but you can also install
36-
one just one VM if you don't need this. For example, you might not need HA during
43+
You would normally install RDI on two VMs for High Availability (HA) but you can also install
44+
just one VM if you don't need this. For example, you might not need HA during
3745
development and testing.
3846

3947
{{< note >}}You can't install RDI on a host where a Redis Enterprise cluster
@@ -53,8 +61,8 @@ You may encounter problems if you use `iptables` v1.6.1 and earlier in
5361
legacy mode with the following commands:
5462

5563
```bash
56-
update-alternatives --set iptables /usr/sbin/iptables-legacy
57-
update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy
64+
sudo update-alternatives --set iptables /usr/sbin/iptables-legacy
65+
sudo update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy
5866
```
5967

6068
Also, `iptables` versions 1.8.0-1.8.4 have known issues that can prevent RDI
@@ -83,38 +91,25 @@ We recommend you turn off
8391
before installation using the command:
8492

8593
```bash
86-
systemctl disable firewalld --now
94+
sudo systemctl disable firewalld --now
8795
```
8896

8997
However, if you do need to use `firewalld`, you must add the following rules:
9098

9199
```bash
92-
firewall-cmd --permanent --add-port=6443/tcp #apiserver
93-
firewall-cmd --permanent --zone=trusted --add-source=10.42.0.0/16 #pods
94-
firewall-cmd --permanent --zone=trusted --add-source=10.43.0.0/16 #services
95-
firewall-cmd --reload
100+
sudo firewall-cmd --permanent --add-port=443/tcp # RDI API
101+
sudo firewall-cmd --permanent --add-port=6443/tcp # kube-apiserver
102+
sudo firewall-cmd --permanent --zone=trusted --add-source=10.42.0.0/16 # Kubernetes pods
103+
sudo firewall-cmd --permanent --zone=trusted --add-source=10.43.0.0/16 # Kubernetes services
104+
sudo firewall-cmd --reload
96105
```
97106

98-
You should also add [port rules](https://firewalld.org/documentation/howto/open-a-port-or-service.html)
99-
for all the [RDI services]({{< relref "/integrate/redis-data-integration/reference/ports" >}})
100-
you intend to use:
101-
102-
```bash
103-
firewall-cmd --permanent --add-port=8080/tcp # (Required) rdi-operator/rdi-api
104-
firewall-cmd --permanent --add-port=9090/tcp # vm-dis-reloader
105-
firewall-cmd --permanent --add-port=9092/tcp # prometheus-service
106-
firewall-cmd --permanent --add-port=9121/tcp # rdi-metric-exporter
107-
```
108-
109-
{{<note>}}You may also need to add similar rules to open other ports if your setup requires them.
110-
{{</note>}}
111-
112107
If you have `nm-cloud-setup.service` enabled, you must disable it and reboot the
113108
node with the following commands:
114109

115110
```bash
116-
systemctl disable nm-cloud-setup.service nm-cloud-setup.timer
117-
reboot
111+
sudo systemctl disable nm-cloud-setup.service nm-cloud-setup.timer
112+
sudo reboot
118113
```
119114

120115
### Ubuntu {#firewall-ubuntu}
@@ -130,41 +125,35 @@ sudo ufw disable
130125
However, if you do need to use `ufw`, you must add the following rules:
131126

132127
```bash
133-
ufw allow 6443/tcp #apiserver
134-
ufw allow from 10.42.0.0/16 to any #pods
135-
ufw allow from 10.43.0.0/16 to any #services
128+
sudo ufw allow 443/tcp # RDI API
129+
sudo ufw allow 6443/tcp # kube-apiserver
130+
sudo ufw allow from 10.42.0.0/16 to any # Kubernetes pods
131+
sudo ufw allow from 10.43.0.0/16 to any # Kubernetes services
132+
sudo ufw reload
136133
```
137134

138-
You should also add [port rules](https://ubuntu.com/server/docs/firewalls)
139-
for all the [RDI services]({{< relref "/integrate/redis-data-integration/reference/ports" >}})
140-
you intend to use:
141-
142-
```bash
143-
ufw allow 8080/tcp # (Required) rdi-operator/rdi-api
144-
ufw allow 9090/tcp # vm-dis-reloader
145-
ufw allow 9092/tcp # prometheus-service
146-
ufw allow 9121/tcp # rdi-metric-exporter
147-
```
148-
149-
{{<note>}}You may also need to add similar rules to open other ports if your setup requires them.
150-
{{</note>}}
151-
152135
## Installation steps
153136

154137
Follow the steps below for each of your VMs:
155138

156139
1. Download the RDI installer from the
157-
[Redis download center](https://redis-enterprise-software-downloads.s3.amazonaws.com/redis-di/rdi-installation-1.6.7.tar.gz)
140+
[Redis download center](https://redis.io/downloads/)
158141
(from the *Modules, Tools & Integration* category) and extract it to your preferred installation
159142
folder.
160143

161-
1. Go to the installation folder:
144+
```bash
145+
export RDI_VERSION=<version>
146+
wget https://redis-enterprise-software-downloads.s3.amazonaws.com/redis-di/rdi-installation-$RDI_VERSION.tar.gz
147+
tar -xvf rdi-installation-$RDI_VERSION.tar.gz
148+
```
149+
150+
1. Go to the installation folder:
162151

163152
```bash
164153
cd rdi_install/$RDI_VERSION
165154
```
166155

167-
1. Run the installer as a privileged user:
156+
1. Run the `install.sh` script as a privileged user:
168157

169158
```bash
170159
sudo ./install.sh
@@ -175,23 +164,26 @@ Follow the steps below for each of your VMs:
175164
but this might be a problem if you have limited space in `/var`
176165
or your company policy forbids you to install there. You can
177166
select a different directory for the K3s installation using the
178-
`--installation-dir` option with `install.sh` (or
179-
[`redis-di install`]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-install" >}})):
167+
`--installation-dir` option with `install.sh`:
180168

181169
```bash
182-
sudo ./install.sh --installation-dir <custom-directory-path>
170+
sudo ./install.sh --installation-dir <custom-installation-directory>
183171
```
184172
{{< /note >}}
185173

186-
RDI uses a database on your Redis Enterprise cluster to store its state
187-
information.
174+
The RDI installer collects all necessary configuration details and alerts you to potential issues,
175+
offering options to abort, apply fixes, or provide additional information.
176+
Once complete, it guides you through creating secrets and setting up your pipeline.
188177

189-
The installer gives you instructions to help you create secrets and create your pipeline.
190-
It will ask you for cluster admin credentials during installation.
178+
{{< note >}}It is strongly recommended to specify a hostname rather than an IP address for
179+
connecting to your RDI database, for the following reasons:
191180

192-
Use the Redis console to create the RDI database with the following requirements:
193-
194-
{{< embed-md "rdi-db-reqs.md" >}}
181+
- Any DNS resolution issues will be detected during the installation rather than
182+
later during pipeline deployment.
183+
- If you use TLS, your RDI database CA certificate must contain the hostname you specified
184+
either as a common name (CN) or as a subject alternative name (SAN). CA certificates
185+
usually don't contain IP addresses.
186+
{{< /note >}}
195187
196188
{{< note >}}If you specify `localhost` as the address of the RDI database server during
197189
installation then the connection will fail if the actual IP address changes for the local
@@ -207,7 +199,7 @@ sudo service k3s restart
207199

208200
After the installation is finished, RDI is ready for use.
209201

210-
## Supply cloud DNS information
202+
### Supply cloud DNS information
211203

212204
{{< note >}}This section is only relevant if you are installing RDI
213205
on VMs in a cloud environment.
@@ -217,123 +209,49 @@ If you are using [Amazon Route 53](https://aws.amazon.com/route53/),
217209
[Google Cloud DNS](https://cloud.google.com/dns?hl=en), or
218210
[Azure DNS](https://azure.microsoft.com/en-gb/products/dns)
219211
then you must supply the installer with the nameserver IP address
220-
during installation (or with the `nameservers` property if you are
221-
using [Silent installation](#silent-installation)). The table below
222-
shows the appropriate IP address for each platform:
212+
during installation. The table below
213+
shows the appropriate IP address for each cloud provider:
223214

224215
| Platform | Nameserver IP |
225216
| :-- | :-- |
226217
| [Amazon Route 53](https://aws.amazon.com/route53/) | 169.254.169.253 |
227218
| [Google Cloud DNS](https://cloud.google.com/dns?hl=en) | 169.254.169.254 |
228219
| [Azure DNS](https://azure.microsoft.com/en-gb/products/dns) | 168.63.129.16 |
229220

230-
If you are planning to use Route 53, you should first check that your VPC
221+
If you are using Route 53, you should first check that your VPC
231222
is configured to allow it. See
232223
[DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/AmazonDNS-concepts.html#vpc-dns-support)
233224
in the Amazon docs for more information.
234225

235-
## "Silent" installation
236-
237-
You can use the
238-
[installer script](#installation-steps) or the
239-
[`redis-di install`]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-install" >}})
240-
command with the `--file` option (or the shorter version `-f`) to supply answers
241-
to the installer's questions automatically using properties from a
242-
[TOML](https://toml.io/en/) file:
243-
244-
```bash
245-
./install.sh --file silent.toml
246-
```
247-
248-
### Silent install example
249-
250-
The following TOML file example shows the properties for a typical
251-
silent install configuration:
252-
253-
```toml
254-
title = "RDI Silent Installer Config"
255-
256-
scaffold = true
257-
db_index = 4
258-
deploy_directory = "/opt/rdi/config"
259-
260-
# Upstream DNS servers. This is needed if the installer detects a DNS resolver
261-
# with a loopback address as an upstream DNS server.
262-
# nameservers = ["8.8.8.8", "8.8.4.4"]
263-
264-
# HTTPS port you want to expose the RDI API on, if different from 443.
265-
# https_port = 5443
266-
267-
[rdi.database]
268-
host = "localhost"
269-
port = 12001
270-
username = "username"
271-
password = "password"
272-
ssl = true
273-
274-
# Uncomment the properties in this section only if the RDI
275-
# database uses TLS/mTLS.
276-
# [rdi.database.certificates]
277-
# ca = "/home/ubuntu/rdi/certs/ca.crt"
278-
# cert = "/home/ubuntu/rdi/certs/client.crt"
279-
# key = "/home/ubuntu/rdi/certs/client.key"
280-
# passphrase = "foobar"
281-
```
282-
283-
The sections below describe the properties in more detail.
284-
285-
### Silent install properties
286-
287-
#### Root
288-
289-
| Property | Description |
290-
|-- |-- |
291-
| `title` | Text to identify the file. RDI doesn't use use this, so you can use any text you like. |
292-
| `scaffold` | Do you want to enable [scaffolding]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-scaffold" >}}) during the install? (true/false) |
293-
| `db_index` | Integer to specify the source database type for scaffolding. The options are 2 (MySQL/MariaDB), 3 (Oracle), 4 (PostgreSQL), and 5 (SQL Server). |
294-
| `deploy_directory` | Path to the directory where you want to store the RDI configuration. |
295-
| `nameservers` | Upstream DNS servers. This is needed if the installer detects a DNS resolver with a loopback address as an upstream DNS server (for example, `nameservers = ["8.8.8.8", "8.8.4.4"]`). |
296-
| `https_port` | HTTPS port you want to expose the RDI API on, if different from 443. |
297-
298-
#### `rdi.database`
299-
300-
Use the properties in this section to specify your RDI database.
301-
302-
| Property | Description |
303-
|-- |-- |
304-
| `host` | Hostname for the Redis database to store RDI state. |
305-
| `port` | Port for the RDI database. |
306-
| `username` | Username for the RDI database. |
307-
| `password` | Password for the RDI database. |
308-
| `ssl` | Is SSL enabled for the RDI database (true/false)? If this is false then RDI will ignore the settings in the [`rdi.database.certificates`](#rdidatabasecertificates) section. |
226+
### Installing with High Availability
309227

310-
#### `rdi.database.certificates`
228+
To install RDI with High Availability (HA), perform the [Installation steps](#installation-steps)
229+
on two different VMs. The first VM will automatically become the active (primary) instance,
230+
while the second VM will become the passive (secondary) one.
231+
When starting the RDI installation on the second VM, the installer will detect that the RDI
232+
database is already in use and ask you to confirm that you intend to install RDI with HA.
311233

312-
Use these properties only if the RDI database requires
313-
[TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) or
314-
[mTLS](https://en.wikipedia.org/wiki/Mutual_authentication#mTLS).
315-
You must also set `ssl` to `true` in the
316-
[`rdi.database`](#rdidatabase) section to enable these properties.
234+
After the installation is complete, you must set the source and target database secrets
235+
on both VMs as described in [Deploy a pipeline]({{< relref "/integrate/redis-data-integration/data-pipelines/deploy" >}}). If you use `redis-di` to deploy your configuration, you only need to do this on one of the VMs, not both.
317236

318-
| Property | Description |
319-
|-- |-- |
320-
| `ca` | Path to the CA certificate file. |
321-
| `cert` | Path to the client certificate file. |
322-
| `key` | Path to the key file. |
323-
| `passphrase` | Password for the private key (string). |
237+
In a High Availability setup, the RDI pipeline is only active on the primary instance (VM).
238+
The two RDI instances will use the RDI database for leader election. If the primary instance fails
239+
to renew the lease in the RDI database, it will lose the leadership and a failover to the secondary instance
240+
will take place. After the failover, the secondary instance will become the primary one,
241+
and the RDI pipeline will be active on that VM.
324242

325243
## Prepare your source database
326244

327-
You must also configure your source database to use the CDC connector. See the
245+
Before deploying a pipeline, you must configure your source database to enable CDC. See the
328246
[Prepare source databases]({{< relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs" >}})
329247
section to learn how to do this.
330248

331249
## Deploy a pipeline
332250

333251
When the installation is complete, and you have prepared the source database for CDC,
334-
you are ready to start using RDI. See the guides to
335-
[configuring]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines" >}}) and
336-
[deploying]({{< relref "/integrate/redis-data-integration/data-pipelines/deploy" >}})
252+
you are ready to start using RDI. See the guides on how to
253+
[configure]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines" >}}) and
254+
[deploy]({{< relref "/integrate/redis-data-integration/data-pipelines/deploy" >}})
337255
RDI pipelines for more information. You can also configure and deploy a pipeline
338256
using [Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}}).
339257

@@ -346,7 +264,7 @@ the uninstall script as a privileged user:
346264
sudo ./uninstall.sh
347265
```
348266

349-
The script will check you are sure before you proceed:
267+
The script will ask if you are sure before proceeding:
350268

351269
```
352270
This will uninstall RDI and its dependencies, are you sure? [y, N]

‎content/integrate/redis-data-integration/installation/upgrade.md

Lines changed: 62 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,23 @@ Follow the steps below to upgrade an existing
2222
[VM installation]({{< relref "/integrate/redis-data-integration/installation/install-vm" >}})
2323
of RDI:
2424

25-
1. Download the RDI installer from the
26-
[Redis download center](https://redis-enterprise-software-downloads.s3.amazonaws.com/redis-di/rdi-installation-1.6.7.tar.gz)
25+
1. Download the RDI installer from the [Redis download center](https://redis.io/downloads/)
2726
(in the *Modules, Tools & Integration* category) and extract it to your
2827
preferred installation folder.
2928

29+
```bash
30+
export RDI_VERSION=<version>
31+
wget https://redis-enterprise-software-downloads.s3.amazonaws.com/redis-di/rdi-installation-$RDI_VERSION.tar.gz
32+
tar -xvf rdi-installation-$RDI_VERSION.tar.gz
33+
```
34+
3035
1. Go to the installation folder:
3136

3237
```bash
3338
cd rdi_install/$RDI_VERSION
3439
```
3540

36-
1. Run the `upgrade` script as a privileged user. Note that you must pass
41+
1. Run the `upgrade.sh` script as a privileged user. Note that you must pass
3742
your RDI password to the script unless the password is empty.
3843

3944
```bash
@@ -43,7 +48,7 @@ of RDI:
4348
### Recovering from failure during a VM upgrade
4449

4550
If the previous version is v1.4.4 or later, go to the `rdi_install/<PREVIOUS_VERSION>`
46-
directory and run `sudo ./upgrade.sh`, as described in the section
51+
directory and run `sudo ./upgrade.sh` to revert to that version, as described in the section
4752
[Upgrading a VM installation](#upgrading-a-vm-installation) above.
4853

4954
If the version you are replacing is earlier than v1.4.4, follow these steps:
@@ -66,93 +71,94 @@ If the version you are replacing is earlier than v1.4.4, follow these steps:
6671
sudo redis-di upgrade --rdi-host <RDI_REDIS_HOST> --rdi-port <RDI_REDIS_PORT>
6772
```
6873

69-
{{< note >}}If the `collector-source` or the `processor` are not in the `Running` state during
74+
{{< note >}}If the `collector-source` or the `processor` pods are not in the `Running` state after
7075
the upgrade, you must run `redis-di deploy` and check again that they are both in the
7176
`Running` state.
7277
{{< /note >}}
7378

74-
### Upgrading a VM installation with High availability
79+
### Upgrading a VM installation with High Availability
7580

76-
If there is an active pipeline, the upgrade process will involve upgrading RDI on the active
77-
VM first which will cause downtime for the collector-source (see
78-
[Upgrade a VM installation](#upgrade-a-vm-installation) above). Afterwards, the passive
79-
VM will be upgraded. Switching over won't eliminate the downtime because switching between
80-
VMs also requires a about a minute of downtime.
81+
If there is an active pipeline, upgrade RDI on the active VM first.
82+
This will cause a short pipeline downtime of up to two minutes.
83+
Afterwards, upgrade RDI on the passive VM. This will not cause any downtime.
8184

8285
## Upgrading a Kubernetes installation
8386

8487
Follow the steps below to upgrade an existing
8588
[Kubernetes]({{< relref "/integrate/redis-data-integration/installation/install-k8s" >}})
8689
installation of RDI:
8790

88-
1. Download the new versions of the images, if you are using a private registry:
91+
1. If you are using a private registry, pull the new versions of all images listed in
92+
[Using a private image registry]({{< relref "/integrate/redis-data-integration/installation/install-k8s#using-a-private-image-registry" >}})
93+
and add them to your local registry.
94+
95+
1. Download the RDI Helm chart tar file from the [Redis download center](https://redis.io/downloads/)
96+
(in the *Modules, Tools & Integration* category).
8997

9098
```bash
91-
docker pull redis/rdi-processor:tagname
92-
docker pull redis/rdi-operator:tagname
93-
docker pull redis/rdi-api:tagname
94-
docker pull redis/rdi-monitor:tagname
95-
docker pull redis/rdi-collector-initializer
96-
docker pull redis/rdi-collector-api
99+
export RDI_VERSION=<version>
100+
wget https://redis-enterprise-software-downloads.s3.amazonaws.com/redis-di/rdi-$RDI_VERSION.tgz
97101
```
98102

99-
1. Download the RDI helm chart tar file from the
100-
[Redis download center](https://redis-enterprise-software-downloads.s3.amazonaws.com/redis-di/rdi-1.6.7.tgz).
103+
1. Adapt your `rdi-values.yaml` file to any changes in the new RDI version if needed.
104+
See also [Upgrading to RDI 1.8.0 or later from an earlier version](#upgrading-to-rdi-180-or-later-from-an-earlier-version).
105+
Before making any changes, save your existing `rdi-values.yaml` if you need to revert
106+
to the old RDI version for any reason.
101107

102108
1. Run the `helm upgrade` command:
103109

104110
```bash
105-
helm upgrade [RELEASE_NAME] [CHART]
111+
helm upgrade --install rdi rdi-<tag>.tar.gz -f rdi-values.yaml -n rdi
106112
```
107113

108-
Note that you don't need to
109-
[deploy]({{< relref "/integrate/redis-data-integration/data-pipelines/deploy" >}})
110-
again after this step.
114+
Note that you don't need to
115+
[deploy]({{< relref "/integrate/redis-data-integration/data-pipelines/deploy" >}})
116+
the RDI configuration again after this step.
111117
112-
### Verifying the upgrade
113-
114-
Check the upgrade with the following command:
118+
### Upgrading to RDI 1.8.0 or later from an earlier version
115119
116-
```bash
117-
sudo k3s kubectl get all -n <namespace>
118-
```
120+
When upgrading to RDI 1.8.0 or later from an earlier version
121+
you must adapt your `rdi-values.yaml` file to the following changes:
119122
120-
You should find that all the pods are running (they will have `1/1` in the `READY` column of the
121-
command's output).
122-
Check for any pods that don't have `1/1` in the `READY` column (which is the second
123-
column). For example, the pod below has `0/1` in the second column, which indicates the
124-
deployment hasn't worked:
123+
- All collector and processor values that were previously under `collector`,
124+
`collectorSourceMetricsExporter`, and `processor` have been moved to
125+
`operator.dataPlane.collector` and `operator.dataPlane.processor`.
126+
- `global.collectorApiEnabled` has been moved to `operator.dataPlane.collectorApi.enabled`,
127+
and is now a boolean value, not `"0"` or `"1"`.
128+
- `api.authEnabled` is also now a boolean value, not `"0"` or `"1"`.
129+
- The following values have been deprecated: `rdiMetricsExporter.service.protocol`,
130+
`rdiMetricsExporter.service.port`, `rdiMetricsExporter.serviceMonitor.path`,
131+
`api.service.name`.
125132
126-
```bash
127-
<pod_name> 0/1 CrashLoopBackOff 1881 (91s ago) 6d17h
128-
```
133+
### Verifying the upgrade
129134
130-
You can also check that the latest version is running using the following command on one of
131-
the pods:
135+
Check that all pods have `Running` status:
132136
133137
```bash
134-
sudo k3s kubectl describe <pod_name> -n <namespace>
138+
kubectl get all -n rdi
135139
```
136140
137-
Search for the image tag `Image: docker.io/redis/<pod_name>:<version/image_tag>`
138-
in the command's output to verify the version.
139-
140-
If you find that the upgrade hasn't worked for any reason, then run the `helm upgrade`
141-
command again (as described in the section
141+
If you find that the upgrade did not work as expected for any reason,
142+
then run the `helm upgrade` command again (as described in the section
142143
[Upgrading a Kubernetes installation](#upgrading-a-kubernetes-installation) above),
143-
but this time with the previous version you were upgrading from. This will restore your
144-
previous working state.
144+
but this time with the previous version you were upgrading from, and using
145+
your saved `rdi-values.yaml` for that version. This will restore your previous working state.
146+
147+
{{< note >}}Downgrading from RDI 1.8.0 or later to an earlier version using `helm upgrade`
148+
will not work. If you need to perform such an upgrade, uninstall RDI completely first as
149+
described in [Uninstall RDI]({{< relref "/integrate/redis-data-integration/installation/install-k8s#uninstall-rdi" >}}),
150+
and then install the old version.
151+
{{< /note >}}
145152
146153
## What happens during the upgrade?
147154
148-
The upgrade process replaces the current RDI components with the new versions:
155+
The upgrade process replaces the current RDI components with their new versions:
149156
150157
- Firstly, the control plane components are replaced. At this point, the pipeline
151158
is still active but monitoring will be disconnected.
152-
153-
- Secondly, the pipeline data path components are replaced with the new versions.
154-
If a pipeline is active while upgrading, the `collector-source` will be restarted
155-
as a result of restarting the `collector-initializer`. The pipeline will pause for
156-
about two minutes but it will catch up very quickly after restarting.
157-
The pipeline data and state are both stored in Redis, so data will never normally
158-
be lost during the downtime while upgrading.
159+
- Secondly, the pipeline data plane components are replaced.
160+
If a pipeline is active while upgrading, the `collector-source` and `processor`
161+
pods will be restarted. The pipeline will pause for up to two minutes but it
162+
will catch up very quickly after restarting.
163+
The pipeline data and state are both stored in Redis, so data will not
164+
be lost during the upgrade.

‎content/integrate/redis-data-integration/quick-start-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ RDI will create the pipeline template for your chosen source database type at
5050
(see [Prepare the pipeline](#prepare-the-pipeline) below).
5151

5252
At the end of the installation, RDI CLI will prompt you to set the access secrets
53-
for both the source PostgreSQL database and the Redis RDI database. RDI needs these to
53+
for both the source PostgreSQL database and the target Redis database. RDI needs these to
5454
run the pipeline.
5555

56-
Use the Redis console to create the RDI database with the following requirements:
56+
Use the Redis Enterprise Cluster Manager UI to create the RDI database with the following requirements:
5757

5858
{{< embed-md "rdi-db-reqs.md" >}}
5959

@@ -90,7 +90,7 @@ To create a context, use the
9090
command:
9191

9292
```bash
93-
redis-di add-context --rdi-host <host> --rdi-port <port> --cluster-host <Redis DB host> --cluster-api-port <Redis DB API port> --cluster-user <Redis DB username> <unique-context-name>
93+
redis-di add-context --rdi-host <host> --rdi-port <port> <unique-context-name>
9494
```
9595

9696
These options are required but there are also a few others you can save, such as TLS credentials, if
@@ -113,7 +113,7 @@ contexts.
113113

114114
You can use [Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}})
115115
to deploy the pipeline by adding a connection to the RDI API
116-
endpoint (which has the same IP address as your RDI VM and uses port 8083) and then clicking the **Deploy** button. You can also deploy it with the following command:
116+
endpoint (which has the same hostname or IP address as your RDI VM and uses the default HTTPS port 443) and then clicking the **Deploy** button. You can also deploy it with the following command:
117117

118118
```bash
119119
redis-di deploy --dir <path to pipeline folder>
@@ -148,4 +148,4 @@ To see the RDI pipeline working in CDC mode:
148148
- Run
149149
[`redis-di status --live`]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-status" >}})
150150
to see the flow of records.
151-
- User [Redis Insight]({{< relref "/develop/tools/insight" >}}) to look at the data in the target database.
151+
- Use [Redis Insight]({{< relref "/develop/tools/insight" >}}) to look at the data in the target database.

0 commit comments

Comments
 (0)
Please sign in to comment.