Skip to content

Commit 960c870

Browse files
authored
Merge pull request #1750 from redis/DOC-5350
RC RDI: Some typo fixes, scraping RDI metrics, and behavior fixes
2 parents 9137b85 + b45447f commit 960c870

File tree

7 files changed

+51
-22
lines changed

7 files changed

+51
-22
lines changed

content/integrate/redis-data-integration/data-pipelines/prepare-dbs/aws-aurora-rds/aws-aur-mysql.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ type: integration
1616
weight: 2
1717
---
1818

19-
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.
20-
database to work with RDI.
19+
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.
2120

2221
## Create and apply parameter group
2322

content/integrate/redis-data-integration/data-pipelines/prepare-dbs/aws-aurora-rds/aws-rds-sqlserver.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ weight: 3
1818

1919
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.
2020

21+
{{< note >}}
22+
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.
23+
{{< /note >}}
24+
2125
## Create the Debezium user
2226

2327
The Debezium connector needs a user account to connect to SQL Server. This

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@ After your pipeline is provisioned, you will be able to define your pipeline. Yo
8282

8383
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.
8484
{{<image filename="images/rc/rdi/rdi-configure-new-pipeline.png" alt="The pipeline definition screen." width=75% >}}
85+
86+
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.
87+
88+
{{<image filename="images/rc/rdi/rdi-transformation-jobs.png" alt="The transformation jobs section. Select Upload jobs to upload transformation jobs." >}}
89+
8590
Select **Continue**.
8691
{{<image filename="images/rc/rdi/rdi-continue-button.png" alt="The continue button." width=150px >}}
8792

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

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -51,22 +51,28 @@ See the [RDI architecture overview]({{< relref "/integrate/redis-data-integratio
5151

5252
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.
5353

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

58-
### Database hosted on an AWS EC2 instance
56+
- Database hosted on an AWS EC2 instance:
5957

60-
The following diagram shows the network setup for a database hosted on an AWS EC2 instance.
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=80% >}}
6159

62-
{{<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% >}}
60+
- Database hosted on AWS RDS or AWS Aurora:
6361

64-
To do this:
62+
{{<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% >}}
63+
64+
Select the steps for your database setup.
65+
66+
{{< multitabs id="rdi-cloud-connectivity"
67+
tab1="EC2 instance"
68+
tab2="AWS RDS or Aurora" >}}
69+
70+
To set up PrivateLink for a database hosted on an EC2 instance:
6571

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

69-
#### Create network load balancer {#create-network-load-balancer-ec2}
75+
### Create network load balancer {#create-network-load-balancer-ec2}
7076

7177
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:
7278

@@ -81,7 +87,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
8187
- **Target type**: Select **Instances**.
8288
- **Protocol : Port**: Select **TCP**, and then enter the port number where your database is exposed.
8389
- The **IP address type** and **VPC** should be selected already and match the VPC you selected earlier.
84-
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.
90+
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.
8591
1. Set the following **Listener** properties:
8692
- **Protocol**: Select **TCP**.
8793
- **Port**: Enter your source database's port.
@@ -93,7 +99,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
9399
- **Source**: Select **Anywhere - IPv4**.
94100
Select **Save rules** to save your changes.
95101

96-
#### Create endpoint service {#create-endpoint-service-ec2}
102+
### Create endpoint service {#create-endpoint-service-ec2}
97103

98104
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:
99105

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

114120
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).
115121

116-
### Database hosted on AWS RDS or AWS Aurora
117-
118-
The following diagram shows the network setup for a database hosted on AWS RDS or AWS Aurora.
122+
--tab-sep--
119123

120-
{{<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% >}}
121-
122-
To do this:
124+
To set up PrivateLink for a database hosted on AWS RDS or AWS Aurora:
123125

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

128-
#### Create RDS proxy {#create-rds-proxy}
130+
### Create RDS proxy {#create-rds-proxy}
129131

130132
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.
131133

132-
#### Create network load balancer {#create-network-load-balancer-rds}
134+
The Proxy's IAM role must have the following permissions to access the database using the credentials secret and encryption key:
135+
- `secretsmanager:GetSecretValue`
136+
- `secretsmanager:DescribeSecret`
137+
- `kms:Decrypt`
138+
139+
You can set the proxy's IAM role during creation in the **Authentication** section.
140+
141+
### Create network load balancer {#create-network-load-balancer-rds}
133142

134143
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:
135144

@@ -144,7 +153,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
144153
- **Target type**: Select **IP Addresses**.
145154
- **Protocol : Port**: Select **TCP**, and then enter the port number where your database is exposed.
146155
- The **IP address type** and **VPC** should be selected already and match the VPC you selected earlier.
147-
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.
156+
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.
148157
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:
149158
```sh
150159
$ nslookup <proxy-endpoint>
@@ -161,7 +170,7 @@ In the [AWS Management Console](https://console.aws.amazon.com/), use the **Serv
161170
- **Source**: Select **Anywhere - IPv4**.
162171
Select **Save rules** to save your changes.
163172
164-
#### Create endpoint service {#create-endpoint-service-rds}
173+
### Create endpoint service {#create-endpoint-service-rds}
165174
166175
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:
167176
@@ -181,6 +190,8 @@ After you create the endpoint service, you need to add Redis Cloud as an Allowed
181190
182191
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).
183192
193+
{{< /multitabs >}}
194+
184195
## Share source database credentials
185196
186197
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.

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@ At this point, the data pipeline will apply the changes. If you selected **Reset
9999

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

102+
## View metrics endpoints
103+
104+
You can use [Prometheus and Grafana]({{< relref "/integrate/prometheus-with-redis-cloud/" >}}) to track and display metrics for the data pipeline.
105+
106+
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.
107+
108+
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.
109+
110+
For more information about available RDI metrics, see [Observability]({{< relref "/integrate/redis-data-integration/observability" >}}).
111+
102112
## Reset data pipeline
103113

104114
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.
Loading
12.4 KB
Loading

0 commit comments

Comments
 (0)