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: docs/using-the-jdbc-driver/using-plugins/UsingTheBlueGreenPlugin.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligentl
23
23
>
24
24
25
25
26
-
## What Blue/Green Deployment Plugin does? Is it worth to use it?
26
+
## What is Blue/Green Deployment Plugin?
27
27
28
28
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:
29
29
- Connections to blue nodes terminate at a specific point during the transition
@@ -34,7 +34,7 @@ During a [Blue/Green switchover](https://docs.aws.amazon.com/AmazonRDS/latest/Us
34
34
35
35
36
36
All factors mentioned above may cause application disruption. The AWS Advanced JDBC Driver aims to minimize the application disruption during Blue/Green switchover by performing the following actions:
37
-
- Actively monitors Blue/Green switchover status and implements appropriate measures to hold, pass-through, or re-route database traffic
37
+
- Actively monitors Blue/Green switchover status and implements appropriate measures to suspend, pass-through, or re-route database traffic
38
38
- Prior to Blue/Green switchover initiation, compiles a comprehensive inventory of cluster and instance endpoints for both blue and green nodes along with their corresponding IP addresses
39
39
- During the active switchover phase, temporarily suspends execution of JDBC calls to blue nodes, which helps unload database nodes and reduces transaction lag for green nodes, thereby enhancing overall switchover performance
40
40
- Substitutes provided hostnames with corresponding IP addresses when establishing new blue connections, effectively eliminating stale DNS data and ensuring connections to current blue nodes
@@ -48,15 +48,15 @@ All factors mentioned above may cause application disruption. The AWS Advanced J
48
48
To enable the Blue/Green Deployment functionality, add the plugin code `bg` to the [`wrapperPlugins`](../UsingTheJdbcDriver.md#connection-plugin-manager-parameters) parameter value.
49
49
The Blue/Green Deployment Plugin supports the following configuration parameters:
50
50
51
-
| Parameter | Value | Required | Description | Example Value |
|`bgdId`| String | If using multiple Blue/Green Deployments, yes; otherwise, no | This parameter is optional and defaults to `1`. When supporting multiple Blue/Green Deployments (BGDs), this parameter becomes mandatory. Each connection string must include the `bgdId` parameter with a value that can be any number or string. However, all connection strings associated with the same Blue/Green Deployment must use identical `bgdId` values, while connection strings belonging to different BGDs must specify distinct values. |`1234`, `abc-1`, `abc-2`|
54
-
|`bgConnectTimeout`| Integer | No | Maximum waiting time (in milliseconds) for establishing new connections during a Blue/Green switchover when blue and green traffic is temporarily suspended. |`30000`|
55
-
|`bgBaseline`| Integer | No | The baseline interval (ms) for checking Blue/Green Deployment status. |`60000`|
56
-
|`bgIncreased`| Integer | No | The increased interval (ms) for checking Blue/Green Deployment status. |`1000`|
57
-
|`bgHigh`| Integer | No | The high-frequency interval (ms) for checking Blue/Green Deployment status. |`100`|
58
-
|`bgSwitchoverTimeout`| Integer | No | Maximum duration (in milliseconds) allowed for switchover completion. If the switchover process stalls or exceeds this timeframe, the driver will automatically assume completion and resume normal operations. |`180000`|
59
-
|`bgHoldNewBlueConnections`| Boolean | No | Enables Blue/Green Deployment switchover to suspend new blue connection requests while the switchover process is in progress. |`false`|
51
+
| Parameter | Value | Required | Description | Example Value |
|`bgdId`| String | If using multiple Blue/Green Deployments, yes; otherwise, no | This parameter is optional and defaults to `1`. When supporting multiple Blue/Green Deployments (BGDs), this parameter becomes mandatory. Each connection string must include the `bgdId` parameter with a value that can be any number or string. However, all connection strings associated with the same Blue/Green Deployment must use identical `bgdId` values, while connection strings belonging to different BGDs must specify distinct values. |`1234`, `abc-1`, `abc-2`|
54
+
|`bgConnectTimeoutMs`| Integer | No | Maximum waiting time (in milliseconds) for establishing new connections during a Blue/Green switchover when blue and green traffic is temporarily suspended. |`30000`|
55
+
|`bgBaselineMs`| Integer | No | The baseline interval (ms) for checking Blue/Green Deployment status. |`60000`|
56
+
|`bgIncreasedMs`| Integer | No | The increased interval (ms) for checking Blue/Green Deployment status. |`1000`|
57
+
|`bgHighMs`| Integer | No | The high-frequency interval (ms) for checking Blue/Green Deployment status. |`100`|
58
+
|`bgSwitchoverTimeoutMs`| Integer | No | Maximum duration (in milliseconds) allowed for switchover completion. If the switchover process stalls or exceeds this timeframe, the driver will automatically assume completion and resume normal operations. |`180000`|
59
+
|`bgSuspendNewBlueConnections`| Boolean | No | Enables Blue/Green Deployment switchover to suspend new blue connection requests while the switchover process is in progress. |`false`|
60
60
61
61
The plugin establishes dedicated monitoring connections to track Blue/Green Deployment status. To apply specific configurations to these monitoring connections, add the `blue-green-monitoring-` prefix to any configuration parameter, as shown in the following example:
0 commit comments