Skip to content

RC RDI: Some typo fixes, scraping RDI metrics, and behavior fixes #1750

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.

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 12 commits into from
Jun 30, 2025
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ type: integration
weight: 2
---

Follow the steps in the sections below to prepare an [AWS Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_GettingStartedAurora.CreatingConnecting.Aurora.html) or [AWS RDS MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html) database.
database to work with RDI.
Follow the steps in the sections below to prepare an [AWS Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_GettingStartedAurora.CreatingConnecting.Aurora.html) or [AWS RDS MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html) database to work with RDI.

## Create and apply parameter group

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ weight: 3

Follow the steps in the sections below to prepare a [Microsoft SQL Server on AWS RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.SQLServer.html) database to work with RDI.

{{< note >}}
Change Data Capture (CDC) is not supported on SQL Server Express Edition. Only the Standard, Enterprise, and Developer editions support CDC and are supported by RDI.
{{< /note >}}

## Create the Debezium user

The Debezium connector needs a user account to connect to SQL Server. This
Expand Down
5 changes: 5 additions & 0 deletions content/operate/rc/databases/rdi/define.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo

1. In the **Pipeline definition** section, select the Redis data type to write keys to the target. You can choose **Hash** or **JSON** if the target database supports JSON.
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The pipeline definition screen." width=75% >}}

You can also supply one or more [transformation job files]({{< relref "/integrate/redis-data-integration/data-pipelines/transform-examples" >}}) that specify how you want to transform the captured data before writing it to the target. Select **Upload jobs** to upload your job files.

{{<image filename="images/rc/rdi/rdi-transformation-jobs.png" alt="The transformation jobs section. Select Upload jobs to upload transformation jobs." >}}

Select **Continue**.
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}

