Skip to content

Commit b1eb09b

Browse files
committed
RC RDI: Update screenshots and add specific steps for RDS/Aurora
1 parent d625457 commit b1eb09b

29 files changed

+111
-28
lines changed

content/operate/rc/databases/rdi/define.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,8 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
5757

5858
### Configure a new pipeline
5959

60-
1. In the [Redis Cloud console](https://cloud.redis.io/), go to your target database and select the **Data Pipeline** tab. If your pipeline is already provisioned, select **Complete setup** to go to the **Pipeline definition** section.
60+
1. In the [Redis Cloud console](https://cloud.redis.io/), go to your target database and select the **Data Pipeline** tab. If your pipeline is already provisioned, select **Complete setup** to go to the **Select data** section.
6161
{{<image filename="images/rc/rdi/rdi-complete-setup.png" alt="The complete setup button." width=200px >}}
62-
1. For the **Configure a new pipeline** option, select the Redis data type to write keys to the target. You can choose **Hash** or **JSON** if the target database supports JSON.
63-
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The Pipeline definition screen. Configure a new pipeline is selected." width=75% >}}
64-
Select **Continue**.
65-
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
6662
1. Select the Schema and Tables you want to migrate to the target database from the **Source data selection** list.
6763
{{<image filename="images/rc/rdi/rdi-select-source-data.png" alt="The select source data section. " width=75% >}}
6864

@@ -87,6 +83,11 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
8783
After you've selected the schemas and tables you want to sync, select **Continue**.
8884
8985
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
86+
87+
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.
88+
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The pipeline definition screen." width=75% >}}
89+
Select **Continue**.
90+
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
9091
9192
1. Review the tables you selected in the **Summary**. If everything looks correct, select **Start ingest** to start ingesting data from your source database.
9293

content/operate/rc/databases/rdi/setup.md

+87-10
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ categories:
55
- docs
66
- operate
77
- rc
8-
description: Prepare your source database and database credentials for Data integration.
8+
description: Prepare your source database, network setup, and database credentials for Data integration.
99
hideListLinks: true
1010
weight: 1
1111
---
@@ -38,18 +38,31 @@ See [Prepare source databases]({{<relref "/integrate/redis-data-integration/data
3838
- [MySQL and mariaDB]({{<relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs/my-sql-mariadb">}})
3939
- [Oracle]({{<relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs/oracle">}})
4040
- [SQL Server]({{<relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs/sql-server">}})
41-
- [AWS Aurora and PostgreSQL]({{<relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs/postgresql">}})
41+
- [AWS Aurora PostgreSQL]({{<relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs/aws-aur-pgsql">}})
42+
- [AWS RDS PostgreSQL]({{<relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs/postgresql">}})
4243

4344
See the [RDI architecture overview]({{< relref "/integrate/redis-data-integration/architecture#overview" >}}) for more information about CDC.
4445

4546
## Set up connectivity
4647

47-
To ensure that you can connect your Redis Cloud database to the source database hosted on an AWS EC2 instance, you need to set up an endpoint service through AWS PrivateLink. To do this:
48+
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.
4849

49-
1. [Create a network load balancer](#create-network-load-balancer) that will route incoming HTTP requests to your database.
50-
1. [Create an endpoint service](#create-endpoint-service) through AWS PrivateLink.
50+
Choose the steps for your database setup:
51+
- [Database hosted on an AWS EC2 instance](#database-hosted-on-an-aws-ec2-instance)
52+
- [Database hosted on AWS RDS or AWS Aurora](#database-hosted-on-aws-rds-or-aws-aurora)
5153

52-
### Create network load balancer
54+
### Database hosted on an AWS EC2 instance
55+
56+
The following diagram shows the network setup for a database hosted on an AWS EC2 instance.
57+
58+
{{<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% >}}
59+
60+
To do this:
61+
62+
1. [Create a network load balancer](#create-network-load-balancer-ec2) that will route incoming HTTP requests to your database.
63+
1. [Create an endpoint service](#create-endpoint-service-ec2) through AWS PrivateLink.
64+
65+
#### Create network load balancer {#create-network-load-balancer-ec2}
5366

5467
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:
5568

@@ -67,7 +80,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
6780
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.
6881
1. Set the following **Listener** properties:
6982
- **Protocol**: Select **TCP**.
70-
- **Port**: Enter **80**.
83+
- **Port**: Enter your source database's port.
7184
- **Default action**: Select the target group you created in the previous step.
7285
1. Review the network load balancer settings, and then select **Create load balancer** to continue.
7386
1. After the network load balancer is active, select **Security**, and then select the security group ID to open the Security group settings.
@@ -76,11 +89,76 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
7689
- **Source**: Select **Anywhere - IPv4**.
7790
Select **Save rules** to save your changes.
7891

79-
### Create endpoint service
92+
#### Create endpoint service {#create-endpoint-service-ec2}
8093

8194
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:
8295

83-
1. In **Available load balancers**, select the [network load balancer](#create-network-load-balancer) you created.
96+
1. In **Available load balancers**, select the [network load balancer](#create-network-load-balancer-ec2) you created.
97+
1. In **Additional settings**, choose the following settings:
98+
- **Require acceptance for endpoint**: Select **Acceptance required**.
99+
- **Supported IP address types**: Select **IPv4**.
100+
1. Select **Create** to create the endpoint service.
101+
102+
After you create the endpoint service, you need to add Redis Cloud as an Allowed Principal on your [endpoint service VPC permissions](https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#add-remove-permissions).
103+
104+
1. In the Redis Cloud Console, copy the Amazon Resource Name (ARN) provided in the **Setup connectivity** section.
105+
1. Return to the endpoint service list on the [Amazon VPC console](https://console.aws.amazon.com/vpc/). Select the endpoint service you just created.
106+
1. Navigate to **Allow principals** tab.
107+
1. Add the Redis Cloud ARN you copied and choose **Allow principals**.
108+
1. Save the service name for later.
109+
110+
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).
111+
112+
### Database hosted on AWS RDS or AWS Aurora
113+
114+
The following diagram shows the network setup for a database hosted on AWS RDS or AWS Aurora.
115+
116+
{{<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% >}}
117+
118+
To do this:
119+
120+
1. [Create an RDS Proxy](#create-rds-proxy) that will route requests to your database.
121+
1. [Create a network load balancer](#create-network-load-balancer-rds) that will route incoming HTTP requests to the RDS proxy.
122+
1. [Create an endpoint service](#create-endpoint-service-rds) through AWS PrivateLink.
123+
124+
#### Create RDS proxy {#create-rds-proxy}
125+
126+
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.
127+
128+
<--! TODO: HOW TO GET THE STATIC IP -->
129+
130+
#### Create network load balancer {#create-network-load-balancer-rds}
131+
132+
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:
133+
134+
1. In **Basic configuration**:
135+
- **Scheme**: Select **Internal**.
136+
- **Load balancer IP address type**: Select **IPv4**.
137+
1. In **Network mapping**, select the VPC and availability zone associated with your source database.
138+
1. In **Security groups**, select the security group associated with your source database.
139+
1. In **Listeners and routing**:
140+
1. Select **Create target group** to [create a target group](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-target-group.html) with the following settings:
141+
1. In **Specify group details**:
142+
- **Target type**: Select **IP Addresses**.
143+
- **Protocol : Port**: Select **TCP**, and then enter the port number where your database is exposed.
144+
- The **IP address type** and **VPC** should be selected already and match the VPC you selected earlier.
145+
1. In **Register targets**, enter the static IP 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.
146+
1. Set the following **Listener** properties:
147+
- **Protocol**: Select **TCP**.
148+
- **Port**: Enter your source database's port.
149+
- **Default action**: Select the target group you created in the previous step.
150+
1. Review the network load balancer settings, and then select **Create load balancer** to continue.
151+
1. After the network load balancer is active, select **Security**, and then select the security group ID to open the Security group settings.
152+
1. Select **Edit inbound rules**, then **Add rule** to add a rule with the following settings:
153+
- **Type**: Select **HTTP**.
154+
- **Source**: Select **Anywhere - IPv4**.
155+
Select **Save rules** to save your changes.
156+
157+
#### Create endpoint service {#create-endpoint-service-rds}
158+
159+
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:
160+
161+
1. In **Available load balancers**, select the [network load balancer](#create-network-load-balancer-rds) you created.
84162
1. In **Additional settings**, choose the following settings:
85163
- **Require acceptance for endpoint**: Select **Acceptance required**.
86164
- **Supported IP address types**: Select **IPv4**.
@@ -159,7 +237,6 @@ If your source database has TLS or mTLS enabled, we recommend that you enter the
159237

160238
After you store this secret, you can view and copy the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources) of your secret on the secret details page.
161239

162-
163240
## Next steps
164241

165242
After you have set up your source database and prepared connectivity and credentials, select **Define source database** to [define your source connection and data pipeline]({{<relref "/operate/rc/databases/rdi/define">}}).

content/operate/rc/databases/rdi/view-edit.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
---
2-
Title: View data pipeline
2+
Title: View and edit data pipeline
33
alwaysopen: false
44
categories:
55
- docs
66
- operate
77
- rc
8-
description: Observe and stop your data pipeline.
8+
description: Observe and change your data pipeline.
99
hideListLinks: true
1010
weight: 3
1111
---
1212

13-
Use the **Data pipeline** tab in your database to view your data pipeline.
13+
Use the **Data pipeline** tab in your database to view and edit your data pipeline.
1414

1515
The **Data pipeline** tab gives an overview of your data pipeline and lets you view your data stream metrics.
1616

17+
18+
<--! TODO: REPLACE SCREENSHOT -->
1719
{{<image filename="images/rc/rdi/rdi-status-metrics-tables.png" alt="The select source database type list." width=80% >}}
1820

1921
The **Status** table shows statistics for the whole data pipeline:
@@ -41,7 +43,6 @@ The **Data stream metrics** table shows the following metrics for each data stre
4143
| **Filtered** | Number of records from the source table that were filtered from being inserted into the target database. |
4244
| **Rejected** | Number of records from the source table that could not be parsed or inserted into the target database. |
4345

44-
<!-- DOUBLE CHECK THIS BEFORE PHASE 2
4546
## Edit data pipeline
4647

4748
To change the data you want to ingest from the data pipeline:
@@ -50,14 +51,6 @@ To change the data you want to ingest from the data pipeline:
5051

5152
{{<image filename="images/rc/rdi/rdi-edit-button.png" alt="The edit pipeline button." width=100px >}}
5253

53-
1. For the **Configure a new pipeline** option, select the Redis data type to write keys to the target. You can choose **Hash** or **JSON**.
54-
55-
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The Pipeline definition screen. Configure a new pipeline is selected." width=75% >}}
56-
57-
Select **Continue**.
58-
59-
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
60-
6154
1. Select the schema and tables you want to migrate to the target database from the **Source data selection** list.
6255

6356
{{<image filename="images/rc/rdi/rdi-select-source-data.png" alt="The select source data section. " width=75% >}}
@@ -84,14 +77,26 @@ To change the data you want to ingest from the data pipeline:
8477

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

80+
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.
81+
82+
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The Pipeline definition screen. Configure a new pipeline is selected." width=75% >}}
83+
84+
Select **Continue**.
85+
86+
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
87+
8788
1. Review the tables you selected in the **Summary** and select how you want to update the data pipeline:
8889

90+
{{<image filename="images/rc/rdi/rdi-update-preferences.png" alt="The Select update preferences section." width=25% >}}
91+
8992
- **Apply to new data changes only**: The data pipeline will only synchronize new updates to the schema and tables selected. The data pipeline will not ingest any data from new schemas or tables that are selected.
9093
- **Reset pipeline (re-process all data)**: The data pipeline will re-ingest all of the selected data.
9194
- **Flush cached data and reset pipeline**: The data pipeline will flush the target Redis database, and then re-ingest all of the selected data from the source database.
9295

9396
1. Select **Apply changes**.
9497

98+
{{<image filename="images/rc/rdi/rdi-apply-changes.png" alt="The apply changes button." width=150px >}}
99+
95100
At this point, the data pipeline will apply the changes. If you selected **Reset pipeline** or **Flush cached data and reset pipeline**, the data pipeline will ingest data from the source database to the target database. After this initial sync is complete, the data pipeline enters the *change streaming* phase, where changes are captured as they happen.
96101

97102
If you selected **Apply to new data changes only**, the data pipeline will enter the *change streaming* phase without ingesting data.
@@ -108,7 +113,7 @@ To reset the data pipeline and restart the ingest process:
108113

109114
1. Select **Reset data pipeline**.
110115

111-
At this point, the data pipeline will re-ingest data from the source database to your target Redis database. -->
116+
At this point, the data pipeline will re-ingest data from the source database to your target Redis database.
112117

113118
## Stop and restart data pipeline
114119

1.02 KB
Loading
Loading
2.52 KB
Loading
Loading
2.51 KB
Loading
4.7 KB
Loading
2.29 KB
Loading
Loading
2.4 KB
Loading
Loading
-2.12 KB
Loading
Loading
Loading
3.04 KB
Loading
2.66 KB
Loading
Loading
Loading
14.8 KB
Loading
4.25 KB
Loading
Loading
3.52 KB
Loading
Loading
25.7 KB
Loading
2.22 KB
Loading
2.34 KB
Loading
11.5 KB
Loading

0 commit comments

Comments
 (0)