Skip to content

Commit 45b9366

Browse files
docs: remove important service dependency in bg docs (#1544)
1 parent 54fb200 commit 45b9366

File tree

2 files changed

+7
-16
lines changed

2 files changed

+7
-16
lines changed

README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -134,21 +134,10 @@ To find all the documentation and concrete examples on how to use the AWS JDBC D
134134

135135
#### Amazon RDS Blue/Green Deployments
136136

137-
**Important: Service Dependency**
138-
139-
Support for Blue/Green deployments using the AWS Advanced JDBC Wrapper requires specific metadata tables that are **not available in the current RDS and Aurora service**. Please contact your AWS account team for metadata release timelines.
140-
141-
**Limitations:**
142-
143137
- **Post-switchover failures:** After a Blue/Green switchover, the wrapper may not properly detect the new cluster topology, leading to failed failover attempts.
144138
- **Metadata inconsistencies:** Discrepancies between topology metadata and actual available endpoints prevent reliable operation.
145139
- **Version-specific issues:** Requirements vary between Aurora MySQL and Aurora PostgreSQL due to different internal systems.
146140

147-
**If You Must Use Blue/Green (Not Recommended for Production):**
148-
149-
1. Enable the `enableGreenNodeReplacement` configuration parameter.
150-
2. Thoroughly test in non-production environments.
151-
152141
**Recommendation:**
153142

154143
We advise waiting for the RDS service update before enabling the Blue/Green Deployments plugin. If the metadata table does not exist, your application will continue to work; however, errors will be logged stating that relevant Blue/Green metadata cannot be found.

docs/using-the-jdbc-driver/using-plugins/UsingTheBlueGreenPlugin.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ The [Blue/Green Deployment](https://docs.aws.amazon.com/whitepapers/latest/blue-
66

77
The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligently managing traffic distribution between blue and green nodes, minimizing the impact of stale DNS data and connectivity disruptions on user applications.
88

9-
**Important: Service Dependency**
10-
11-
Support for Blue/Green deployments using the AWS Advanced JDBC Wrapper requires specific metadata tables that are **not available in the current RDS and Aurora service**. Please contact your AWS account team for metadata release timelines.
12-
139
## Prerequisites
1410
> [!WARNING]\
1511
> Currently Supported Database Deployments:
@@ -26,7 +22,13 @@ Support for Blue/Green deployments using the AWS Advanced JDBC Wrapper requires
2622
>
2723
> **Blue/Green Support Behaviour and Version Compatibility:**
2824
>
29-
> The AWS Advanced JDBC Wrapper now includes enhanced full support for Blue/Green Deployments. This support requires a minimum database version that includes a specific metadata table. This constraint **does not** apply to RDS MySQL.
25+
> The AWS Advanced JDBC Wrapper now includes enhanced full support for Blue/Green Deployments. This support requires a minimum database version that includes a specific metadata table. The metadata will be accessible provided the green deployment satisfies the minimum version compatibility requirements. This constraint **does not** apply to RDS MySQL.
26+
>
27+
> For RDS Postgres, you will also need to manually install the `rds_tools` extension using the following DDL so that the metadata required by the wrapper is available:
28+
>
29+
> ```sql
30+
> CREATE EXTENSION rds_tools;
31+
> ```
3032
>
3133
> If your database version does **not** support this table, the driver will automatically detect its absence and fallback to its previous behaviour. In this fallback mode, Blue/Green handling is subject to the same limitations listed above.
3234
>

0 commit comments

Comments
 (0)