RDI on Redis Cloud quick start

Learn how to create a data pipeline between a PostgreSQL source database created with Terraform and a Redis Cloud target database.

The rdi-cloud-automation GitHub repository contains a Terraform script that quickly sets up a PostgreSQL source database on an EC2 instance and all required permissions and network setup to connect it to a Redis Cloud target database.

Prerequisites

To follow this guide, you need to:

1. Create a Redis Cloud Pro database hosted on Amazon Web Services (AWS).

   Turn on Multi-AZ replication and manually select the availability zones when creating the database.

2. Install the AWS CLI and set up credentials for the CLI.

3. Install Terraform.

Create a data integration workspace

Before you can create your first Data Integration pipeline for a Redis Cloud subscription, you must first deploy the cloud infrastructure needed to host the pipeline and run the workers associated with the pipeline. In Redis Cloud, this is called a Workspace. See Create and manage Data Integration workspace for more information.

To create a Data Integration workspace for an existing Pro subscription:

1. From the Redis Cloud console, select Data Integration from the left-hand menu. If you don't have any workspaces yet, select Create workspace to go to the Create workspace page.

   

   If you already have a workspace deployed, you'll see your current workspaces. Select New workspace to go to the Create workspace page.

   

   You can also go to the Data Integration tab from your subscription or database page and select Create workspace to go to the Create workspace page for your subscription.

   

2. Select your Pro subscription from the list if it's not already selected.

   

3. A Data Integration subnet (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.

   

4. Select Create workspace to create your workspace.

   

Your workspace will be created in the background. You can select Create pipeline to create your pipeline while the workspace is provisioning, or you can select Create pipeline later to go back to the Redis Cloud console.

Get required ARNs

1. On the Redis Cloud console, go to your target database and select the Data Integration tab.

2. Select Add pipeline.

3. Select PostgreSQL as the source database type.

4. Enter a name for your source database in the Source name field. This is a name for the source database that will appear on Redis Cloud.

5. Select Continue to source to move to the Source configuration step.

   

6. Under Source connectivity, save the provided ARN. This will be the redis_privatelink_arn you will need later.

   

7. Under Secrets, save the provided ARN. This will be the redis_secrets_arn you will need later.

   

Create the source database and network resources

1. Clone or download the rdi-cloud-automation GitHub repository.

2. In a terminal window, go to the examples/aws-ec2-privatelink directory.

3. Run terraform init to initialize the Terraform working directory.

4. Open the example.tfvars file and edit the following variables:

   • region: The AWS region where your Redis Cloud database is deployed.
   • azs: The availability zone IDs where your Redis Cloud database is deployed.
   • port: The port number for the new PostgreSQL source database.
   • name: A prefix for all of the created AWS resources.
   • redis_secrets_arn: The source database credentials and certificates ARN from the Redis Cloud console.
   • redis_privatelink_arn: The PrivateLink ARN from the Redis Cloud console.

5. To view the configuration, run:

   terraform plan -var-file=example.tfvars
   

6. To create the AWS resources, run:

   terraform apply -var-file=example.tfvars
   

   This example creates the following resources on your AWS account:

   • An AWS KMS key with the required permissions for RDI
   • A VPC with a public and private subnet and all necessary route tables
   • An EC2 instance running a PostgreSQL database with a security group that allows access from Redis Cloud
   • An AWS Secrets Manager secret for the PostgreSQL database credentials
   • A Network Load Balancer (NLB), a listener, and target group to route traffic to the EC2 instance with AWS PrivateLink
   • An AWS PrivateLink endpoint service for the PostgreSQL database

Creating the AWS resources will take some time. After the resources are created, you'll be able to view them in the AWS management console.

Save the following outputs:

• database: The name of the PostgreSQL database.
• port: The port number for the PostgreSQL database.
• secret_arn: The ARN of the AWS Secrets Manager secret for the PostgreSQL database credentials.
• vpc_endpoint_service_name: The name of the AWS PrivateLink endpoint service for the PostgreSQL database.

If you lose any outputs, run terraform output to view them again.

Resume pipeline setup

1. Return to the Redis Cloud console. Go to your target database and select the Data Integration tab.

2. You'll see a draft pipeline in the workspace you created. Select More actions > Resume pipeline setup to continue with pipeline setup.

   

3. Continue to the Source configuration step.

4. In the Source connectivity section, enter the vpc_endpoint_service_name output in the PrivateLink service name field.

   

5. Select Connect to Private Link to test your Private Link connectivity. This will take a few minutes, but you can continue while it's testing.

6. In the Secrets section, enter the secret_arn output in the Credentials secret ARN field.

   

7. Select Validate to check that Redis Cloud can access your secrets.

8. In the Source configuration section, enter the terraform outputs in the following fields.

   • Database: database
   • Port: port

9. Select Test source to test Redis Cloud's connection with the source database. After the test completes, select Continue to dataset.

   

10. In the Schemas section, select the schema(s) you want to migrate to the target database from the list.

    

11. When you select a schema, you will see its tables in the Tables section. Redis Cloud will automatically select all tables for import. You can de-select any columns you do not wish to import to your Redis database.

12. Select a table to view its columns in the Columns section. You can de-select any columns you do not wish to import.

    

13. Select Continue to transformations to move to the Transformations step.

    

14. Select how your records will be stored in Redis. You can choose Hash or JSON.

    

15. Review the tables you selected in the Review and deploy step. If everything looks correct, select Deploy pipeline to start ingesting data from your source database.

    

At this point, the data pipeline will ingest data from the source database to your target Redis database. This process will take time, especially if you have a lot of records in your source database.

After this initial sync is complete, the data pipeline enters the change streaming phase, where changes are captured as they happen. Changes in the source database are added to the target within a few seconds of capture.

You can view the status of your data pipeline in the Data pipeline tab of your database. See View and edit data pipeline to learn more.

Delete sample resources

To delete the sample resources created by Terraform, run:

terraform destroy -var-file=example.tfvars