Skip to content

Commit b6a6c23

Browse files
authored
docs: clarify blue/green support limitations and default behaviour fo… (#1053)
1 parent d202cce commit b6a6c23

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,15 @@ To find all the documentation and concrete examples on how to use the AWS JDBC D
116116

117117
#### Amazon RDS Blue/Green Deployments
118118

119-
This driver currently does not support switchover in Amazon RDS Blue/Green Deployments. If you do execute a Blue/Green deployment with the driver, please ensure your application is coded to retry the database connection. Retry will allow the driver to re-establish a connection to an available database instance. Without a retry, the driver would not be able to identify an available database instance, after a switchover has happened between the blue and green environments. However, please note that even with your application coded to retry the database connection, you may still encounter other unexpected errors. Support for Amazon RDS Blue/Green Deployments is in the backlog, but we cannot comment on a timeline right now.
119+
Although the AWS Advanced JDBC Wrapper is not compatible with [AWS Blue/Green Deployments](https://docs.aws.amazon.com/whitepapers/latest/overview-deployment-options/bluegreen-deployments.html) and does not officially support them, the combination of the AWS Advanced JDBC Wrapper and the Failover Plugin has been validated for use with clusters that employ Blue/Green Deployments. While general basic connectivity to both Blue and Green clusters is always in place, some failover cases are not fully supported.
120+
121+
The current limitations are:
122+
- 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.
123+
- The specific version requirements for Aurora MySQL versus Aurora PostgreSQL may vary, as the internal systems used by the wrapper can differ[^1].
124+
125+
The development team is aware of these limitations and is working to improve the wrapper's awareness and handling of Blue/Green switchovers. In the meantime, 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.
126+
127+
[^1]: Aurora MySQL requires v3.07 or later.
120128

121129
#### Amazon Aurora Global Databases
122130

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Aurora Connection Tracker Plugin
22

33
This plugin tracks all the opened connections. In the event of a cluster failover, this plugin will close all the impacted connections.
4-
This plugin is enabled by default.
4+
If no plugins are explicitly specified, this plugin is enabled by default.
55

66
## Use Case
77
User applications can have two types of connections:

0 commit comments

Comments
 (0)