在 VM 上安装

了解如何在一个或多个 VM 上安装 RDI

本指南介绍如何在一个或多个 VM 上安装 Redis 数据集成 （RDI） 并将其与 您的源数据库。您还可以在 Kubernetes 上安装 RDI。

注意：
我们建议您始终使用最新版本，即 RDI 1.6.3 版 .

硬件大小调整

RDI 主要受 CPU 和网络限制。 每个 RDI VM 至少应具有：

  • CPU：至少 4 个 CPU 内核。您应该考虑添加 2-6 个额外的内核（如果您的数据集很大并且您想要摄取 baseline 快照。
  • 内存：2GB
  • 磁盘：25GB，包括 OS 占用空间。特别 RDI 需要 7GB 内存/var和 1GB/opt文件夹（将 存储日志文件）。
  • 网络接口：10GB 或更大。

在 VM 上安装 RDI

您通常会在两个 VM 上安装 RDI 以实现高可用性 （HA），但您也可以安装 如果您不需要，则只有一个 VM。例如，在 开发和测试。

注意：

您无法在 Redis Enterprise 集群所在的主机上安装 RDI 由于网络规则不兼容，也会安装。如果要在 host 之前用于 Redis Enterprise，那么您必须 用iptables自 在安装之前使用以下命令行 “clean” 主机：

 sudo iptables-save | awk '/^[*]/ { print $1 } 
                     /^:[A-Z]+ [^-]/ { print $1 " ACCEPT" ; }
                     /COMMIT/ { print $0; }' | sudo iptables-restore

You may encounter problems if you use iptables v1.6.1 and earlier in nftables mode. Use iptables versions later than v1.6.1 or enable the iptables legacy mode with the following commands:

update-alternatives --set iptables /usr/sbin/iptables-legacy
update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy

Also, iptables versions 1.8.0-1.8.4 have known issues that can prevent RDI from working, especially on RHEL 8. Ideally, use iptables v1.8.8, which is known to work correctly with RDI.

The supported OS versions for RDI are:

  • RHEL 8 & 9
  • Ubuntu 20.04, 22.04, and 24.04

You must run the RDI installer as a privileged user because it installs containerd and registers services. However, you don't need any special privileges to run RDI processes for normal operation.

RDI has a few requirements for cloud VMs that you must implement before running the RDI installer, or else installation will fail. The following sections give full pre-installation instructions for RHEL and Ubuntu.

RHEL

We recommend you turn off firewalld before installation using the command:

systemctl disable firewalld --now

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

firewall-cmd --permanent --add-port=6443/tcp #apiserver
firewall-cmd --permanent --zone=trusted --add-source=10.42.0.0/16 #pods
firewall-cmd --permanent --zone=trusted --add-source=10.43.0.0/16 #services
firewall-cmd --reload

You should also add port rules for all the RDI services you intend to use:

firewall-cmd --permanent --add-port=8080/tcp  # (Required) rdi-operator/rdi-api
firewall-cmd --permanent --add-port=9090/tcp  # vm-dis-reloader
firewall-cmd --permanent --add-port=9092/tcp  # prometheus-service
firewall-cmd --permanent --add-port=9121/tcp  # rdi-metric-exporter
Note:
You may also need to add similar rules to open other ports if your setup requires them.

If you have nm-cloud-setup.service enabled, you must disable it and reboot the node with the following commands:

systemctl disable nm-cloud-setup.service nm-cloud-setup.timer
reboot

Ubuntu

We recommend you turn off Uncomplicated Firewall (ufw) before installation with the command:

sudo ufw disable

However, if you do need to use ufw, you must add the following rules:

ufw allow 6443/tcp #apiserver
ufw allow from 10.42.0.0/16 to any #pods
ufw allow from 10.43.0.0/16 to any #services

You should also add port rules for all the RDI services you intend to use:

ufw allow 8080/tcp  # (Required) rdi-operator/rdi-api
ufw allow 9090/tcp  # vm-dis-reloader
ufw allow 9092/tcp  # prometheus-service
ufw allow 9121/tcp  # rdi-metric-exporter
Note:
You may also need to add similar rules to open other ports if your setup requires them.

Installation steps

Follow the steps below for each of your VMs:

  1. Download the RDI installer from the Redis download center (from the Modules, Tools & Integration category) and extract it to your preferred installation folder.

  2. Go to the installation folder:

    cd rdi_install/$RDI_VERSION

  3. Run the installer as a privileged user:

    sudo ./install.sh
    Note:

    RDI uses K3s as part of its implementation. By default, the installer installs K3s in the /var/lib directory, but this might be a problem if you have limited space in /var or your company policy forbids you to install there. You can select a different directory for the K3s installation using the --installation-dir option with install.sh (or redis-di install):

    ```bash
sudo ./install.sh --installation-dir <custom-directory-path>
```

RDI uses a database on your Redis Enterprise cluster to store its state information. This requires Redis Enterprise v6.4 or greater.

The installer gives you instructions to help you create secrets and create your pipeline. It will ask you for cluster admin credentials during installation.

