Skip to content

Commit b764f13

Browse files
authored
docs: clarify support for blue/green deployments (#1434)
1 parent 692f489 commit b764f13

File tree

2 files changed

+4
-14
lines changed

2 files changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,15 @@ The development team is aware of these limitations and is working to improve the
129129
> [!WARNING]\
130130
> **Blue/Green Support Behaviour and Version Compatibility**
131131
>
132-
> The AWS Advanced JDBC Wrapper now includes enhanced full support for Blue/Green Deployments. This support requires a minimum database version, for RDS and Aurora PostgreSQL, that includes a specific metadata table. This constraint **does not** apply to RDS MySQL and Aurora MySQL.
132+
> 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.
133133
>
134134
> 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.
135135
>
136136
> **No action is required** if your database does not include the new metadata table -- the driver will continue to operate as before. If you have questions or encounter issues, please open an issue in this repository.
137137
>
138-
> Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)`.<br>
139-
> Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21`.
138+
> Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.<br>
139+
> Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.<br>
140+
> Supported Aurora MySQL Versions: Engine Release `3.07` and above.
140141
141142
[^1]: Aurora MySQL requires v3.07 or later.
142143

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

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,3 @@ public class HikariCPSQLException implements SQLExceptionOverride {
106106
}
107107
}
108108
```
109-
110-
### Blue/Green Deployments
111-
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.
112-
113-
The current limitations are:
114-
- 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.
115-
- The specific version requirements for Aurora MySQL versus Aurora PostgreSQL may vary, as the internal systems used by the wrapper can differ[^1].
116-
117-
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.
118-
119-
[^1]: Aurora MySQL requires v3.07 or later.

0 commit comments

Comments
 (0)