Skip to content

MigrationAssistant - Feature: Set desired count for proxies #10082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 8, 2025
+22 −11
Merged

MigrationAssistant - Feature: Set desired count for proxies #10082

Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
c6230b3
MigrationAssistant - Feature: Set desired count for proxies
AndreKurait Jun 12, 2025
adec3bd
Apply suggestions from code review
Naarcha-AWS Jun 12, 2025
5c8bd76
Apply suggestions from code review
Naarcha-AWS Jun 13, 2025
abf06cb
Merge branch 'main' into CaputreProxyDesiredCount
Naarcha-AWS Jun 13, 2025
0ecda9f
Apply suggestions from code review
Naarcha-AWS Jun 13, 2025
08aa93d
Apply suggestions from code review
Naarcha-AWS Jun 27, 2025
a239d6c
Apply suggestions from code review
Naarcha-AWS Jun 30, 2025
e26a9b6
Update _migration-assistant/deploying-migration-assistant/configurati…
Naarcha-AWS Jul 2, 2025
d39ba85
Update example targetClusterProxyDesiredCount and captureProxyDesired…
AndreKurait Jul 8, 2025
a2984c6
Improve language on preventing failing deployments on capture/target …
AndreKurait Jul 8, 2025
1a5c546
Update _migration-assistant/deploying-migration-assistant/configurati…
AndreKurait Jul 8, 2025
dfd942e
Update _migration-assistant/deploying-migration-assistant/configurati…
AndreKurait Jul 8, 2025
5e6bc0e
Update _migration-assistant/deploying-migration-assistant/configurati…
AndreKurait Jul 8, 2025
0641445
Update _migration-assistant/deploying-migration-assistant/configurati…
AndreKurait Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions _migration-assistant/deploying-migration-assistant/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,20 @@
"passwordFromSecretArn": <TARGET_CLUSTER_PASSWORD_SECRET>
}
},
"captureProxyServiceEnabled": true,
"captureProxyExtraArgs": "",

"// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay:",
"trafficReplayerServiceEnabled": true,
"trafficReplayerExtraArgs": "--speedup-factor 2.0",
"targetClusterProxyServiceEnabled": true

"// help trafficReplayerExtraArgs": "Increase the speedup factor to replay requests at a faster rate in order to catch up.",
"trafficReplayerExtraArgs": "--speedup-factor 1.5",

"// help capture/target proxy pt. 1 of 2": "captureProxyService and targetClusterProxyService deployment will fail without network access to clusters.",
"// help capture/target proxy pt. 2 of 2": "In most cases, keep the desired count setting at `0` until you verify connectivity in the migration console. After verifying connectivity, you can redeploy with a higher desired count.",
"captureProxyServiceEnabled": true,
"captureProxyDesiredCount": 3,
"targetClusterProxyServiceEnabled": true,
"targetClusterProxyDesiredCount": 3

}
}
```
Expand All @@ -110,13 +119,15 @@
Performing a live capture migration requires that a Capture Proxy be configured to capture incoming traffic and send it to the target cluster using the Traffic Replayer service. For arguments available in `captureProxyExtraArgs`, refer to the `@Parameter` fields [here](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficCaptureProxyServer/src/main/java/org/opensearch/migrations/trafficcapture/proxyserver/CaptureProxy.java). For `trafficReplayerExtraArgs`, refer to the `@Parameter` fields [here](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java). At a minimum, no extra arguments may be needed.


| Name | Example | Description |
| :--- | :--- | :--- |
| `captureProxyServiceEnabled` | `true` | Enables the Capture Proxy service deployment using an AWS CloudFormation stack. |
| `captureProxyExtraArgs` | `"--suppressCaptureForHeaderMatch user-agent .*elastic-java/7.17.0.*"` | Extra arguments for the Capture Proxy command, including options specified by the [Capture Proxy](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficCaptureProxyServer/src/main/java/org/opensearch/migrations/trafficcapture/proxyserver/CaptureProxy.java). |
| `trafficReplayerServiceEnabled` | `true` | Enables the Traffic Replayer service deployment using a CloudFormation stack. |
| `trafficReplayerExtraArgs` | `"--sigv4-auth-header-service-region es,us-east-1 --speedup-factor 5"` | Extra arguments for the Traffic Replayer command, including options for auth headers and other parameters specified by the [Traffic Replayer](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java). |
| `targetClusterProxyServiceEnabled` | `true` | Enables the target cluster proxy service deployment using a CloudFormation stack. |
| Name | Example | Description |
| :--- |:-----------------------------------------------------------------------| :--- |
| `captureProxyServiceEnabled` | `true` | Enables the Capture Proxy service deployment using an AWS CloudFormation stack. |
| `captureProxyExtraArgs` | `"--suppressCaptureForHeaderMatch user-agent .*elastic-java/7.17.0.*"` | Extra arguments for the Capture Proxy command, including options specified by the [Capture Proxy](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficCaptureProxyServer/src/main/java/org/opensearch/migrations/trafficcapture/proxyserver/CaptureProxy.java). |
| `captureProxyDesiredCount` | `0` | Sets the number of Capture Proxy Amazon Elastic Container Service (Amazon ECS) tasks. In most cases, keep this setting at `0` until you verify connectivity between the source and target clusters in the migration console. After deployment, you can modify the networking setup to allow ingress from the migration security groups into the existing cluster security groups. |
| `trafficReplayerServiceEnabled` | `true` | Enables the Traffic Replayer service deployment using a CloudFormation stack. |

Check failure on line 127 in _migration-assistant/deploying-migration-assistant/configuration-options.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: Replayer. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: Replayer. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_migration-assistant/deploying-migration-assistant/configuration-options.md", "range": {"start": {"line": 127, "column": 130}}}, "severity": "ERROR"}
| `trafficReplayerExtraArgs` | `"--sigv4-auth-header-service-region es,us-east-1 --speedup-factor 5"` | Extra arguments for the Traffic Replayer command, including options for auth headers and other parameters specified by the [Traffic Replayer](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java). |

Check failure on line 128 in _migration-assistant/deploying-migration-assistant/configuration-options.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: Replayer. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: Replayer. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_migration-assistant/deploying-migration-assistant/configuration-options.md", "range": {"start": {"line": 128, "column": 142}}}, "severity": "ERROR"}
| `targetClusterProxyServiceEnabled` | `true` | Enables the target cluster proxy service deployment using a CloudFormation stack. |
| `targetClusterProxyDesiredCount` | `0` | Sets the number of target cluster proxy Amazon ECS tasks. In most cases, keep this setting at `0` until you verify connectivity between the source and target clusters in the migration console. After deployment, you can modify the networking setup to allow ingress from the migration security groups into the existing cluster security groups. |

For arguments available in `captureProxyExtraArgs`, see the `@Parameter` fields in [`CaptureProxy.java`](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficCaptureProxyServer/src/main/java/org/opensearch/migrations/trafficcapture/proxyserver/CaptureProxy.java). For `trafficReplayerExtraArgs`, see the `@Parameter` fields in [`TrafficReplayer.java`](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java).

Expand Down
Loading