Use the Redis console to create the RDI database with the following requirements:

  • 250MB RAM with one primary and one replica.

  • If you are deploying RDI for a production environment then secure this database with a password and TLS.

  • Provide the installation with the required RDI database details.

  • Set the database's eviction policy to noeviction. Note that you can't set this using rladmin, so you must either do it using the admin UI or with the following REST API command:

    curl -v -k -d '{"eviction_policy": "noeviction"}' \
  -u '<USERNAME>:<PASSWORD>' \
  -H "Content-Type: application/json" \
  -X PUT https://<CLUSTER_FQDN>:9443/v1/bdbs/<BDB_UID>

  • Set the database's data persistence to AOF - fsync every 1 sec. Note that you can't set this using rladmin, so you must either do it using the admin UI or with the following REST API commands:

    curl -v -k -d '{"data_persistence":"aof"}' \
  -u '<USERNAME>:<PASSWORD>' \
  -H "Content-Type: application/json" 
  -X PUT https://<CLUSTER_FQDN>:9443/v1/bdbs/<BDB_UID>
curl -v -k -d '{"aof_policy":"appendfsync-every-sec"}' \
  -u '<USERNAME>:<PASSWORD>' \
  -H "Content-Type: application/json" \
  -X PUT https://<CLUSTER_FQDN>:9443/v1/bdbs/<BDB_UID>

  • Ensure that the RDI database is not clustered. RDI will not work correctly if the RDI database is clustered, but it is OK for the target database to be clustered.

Note:

If you specify localhost as the address of the RDI database server during installation then the connection will fail if the actual IP address changes for the local VM. For this reason, we recommend that you don't use localhost for the address. However, if you do encounter this problem, you can fix it using the following commands on the VM that is running RDI itself:

sudo k3s kubectl delete nodes --all
sudo service k3s restart

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

Supply cloud DNS information

Note:
This section is only relevant if you are installing RDI on VMs in a cloud environment.

If you are using Amazon Route 53, Google Cloud DNS, or Azure DNS then you must supply the installer with the nameserver IP address during installation (or with the nameservers property if you are using Silent installation). The table below shows the appropriate IP address for each platform:

Platform Nameserver IP
Amazon Route 53 169.254.169.253
Google Cloud DNS 169.254.169.254
Azure DNS 168.63.129.16

If you are planning to use Route 53, you should first check that your VPC is configured to allow it. See DNS attributes in your VPC in the Amazon docs for more information.

"Silent" installation

You can use the installer script or the redis-di install command with the --file option (or the shorter version -f) to supply answers to the installer's questions automatically using properties from a TOML file:

./install.sh --file silent.toml

Silent install example

The following TOML file example shows the properties for a typical silent install configuration:

title = "RDI Silent Installer Config"

scaffold = true
db_index = 4
deploy_directory = "/opt/rdi/config"

# Upstream DNS servers. This is needed if the installer detects a DNS resolver 
# with a loopback address as an upstream DNS server.
# nameservers = ["8.8.8.8", "8.8.4.4"]

# HTTPS port you want to expose the RDI API on, if different from 443.
# https_port = 5443

[rdi.database]
host = "localhost"
port = 12001
username = "username"
password = "password"
ssl = true

# Uncomment the properties in this section only if the RDI
# database uses TLS/mTLS.
# [rdi.database.certificates]
# ca = "/home/ubuntu/rdi/certs/ca.crt"
# cert = "/home/ubuntu/rdi/certs/client.crt"
# key = "/home/ubuntu/rdi/certs/client.key"
# passphrase = "foobar"

The sections below describe the properties in more detail.

Silent install properties

Root

Property Description
title Text to identify the file. RDI doesn't use use this, so you can use any text you like.
scaffold Do you want to enable scaffolding during the install? (true/false)
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).
deploy_directory Path to the directory where you want to store the RDI configuration.
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"]).
https_port HTTPS port you want to expose the RDI API on, if different from 443.

rdi.database

Use the properties in this section to specify your RDI database.

Property Description
host Hostname for the Redis database to store RDI state.
port Port for the RDI database.
username Username for the RDI database.
password Password for the RDI database.
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 section.

rdi.database.certificates

Use these properties only if the RDI database requires TLS or mTLS. You must also set ssl to true in the rdi.database section to enable these properties.

Property Description
ca Path to the CA certificate file.
cert Path to the client certificate file.
key Path to the key file.
passphrase Password for the private key (string).

Prepare your source database

You must also configure your source database to use the CDC connector. See the Prepare source databases section to learn how to do this.

Deploy a pipeline

When the installation is complete, and you have prepared the source database for CDC, you are ready to start using RDI. See the guides to configuring and deploying RDI pipelines for more information. You can also configure and deploy a pipeline using Redis Insight.

Uninstall RDI

If you want to remove your RDI installation, go to the installation folder and run the uninstall script as a privileged user:

sudo ./uninstall.sh

The script will check you are sure before you proceed:

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

If you type anything other than "y" here, the script will abort without making any changes to RDI or your source database.

RATE THIS PAGE
Back to top ↑