Skip to content

Commit 3cc61de

Browse files
committed
docs: update bg sections on README and UsingTheBlueGreenPlugin.md
1 parent 8626c3e commit 3cc61de

File tree

2 files changed

+29
-26
lines changed

2 files changed

+29
-26
lines changed

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -146,23 +146,18 @@ To find all the documentation and concrete examples on how to use the AWS Advanc
146146

147147
#### Amazon RDS Blue/Green Deployments
148148

149-
The AWS Advanced Python Wrapper **versions 1.3.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.
149+
Support for Blue/Green deployments using the AWS Advanced Python Driver requires specific metadata tables. The following service versions provide support for Blue/Green Deployments:
150150

151-
**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.
151+
- Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.
152+
- Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.
153+
- Supported Aurora MySQL Versions: Engine Release `3.07` and above.
152154

153-
Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.<br>
154-
Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.<br>
155-
Supported Aurora MySQL Versions: Engine Release `3.07` and above.
155+
Please note that Aurora Global Database and RDS Multi-AZ clusters with Blue/Green deployments is currently not supported. For detailed information on supported database versions, refer to the [Blue/Green Deployment Plugin Documentation](./docs/using-the-python-driver/using-plugins/UsingTheBlueGreenPlugin.md).
156156

157-
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 <1.3.0. In this fallback mode, Blue/Green handling is subject to the same limitations listed below.
158-
159-
AWS Advanced Python Wrapper **versions earlier than 1.3.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 Python 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.
160-
161-
The limitations for versions earlier than 1.3.0 are:
162-
- 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.
163-
- The specific version requirements for Aurora MySQL versus Aurora PostgreSQL may vary, as the internal systems used by the wrapper can differ[^1].
164-
165-
[^1]: Aurora MySQL requires v3.07 or later.
157+
In addition:
158+
- **Post-switchover failures:** After a Blue/Green switchover, the wrapper may not properly detect the new cluster topology, leading to failed failover attempts.
159+
- **Metadata inconsistencies:** Discrepancies between topology metadata and actual available endpoints prevent reliable operation.
160+
- **Version-specific issues:** Requirements vary between Aurora MySQL and Aurora PostgreSQL due to different internal systems.
166161

167162
#### MySQL Connector/Python C Extension
168163

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

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,40 @@ The AWS Python Driver leverages the Blue/Green Deployment approach by intelligen
88

99

1010
## Prerequisites
11+
1112
> [!WARNING]\
12-
> **Blue/Green Support Behaviour and Version Compatibility**
13-
>
1413
> Currently Supported Database Deployments:
14+
>
1515
> - Aurora MySQL and PostgreSQL clusters
1616
> - RDS MySQL and PostgreSQL instances
1717
>
1818
> Unsupported Database Deployments and Configurations:
19+
>
1920
> - RDS MySQL and PostgreSQL Multi-AZ clusters
2021
> - Aurora Global Database for MySQL and PostgreSQL
21-
>
22-
> Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)`.<br>
23-
> Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21`.<br>
24-
> Supported Aurora MySQL Versions: Engine Release `3.07` and above.
25-
>
22+
>
23+
> Additional Requirements:
24+
>
25+
> - AWS cluster and instance endpoints must be directly accessible from the client side
26+
> - Connecting to database nodes using CNAME aliases is not supported
27+
>
28+
> **Blue/Green Support Behaviour and Version Compatibility:**
29+
>
30+
> The AWS Advanced Python Driver 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.
31+
>
2632
> 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:
2733
>
2834
> ```sql
2935
> CREATE EXTENSION rds_tools;
3036
> ```
3137
>
32-
> If your database version does **not** match the supported versions listed above, the wrapper will automatically fallback to its previous behaviour. In this fallback mode, Blue/Green handling is subject to the limitations listed below:
33-
> - 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.
34-
> - The specific database version requirements for different database deployments may vary, as the internal systems used by the wrapper can differ.
35-
>
36-
> If you have questions or encounter issues, please open an issue in this repository.
38+
> 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.
39+
>
40+
> **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.
41+
>
42+
> Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.<br>
43+
> Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.<br>
44+
> Supported Aurora MySQL Versions: Engine Release `3.07` and above.
3745
3846
3947
## What is the Blue/Green Deployment Plugin?

0 commit comments

Comments
 (0)