Skip to content

Commit f303b91

Browse files
Merge branch 'main' into fix/limitless-rounding-error
2 parents 294d5cf + b7b67a0 commit f303b91

File tree

2 files changed

+7
-26
lines changed

2 files changed

+7
-26
lines changed

README.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -57,31 +57,10 @@ To find all the documentation and concrete examples on how to use the AWS Advanc
5757

5858
#### Amazon RDS Blue/Green Deployments
5959

60-
**Important: Service Dependency**
61-
62-
Support for Blue/Green deployments using the AWS Advanced NodeJS 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.
63-
64-
**Limitations:**
65-
6660
- **Post-switchover failures:** After a Blue/Green switchover, the wrapper may not properly detect the new cluster topology, leading to failed failover attempts.
6761
- **Metadata inconsistencies:** Discrepancies between topology metadata and actual available endpoints prevent reliable operation.
6862
- **Version-specific issues:** Requirements vary between Aurora MySQL and Aurora PostgreSQL due to different internal systems.
6963

70-
**If You Must Use Blue/Green (Not Recommended for Production):**
71-
72-
1. Enable the `enableGreenNodeReplacement` configuration parameter.
73-
2. Thoroughly test in non-production environments.
74-
75-
**Recommendation:**
76-
77-
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.
78-
79-
When the RDS service update is released, the following service versions will provide support for Blue/Green Deployments:
80-
81-
- Supported RDS PostgreSQL Versions: `rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21)` and above.
82-
- Supported Aurora PostgreSQL Versions: Engine Release `17.5, 16.9, 15.13, 14.18, 13.21` and above.
83-
- Supported Aurora MySQL Versions: Engine Release `3.07` and above.
84-
8564
#### Amazon Aurora Global Databases
8665

8766
This wrapper currently does not support failover with Amazon Aurora Global Databases. While it is possible to connect to global databases, failing over to a secondary cluster will result in errors and there may be additional unforeseen errors when working with global databases. Support for Amazon Aurora Global Databases is in the backlog, but we cannot comment on a timeline right now.

docs/using-the-nodejs-wrapper/using-plugins/UsingTheBlueGreenPlugin.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ The [Blue/Green Deployment](https://docs.aws.amazon.com/whitepapers/latest/blue-
66

77
The AWS Advanced NodeJS Wrapper 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 Go 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.
12-
139
## Prerequisites
1410

1511
> [!WARNING]\
@@ -30,7 +26,13 @@ Support for Blue/Green deployments using the AWS Advanced Go Wrapper requires sp
3026
>
3127
> **Blue/Green Support Behaviour and Version Compatibility:**
3228
>
33-
> The AWS Advanced NodeJS 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.
29+
> The AWS Advanced NodeJS Wrapper 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.
30+
>
31+
> 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:
32+
>
33+
> ```sql
34+
> CREATE EXTENSION rds_tools;
35+
> ```
3436
>
3537
> 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.
3638
>

0 commit comments

Comments
 (0)