You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rc/databases/rdi/define.md
+6-5
Original file line number
Diff line number
Diff line change
@@ -57,12 +57,8 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
57
57
58
58
### Configure a new pipeline
59
59
60
-
1. In the [Redis Cloud console](https://cloud.redis.io/), go to your target database andselect 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 andselect the **Data Pipeline** tab. If your pipeline is already provisioned, select**Complete setup** to go to the **Select data** section.
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% >}}
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.
1. Review the tables you selected in the **Summary**. If everything looks correct, select **Start ingest** to start ingesting data from your source database.
See the [RDI architecture overview]({{< relref "/integrate/redis-data-integration/architecture#overview" >}}) for more information about CDC.
44
45
45
46
## Set up connectivity
46
47
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.
48
49
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)
51
53
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
+
{{<imagefilename="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.
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:
55
68
@@ -67,7 +80,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
67
80
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.
68
81
1. Set the following **Listener** properties:
69
82
-**Protocol**: Select **TCP**.
70
-
-**Port**: Enter **80**.
83
+
-**Port**: Enter your source database's port.
71
84
-**Default action**: Select the target group you created in the previous step.
72
85
1. Review the network load balancer settings, and then select **Create load balancer** to continue.
73
86
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
76
89
-**Source**: Select **Anywhere - IPv4**.
77
90
Select **Save rules** to save your changes.
78
91
79
-
### Create endpoint service
92
+
####Create endpoint service {#create-endpoint-service-ec2}
80
93
81
94
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:
82
95
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
+
{{<imagefilename="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.
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.
84
162
1. In **Additional settings**, choose the following settings:
85
163
-**Require acceptance for endpoint**: Select **Acceptance required**.
86
164
-**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
159
237
160
238
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.
161
239
162
-
163
240
## Next steps
164
241
165
242
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">}}).
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% >}}
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
+
{{<imagefilename="images/rc/rdi/rdi-configure-new-pipeline.png"alt="The Pipeline definition screen. Configure a new pipeline is selected."width=75% >}}
-**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.
90
93
-**Reset pipeline (re-process all data)**: The data pipeline will re-ingest all of the selected data.
91
94
-**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.
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.
96
101
97
102
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:
108
113
109
114
1. Select **Reset data pipeline**.
110
115
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.
0 commit comments