Expand Down
51 changes: 31 additions & 20 deletions content/operate/rc/databases/rdi/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,28 @@ See the [RDI architecture overview]({{< relref "/integrate/redis-data-integratio

To ensure that you can connect your Redis Cloud database to the source database, you need to set up an endpoint service through AWS PrivateLink.

Choose the steps for your database setup:
- [Database hosted on an AWS EC2 instance](#database-hosted-on-an-aws-ec2-instance)
- [Database hosted on AWS RDS or AWS Aurora](#database-hosted-on-aws-rds-or-aws-aurora)
The following diagrams show the network setup for the different database setups:

### Database hosted on an AWS EC2 instance
- Database hosted on an AWS EC2 instance:

The following diagram shows the network setup for a database hosted on an AWS EC2 instance.
{{<image filename="images/rc/rdi/rdi-setup-diagram-ec2.png" alt="The network setup for a database hosted on an AWS EC2 instance." width=80% >}}

{{<image filename="images/rc/rdi/rdi-setup-diagram-ec2.png" alt="The network setup for a database hosted on an AWS EC2 instance." width=75% >}}
- Database hosted on AWS RDS or AWS Aurora:

To do this:
{{<image filename="images/rc/rdi/rdi-setup-diagram-aurora.png" alt="The network setup for a database hosted on AWS RDS or AWS Aurora." width=80% >}}

Select the steps for your database setup.

{{< multitabs id="rdi-cloud-connectivity"
tab1="EC2 instance"
tab2="AWS RDS or Aurora" >}}

To set up PrivateLink for a database hosted on an EC2 instance:

1. [Create a network load balancer](#create-network-load-balancer-ec2) that will route incoming HTTP requests to your database.
1. [Create an endpoint service](#create-endpoint-service-ec2) through AWS PrivateLink.

#### Create network load balancer {#create-network-load-balancer-ec2}
### Create network load balancer {#create-network-load-balancer-ec2}

In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Compute** > **EC2**. [Create a network load balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-network-load-balancer.html#configure-load-balancer) with the following settings:

Expand All @@ -81,7 +87,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
- **Target type**: Select **Instances**.
- **Protocol : Port**: Select **TCP**, and then enter the port number where your database is exposed.
- The **IP address type** and **VPC** should be selected already and match the VPC you selected earlier.
1. In **Register targets**, select the EC2 instance that runs your source database, enter the port, and select **Include as pending below**. Then, select **Create target group** to create your target group. Return **Listeners and routing** in the Network Load Balancer setup.
1. In **Register targets**, select the EC2 instance that runs your source database, enter the port, and select **Include as pending below**. Then, select **Create target group** to create your target group. Return to **Listeners and routing** in the Network Load Balancer setup.
1. Set the following **Listener** properties:
- **Protocol**: Select **TCP**.
- **Port**: Enter your source database's port.
Expand All @@ -93,7 +99,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
- **Source**: Select **Anywhere - IPv4**.
Select **Save rules** to save your changes.

#### Create endpoint service {#create-endpoint-service-ec2}
### Create endpoint service {#create-endpoint-service-ec2}

In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Networking & Content Delivery** > **VPC**. There, select **PrivateLink and Lattice** > **Endpoint services**. [Create an endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) with the following settings:

Expand All @@ -113,23 +119,26 @@ After you create the endpoint service, you need to add Redis Cloud as an Allowed

For more details on AWS PrivateLink, see [Share your services through AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html).

### Database hosted on AWS RDS or AWS Aurora

The following diagram shows the network setup for a database hosted on AWS RDS or AWS Aurora.
--tab-sep--

{{<image filename="images/rc/rdi/rdi-setup-diagram-aurora.png" alt="The network setup for a database hosted on AWS RDS or AWS Aurora." width=75% >}}

To do this:
To set up PrivateLink for a database hosted on AWS RDS or AWS Aurora:

1. [Create an RDS Proxy](#create-rds-proxy) that will route requests to your database.
1. [Create a network load balancer](#create-network-load-balancer-rds) that will route incoming HTTP requests to the RDS proxy.
1. [Create an endpoint service](#create-endpoint-service-rds) through AWS PrivateLink.

#### Create RDS proxy {#create-rds-proxy}
### Create RDS proxy {#create-rds-proxy}

In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Database** > **Aurora and RDS**. [Create an RDS proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-creating.html) that can access your database.

#### Create network load balancer {#create-network-load-balancer-rds}
The Proxy's IAM role must have the following permissions to access the database using the credentials secret and encryption key:
- `secretsmanager:GetSecretValue`
- `secretsmanager:DescribeSecret`
- `kms:Decrypt`

You can set the proxy's IAM role during creation in the **Authentication** section.

### Create network load balancer {#create-network-load-balancer-rds}

In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Compute** > **EC2**. [Create a network load balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-network-load-balancer.html#configure-load-balancer) with the following settings:

Expand All @@ -144,7 +153,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
- **Target type**: Select **IP Addresses**.
- **Protocol : Port**: Select **TCP**, and then enter the port number where your database is exposed.
- The **IP address type** and **VPC** should be selected already and match the VPC you selected earlier.
1. In **Register targets**, enter the static IP address of your RDS proxy, enter the port, and select **Include as pending below**. Then, select **Create target group** to create your target group. Return **Listeners and routing** in the Network Load Balancer setup.
1. In **Register targets**, enter the static IP address of your RDS proxy, enter the port, and select **Include as pending below**. Then, select **Create target group** to create your target group. Return to **Listeners and routing** in the Network Load Balancer setup.
To get the static IP address of your RDS Proxy, run the following command on an EC2 instance in the same VPC as the Proxy:
```sh
$ nslookup <proxy-endpoint>
Expand All @@ -161,7 +170,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
- **Source**: Select **Anywhere - IPv4**.
Select **Save rules** to save your changes.

#### Create endpoint service {#create-endpoint-service-rds}
### Create endpoint service {#create-endpoint-service-rds}

In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Networking & Content Delivery** > **VPC**. There, select **PrivateLink and Lattice** > **Endpoint services**. [Create an endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) with the following settings:

Expand All @@ -181,6 +190,8 @@ After you create the endpoint service, you need to add Redis Cloud as an Allowed

For more details on AWS PrivateLink, see [Share your services through AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html).

{{< /multitabs >}}

## Share source database credentials

You need to share your source database credentials and certificates in an Amazon secret with Redis Cloud so that the pipeline can connect to your database.
Expand Down
10 changes: 10 additions & 0 deletions content/operate/rc/databases/rdi/view-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,16 @@ At this point, the data pipeline will apply the changes. If you selected **Reset

If you selected **Apply to new data changes only**, the data pipeline will enter the *change streaming* phase without ingesting data.

## View metrics endpoints

You can use [Prometheus and Grafana]({{< relref "/integrate/prometheus-with-redis-cloud/" >}}) to track and display metrics for the data pipeline.

To view the metrics endpoints for the source collector and pipeline processor, go to the **Data pipeline** tab and select **More actions**, and then **Show metrics**. You can add these endpoints as Prometheus targets to start tracking your RDI metrics.

Prometheus endpoints are exposed on Redis Cloud's internal network. To access this network, enable [VPC peering]({{< relref "/operate/rc/security/vpc-peering" >}}) or [AWS Transit Gateway]({{< relref "/operate/rc/security/aws-transit-gateway" >}}). See [Prometheus and Grafana with Redis Cloud]({{< relref "/integrate/prometheus-with-redis-cloud/" >}}) for more information.

For more information about available RDI metrics, see [Observability]({{< relref "/integrate/redis-data-integration/observability" >}}).

## Reset data pipeline

Resetting the data pipeline creates a new baseline snapshot from the current state of your source database, and re-processes the data from the source database to the target Redis database. You may want to reset the pipeline if the source and target databases were disconnected or you made large changes to the data pipeline.
Expand Down
Binary file modified static/images/rc/rdi/rdi-start-pipeline-setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/rc/rdi/rdi-transformation-jobs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.