diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03fd277..cde04a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ To test the module manually, follow these steps: 1. After the resources have been created, go to the Target Groups in the AWS console and make sure that the health checks are passing. If they are not, you will need to add the subnet CIDR blocks of your RDS instance to the security groups of your RDS instance. For more information, see [this AWS documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-troubleshooting.html). 1. Next, run the queries in the output to create the connection in Materialize. 1. Finally, in your AWS console, under the Endpoint Service that was created, approve the connection request from the Materialize instance and check that the connection is active. -1. You can now create a Postgres source in Materialize using the connection name from the output. +1. You can now create a PostgreSQL or MySQL source in Materialize using the connection name from the output. 1. Finally, drop the connection in Materialize and run `terraform destroy` to clean up the resources. ## Cutting a new release diff --git a/README.md b/README.md index 57566dd..44f8796 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ > [!WARNING] > This is provided on a best-effort basis and Materialize cannot offer support for this module -This repository contains a Terraform module that configures a PrivateLink endpoint for an existing Amazon RDS Postgres database to connect to Materialize. +This repository contains a Terraform module that configures a PrivateLink endpoint for existing Amazon RDS PostgreSQL or MySQL databases to connect to Materialize. The module creates the following resources: -- Target group for the RDS instance -- Network Load Balancer for the RDS instance -- TCP listener for the NLB to forward traffic to the target group -- A VPC endpoint service for your RDS instance -- Lambda Function to check and update the IP address of the RDS instance in the NLB target group +- Target group for each RDS instance +- Network Load Balancer for the RDS instances +- TCP listener for the NLB to forward traffic to the target groups +- A VPC endpoint service for your RDS instances +- Lambda Function to check and update the IP addresses of the RDS instances in the NLB target groups - IAM Role and Policy to give the Lambda function necessary permissions - Event Source Mapping, Event Rule, and Target: Triggers the Lambda function every _n_ minutes - Lambda Permission: Allows the event to invoke the Lambda function @@ -18,14 +18,14 @@ The module creates the following resources: ## Important Remarks > [!NOTE] -> The RDS instance needs to be private. If your RDS instance is public, there is no need to use PrivateLink. +> The RDS instances need to be private. If your RDS instances are public, there is no need to use PrivateLink. > [!NOTE] > When using Aurora, the RDS instance needs to be a **writer** instance as the reader instances will not work. -- The RDS instance must be in the same VPC as the PrivateLink endpoint. +- The RDS instances must be in the same VPC as the PrivateLink endpoint. - Review this module with your Cloud Security team to ensure that it meets your security requirements. -- Finally, after the Terraform module has been applied, you will need to make sure that the Target Groups health checks are passing. As the NLB does not have security groups, you will need to make sure that the NLB is able to reach the RDS instance by allowing the subnet CIDR blocks in the security groups of the RDS instance. +- Finally, after the Terraform module has been applied, you will need to make sure that the Target Groups health checks are passing. As the NLB does not have security groups, you will need to make sure that the NLB is able to reach the RDS instances by allowing the subnet CIDR blocks in the security groups of the RDS instances. To override the default AWS provider variables, you can export the following environment variables: @@ -46,7 +46,7 @@ cp terraform.tfvars.example terraform.tfvars | Name | Description | Type | Example | Required | |------|-------------|:----:|:-----:|:-----:| -| mz_rds_instance_names | The name of the RDS instances | list | `{ name = "instance1", listener_port = 5001 }` | yes | +| mz_rds_instance_names | The name and listener port of the RDS instances | list | `{ name = "instance1", listener_port = 5001 }` | yes | | mz_rds_vpc_id | The VPC ID of the RDS instance | string | `'vpc-1234567890abcdef0'` | yes | | mz_acceptance_required | Whether or not to require manual acceptance of new connections | bool | `true` | no | | schedule_expression | [The scheduling expression](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_rule#schedule_expression). For example, `cron(0 20 * * ? *)` | string | `'rate(5 minutes)'` | no | @@ -62,7 +62,7 @@ terraform apply After the Terraform module has been applied, you will see the following output. -You can follow the instructions in the output to configure the PrivateLink endpoint and the Postgres connections in Materialize. +You can follow the instructions in the output to configure the PrivateLink endpoint and the database connections in Materialize. First, you will need to create the PrivateLink endpoint in Materialize: @@ -83,29 +83,31 @@ mz_rds_private_link_endpoint_sql = < <