alexey.rassokhin/tet123
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

DBZ-1371 Fix formatting and typos in RDS documentation

Browse Source
This commit is contained in:
Chris Cranford 2019-07-02 09:51:18 -04:00 committed by Gunnar Morling
parent 051d5a478d
commit f88970f2e6
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
debezium-connector-postgres/RDS.md
View File

@ -2,7 +2,8 @@ In order to run the test suite against an Amazon RDS PostgreSQL environment, the
## Setup remote connectivity
When you setup an account with Amazon RDS, they should automatically create a new Security Group for your VPC environment. By default this new security group does not allow remote connections from your local machine to the resources which it secures, so you you need to explicitly grant remote access.
When you setup an account with Amazon RDS, they should automatically create a new Security Group for your VPC environment.
By default this new security group does not allow remote connections from your local machine to the resources which it secures, so you you need to explicitly grant remote access.
1. Navigate to **VPC** > **Security** > **Security Groups**
2. Select your Security Group in the top pane
@ -20,7 +21,10 @@ At this point your Security Group should now permit remote connections to any Po
## Setup a database parameter group
By default, Amazon RDS provides a set of parameter group configurations for basic database operations. Unfortunately these do not enable all the necessary features that are needed for Debezium to perform its change data capture operations, most notably logical replication. If you have already created a custom parameter group for your version of PostgreSQL, then you can skip this section. If you have not, this will walk you through how to copy and customize the default configuration groups for our needs.
By default, Amazon RDS provides a set of parameter group configurations for basic database operations.
Unfortunately these do not enable all the necessary features that are needed for Debezium to perform its change data capture operations, most notably logical replication.
If you have already created a custom parameter group for your version of PostgreSQL, then you can skip this section.
If you have not, this will walk you through how to copy and customize the default configuration groups for our needs.
1. Navigate to **RDS**, this should take you to the RDS Dashboard.
2. Click **Parameter Groups** in the **Resources** panel on the dashboard.
@ -30,7 +34,10 @@ By default, Amazon RDS provides a set of parameter group configurations for basi
* Group name: custom-postgresXX.YY
* Description: Custom parameter group for postgres XX.YY
At this point all we've done is clone the default parameter group for a given version of PostgreSQL into our own. We still need to make parameter modifications to support the features we need in order for Debezium to work properly. You should be able to click on the name of your parameter group and it should take you to a tabular screen where each parameter is listed, its current configured value, a description of the parameter and other pertinent information. At the top of this tabular layout is a search box we're going to use to quickly locate and edit parameters.
At this point all we've done is clone the default parameter group for a given version of PostgreSQL into our own.
We still need to make parameter modifications to support the features we need in order for Debezium to work properly.
You should be able to click on the name of your parameter group and it should take you to a tabular screen where each parameter is listed, its current configured value, a description of the parameter and other pertinent information.
At the top of this tabular layout is a search box we're going to use to quickly locate and edit parameters.
Click the `Edit parameters` button in the top right and then click in the search box.
@ -48,7 +55,7 @@ Once you've made these changes click `Save changes` to persist the parameter cha
The latest RDS piece of setup we need to do is to actually install our desired PostgreSQL instance.
1. Navigate to **RDS**, this should take you to the RDS Dashbaord.
1. Navigate to **RDS**, this should take you to the RDS Dashboard.
2. Click **DB Instances** in the **Resources** panel on the dashboard.
3. Click **Create database**.
@ -56,25 +63,29 @@ This is where all the _magic_ happens where we put tie together all the pieces o
1. Click the radio button to select **PostgreSQL**
2. Select the **Version** you wish to install.
Remember this version should ideally match the version of database parameters you cloned in the prior steps.
Remember this version should match the version of database parameters you cloned in the prior steps.
3. Select the **Template** of interest, I typically picked **Free tier** because it's free ;)
4. Provide your database with a **DB Instance Identifier**.
5. Under **Credentials Settings**, manually assign a **Master Password** and confirm it.
6. Under **Connectivity**, you'll want to set that it is _publicly accessible_.
7. You should be able to leave the **VPC security group** to use an existing and it should be set to **default** or whatever you named it to. In the event you have multiple security groups and you created a new one, select the one of interest to assign. In short it should be the security group that grants access to port 5432.
7. You should be able to leave the **VPC security group** to use an existing and it should be set to **default** or whatever you named it to.
In the event you have multiple security groups and you created a new one, select the one of interest to assign.
In short it should be the security group that grants access to port 5432.
Feel free to customize any other database configuration options you want but they're entirely optional and defaults are perfectly acceptable. Once you are satisfied with your configuration, click **Create database** and wait a few minutes while your instance is configured, built, and brought online for you.
Feel free to customize any other database configuration options you want but they're entirely optional and defaults are perfectly acceptable.
Once you are satisfied with your configuration, click **Create database** and wait a few minutes while your instance is configured, built, and brought online for you.
## Connecting to Amazon RDS
In order to connect to your Amazon RDS PostgreSQL instance, you'll need to use the fully qualified endpoint name. In order to determine your endpoint:
In order to connect to your Amazon RDS PostgreSQL instance, you'll need to use the fully qualified endpoint name.
In order to determine your endpoint:
1. Navigate to **RDS**, this should take you to the RDS Dashboard.
2. Click **DB Instances** in the **Resources** panel on the dashboard.
3. Click on the designed **DB Identifier** for the instance you're interested in connecting to.
4. You should have a **Connectivity & security** tab where you can see the **Endpoint** name.
When you run your JVM process you entire need to provide these VM options manually, provide them as a part of the exported environment or manually modify `TestHelper#defaultJdbcConfig()` specifying these values directly before running the tests.
When you run your JVM process you either need to provide these VM options manually, provide them as a part of the exported environment or manually modify `TestHelper#defaultJdbcConfig()` specifying these values directly before running the tests.
```