Skip to content

Commit 55c9022

Browse files
authored
docs: clarifying blue/green compatibility with current service landscape (#1512)
1 parent 5687323 commit 55c9022

File tree

3 files changed

+26
-21
lines changed

3 files changed

+26
-21
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -135,25 +135,30 @@ To find all the documentation and concrete examples on how to use the AWS JDBC D
135135

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

138-
The AWS Advanced JDBC Wrapper **versions 2.6.0 and above** now include 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.
138+
**Important: Service Dependency**
139139

140-
**No action is required** if your database does not include the new metadata table -- the driver will continue to operate as before with no special blue/green functionality. If you have questions or encounter issues, please open an issue in this repository.
140+
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.
141141

142-
Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.<br>
143-
Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.<br>
144-
Supported Aurora MySQL Versions: Engine Release `3.07` and above.
142+
**Limitations:**
145143

146-
If your database version does **not** support this table, the driver will automatically detect its absence and fallback to its previous behaviour in wrapper versions <2.6.0. In this fallback mode, Blue/Green handling is subject to the same limitations listed below.
144+
- **Post-switchover failures:** After a Blue/Green switchover, the wrapper may not properly detect the new cluster topology, leading to failed failover attempts.
145+
- **Metadata inconsistencies:** Discrepancies between topology metadata and actual available endpoints prevent reliable operation.
146+
- **Version-specific issues:** Requirements vary between Aurora MySQL and Aurora PostgreSQL due to different internal systems.
147147

148-
AWS Advanced JDBC Wrapper **versions earlier than 2.6.0** are not compatible with [AWS Blue/Green Deployments](https://docs.aws.amazon.com/whitepapers/latest/overview-deployment-options/bluegreen-deployments.html) and do not officially support them. However, the combination of the AWS Advanced JDBC Wrapper and the Failover Plugin has been validated for use with clusters that employ Blue/Green Deployments for these versions. While general basic connectivity to both Blue and Green clusters is always in place, some failover cases are not fully supported.
148+
**If You Must Use Blue/Green (Not Recommended for Production):**
149149

150-
The limitations for versions earlier than 2.6.0 are:
151-
- After a Blue/Green switchover, the wrapper may not be able to properly detect the new topology and handle failover, as there are discrepancies between the metadata and the available endpoints.
152-
- The specific version requirements for Aurora MySQL versus Aurora PostgreSQL may vary, as the internal systems used by the wrapper can differ[^1].
150+
1. Enable the `enableGreenNodeReplacement` configuration parameter.
151+
2. Thoroughly test in non-production environments.
153152

154-
For these earlier versions, users can consider utilizing the `enableGreenNodeReplacement` configuration parameter, which allows the driver to override incorrect topology metadata and try to connect to available new Blue endpoints.
153+
**Recommendation:**
155154

156-
[^1]: Aurora MySQL requires v3.07 or later.
155+
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.
156+
157+
When the RDS service update is released, the following service versions will provide support for Blue/Green Deployments:
158+
159+
- Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.
160+
- Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.
161+
- Supported Aurora MySQL Versions: Engine Release `3.07` and above.
157162

158163
#### Amazon Aurora Global Databases
159164

docs/Documentation.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,18 @@
99
- [Database Dialects](./using-the-jdbc-driver/DatabaseDialects.md)
1010
- [Target Driver Dialects](./using-the-jdbc-driver/TargetDriverDialects.md)
1111
- [Plugins](./using-the-jdbc-driver/UsingTheJdbcDriver.md#plugins)
12+
- [Aurora Connection Tracker Plugin](./using-the-jdbc-driver/using-plugins/UsingTheAuroraConnectionTrackerPlugin.md)
13+
- [Aurora Initial Connection Strategy Plugin](./using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md)
14+
- [AWS Secrets Manager Plugin](./using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
15+
- [Blue/Green Deployment Plugin](./using-the-jdbc-driver/using-plugins/UsingTheBlueGreenPlugin.md)
16+
- [Driver Metadata Connection Plugin](./using-the-jdbc-driver/using-plugins/UsingTheDriverMetadataConnectionPlugin.md)
1217
- [Failover Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFailoverPlugin.md)
1318
- [Failover Configuration Guide](./using-the-jdbc-driver/FailoverConfigurationGuide.md)
1419
- [Failover Plugin v2](./using-the-jdbc-driver/using-plugins/UsingTheFailover2Plugin.md)
20+
- [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md)
1521
- [Host Monitoring Plugin](./using-the-jdbc-driver/using-plugins/UsingTheHostMonitoringPlugin.md)
1622
- [IAM Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
17-
- [AWS Secrets Manager Plugin](./using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
18-
- [Aurora Connection Tracker Plugin](./using-the-jdbc-driver/using-plugins/UsingTheAuroraConnectionTrackerPlugin.md)
19-
- [Driver Metadata Connection Plugin](./using-the-jdbc-driver/using-plugins/UsingTheDriverMetadataConnectionPlugin.md)
2023
- [Read Write Splitting Plugin](./using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md)
21-
- [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md)
22-
- [Aurora Initial Connection Strategy Plugin](./using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md)
2324
- [Host Availability Strategy](./using-the-jdbc-driver/HostAvailabilityStrategy.md)
2425
- [Development Guide](./development-guide/DevelopmentGuide.md)
2526
- [Setup](./development-guide/DevelopmentGuide.md#setup)

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ 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.
912

1013
## Prerequisites
1114
> [!WARNING]\
@@ -21,7 +24,6 @@ The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligentl
2124
> - AWS cluster and instance endpoints must be directly accessible from the client side
2225
> - Connecting to database nodes using CNAME aliases is not supported
2326
>
24-
>
2527
> **Blue/Green Support Behaviour and Version Compatibility:**
2628
>
2729
> 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.
@@ -35,8 +37,6 @@ The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligentl
3537
> Supported Aurora MySQL Versions: Engine Release `3.07` and above.
3638
3739

38-
39-
4040
## What is Blue/Green Deployment Plugin?
4141

4242
During a [Blue/Green switchover](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-switching.html), several significant changes occur to your database configuration:
@@ -121,4 +121,3 @@ timestamp time offset (ms) event
121121
2025-04-23T17:42:26.536226Z 136547 ms COMPLETED
122122
----------------------------------------------------------------------------
123123
```
124-

0 commit comments

Comments
 (0)