You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-12Lines changed: 17 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -135,25 +135,30 @@ To find all the documentation and concrete examples on how to use the AWS JDBC D
135
135
136
136
#### Amazon RDS Blue/Green Deployments
137
137
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**
139
139
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.
Supported Aurora MySQL Versions: Engine Release `3.07` and above.
142
+
**Limitations:**
145
143
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.
147
147
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):**
149
149
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.
153
152
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:**
155
154
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:
Copy file name to clipboardExpand all lines: docs/using-the-jdbc-driver/using-plugins/UsingTheBlueGreenPlugin.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,9 @@ The [Blue/Green Deployment](https://docs.aws.amazon.com/whitepapers/latest/blue-
6
6
7
7
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.
8
8
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.
9
12
10
13
## Prerequisites
11
14
> [!WARNING]\
@@ -21,7 +24,6 @@ The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligentl
21
24
> - AWS cluster and instance endpoints must be directly accessible from the client side
22
25
> - Connecting to database nodes using CNAME aliases is not supported
23
26
>
24
-
>
25
27
> **Blue/Green Support Behaviour and Version Compatibility:**
26
28
>
27
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.
@@ -35,8 +37,6 @@ The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligentl
35
37
> Supported Aurora MySQL Versions: Engine Release `3.07` and above.
36
38
37
39
38
-
39
-
40
40
## What is Blue/Green Deployment Plugin?
41
41
42
42
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
0 commit comments