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
1. Enter a **Pipeline name**. This pipeline name will be the prefix to all keys generated by this pipeline in the target database.
23
+
1. Enter a **Pipeline name**.
24
24
{{<imagefilename="images/rc/rdi/rdi-define-pipeline-cidr.png"alt="The pipeline name and deployment CIDR fields." >}}
25
-
1.Enter the **Deployment CIDR** for your pipeline, or use the one generated for you. This CIDR should not conflict with your apps or other databases.
25
+
1.A **Deployment CIDR**is automatically generated for you. If, for any reason, a CIDR is not generated, enter a valid CIDR that does not conflict with your applications or other databases.
26
26
1. In the **Source database connectivity** section, enter the **PrivateLink service name** of the [PrivateLink connected to your source database]({{< relref "/operate/rc/databases/rdi/setup#set-up-connectivity" >}}).
27
27
{{<imagefilename="images/rc/rdi/rdi-define-connectivity.png"alt="The Source database connectivity section, with database connection details and connectivity options." >}}
28
28
1. Enter your database details. This depends on your database type, and includes:
29
29
-**Port**: The database's port
30
30
-**Database**: Your database's name, or the root database *(PostgreSQL, Oracle only)*, or a comma-separated list of one or more databases you want to connect to *(SQL Server only)*
31
-
-**Database Server ID**: Unique ID for the replication client. *(mySQL and mariaDB only)*
32
-
Use the following SQL command to get this value:
33
-
```sql
34
-
SHOW VARIABLES LIKE'server_id';
35
-
```
31
+
-**Database Server ID**: Unique ID for the replication client. Enter a number that is not used by any existing replication clients. *(mySQL and mariaDB only)*
36
32
-**PDB**: Name of the Oracle pluggable database *(Oracle only)*
37
33
1. Enter the ARN of your [database credentials secret]({{< relref "/operate/rc/databases/rdi/setup#share-source-database-credentials" >}}) in the **Source database secrets ARN** field.
38
34
1. Select **Start pipeline setup**.
@@ -45,7 +41,7 @@ At this point, Redis Cloud will provision the pipeline infrastructure that will
45
41
46
42
{{<imagefilename="images/rc/rdi/rdi-pipeline-setup-in-progress.png"alt="The Pipeline setup in progress screen."width=75% >}}
47
43
48
-
Pipelines are provisioned in the background. You aren't allowed to make changes to your data pipeline or to your database during provisioning. This process will take a long time, so you can close the window and come back later.
44
+
Pipelines are provisioned in the background. You aren't allowed to make changes to your data pipeline or to your database during provisioning. This process will take about an hour, so you can close the window and come back later.
49
45
50
46
When your pipeline is provisioned, select **Complete setup**. You will then [define your data pipeline](#define-data-pipeline).
51
47
@@ -57,12 +53,8 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
57
53
58
54
### Configure a new pipeline
59
55
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.
56
+
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.
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,79 @@ 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:
131
+
132
+
1. In **Basic configuration**:
133
+
-**Scheme**: Select **Internal**.
134
+
-**Load balancer IP address type**: Select **IPv4**.
135
+
1. In **Network mapping**, select the VPC and availability zone associated with your source database.
136
+
1. In **Security groups**, select the security group associated with your source database.
137
+
1. In **Listeners and routing**:
138
+
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:
139
+
1. In **Specify group details**:
140
+
-**Target type**: Select **IP Addresses**.
141
+
-**Protocol : Port**: Select **TCP**, and then enter the port number where your database is exposed.
142
+
- The **IP address type** and **VPC** should be selected already and match the VPC you selected earlier.
143
+
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.
144
+
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:
145
+
```sh
146
+
$ nslookup <proxy-endpoint>
147
+
```
148
+
Replace `<proxy-endpoint>` with the endpoint of your RDS proxy.
149
+
1. Set the following **Listener** properties:
150
+
- **Protocol**: Select **TCP**.
151
+
- **Port**: Enter your source database's port.
152
+
- **Default action**: Select the target group you created in the previous step.
153
+
1. Review the network load balancer settings, and then select **Create load balancer** to continue.
154
+
1. After the network load balancer is active, select **Security**, and then select the security group ID to open the Security group settings.
155
+
1. Select **Edit inbound rules**, then **Add rule** to add a rule with the following settings:
156
+
- **Type**: Select **HTTP**.
157
+
- **Source**: Select **Anywhere - IPv4**.
158
+
Select **Save rules** to save your changes.
159
+
160
+
#### Create endpoint service {#create-endpoint-service-rds}
161
+
162
+
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:
163
+
164
+
1. In **Available load balancers**, select the [network load balancer](#create-network-load-balancer-rds) you created.
84
165
1. In **Additional settings**, choose the following settings:
85
166
- **Require acceptance for endpoint**: Select **Acceptance required**.
86
167
- **Supported IP address types**: Select **IPv4**.
@@ -106,7 +187,7 @@ To do this, you need to:
106
187
107
188
### Create encryption key
108
189
109
-
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Key Management Service**. [Create an encryption key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) with the following settings:
190
+
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Key Management Service**. [Create an encryption key](https://docs.aws.amazon.com/kms/latest/developerguide/create-symmetric-cmk.html) with the following settings:
110
191
111
192
1. In **Step 1 - Configure key**:
112
193
- **Key type**: Select **Symmetric**.
@@ -118,6 +199,8 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
118
199
1. In **Step 3 - Define key administrative permissions**, under **Key deletion**, select **Allow key administrators to delete this key**.
119
200
1. In **Step 4 - Define key usage permissions**, under **Other AWS accounts**, select **Add another AWS account**. Enter the AWS account ID for the Redis Cloud cluster that you saved earlier.
120
201
202
+
Review the key policy and key settings, and then select **Finish** to create the key.
203
+
121
204
### Create database credentials secret
122
205
123
206
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) of type **Other type of secret** with the following settings:
@@ -159,7 +242,6 @@ If your source database has TLS or mTLS enabled, we recommend that you enter the
159
242
160
243
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
244
162
-
163
245
## Next steps
164
246
165
247
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">}}).
0 commit comments