From c6230b3c17b6aa40ef860d21f773cde4c0bcaee7 Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Thu, 12 Jun 2025 15:57:14 -0500 Subject: [PATCH 01/13] MigrationAssistant - Feature: Set desired count for proxies Signed-off-by: Andre Kurait --- .../configuration-options.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 5fa28e44c43..41d981f04d7 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -97,11 +97,20 @@ The following sample CDK performs a live capture migration with C&R: "passwordFromSecretArn": } }, - "captureProxyServiceEnabled": true, - "captureProxyExtraArgs": "", + + "// settingsForCaptureAndReplay": "Enable the below services for live traffic capture and replay", "trafficReplayerServiceEnabled": true, - "trafficReplayerExtraArgs": "--speedup-factor 2.0", - "targetClusterProxyServiceEnabled": true + + "// help trafficReplayerExtraArgs": "Increase speedup factor in order replay requests at a faster rate to catchup", + "trafficReplayerExtraArgs": "--speedup-factor 1.5", + + "// help capture/target proxy pt. 1 of 2": "captureProxyService and targetClusterProxyService require networking access configured to successfully deploy,", + "// help capture/target proxy pt. 2 of 2": "consider deploying without first and enabling after ensuring cluster networking access on the migration console", + "captureProxyServiceEnabled": true, + "captureProxyDesiredCount": 3, + "targetClusterProxyServiceEnabled": true, + "targetClusterProxyDesiredCount": 3 + } } ``` @@ -114,9 +123,11 @@ Performing a live capture migration requires that a Capture Proxy be configured | :--- | :--- | :--- | | `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` | `3` | Set the number of capture proxy ecs tasks. In many cases it can be a good idea to keep this at 0 until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into existing cluster security groups by the migration security groups. | | `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. | +| `targetClusterProxyDesiredCount` | `3` | Set the number of target cluster proxy ecs tasks. In many cases it can be a good idea to keep this at 0 until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into existing cluster security groups by the migration 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). From adec3bdda5cb3b9e0daa7d9a136bf2ea0ecdfbc5 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Thu, 12 Jun 2025 18:12:18 -0500 Subject: [PATCH 02/13] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 41d981f04d7..11bf99890e2 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -127,7 +127,7 @@ Performing a live capture migration requires that a Capture Proxy be configured | `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. | -| `targetClusterProxyDesiredCount` | `3` | Set the number of target cluster proxy ecs tasks. In many cases it can be a good idea to keep this at 0 until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into existing cluster security groups by the migration security groups. | +| `targetClusterProxyDesiredCount` | `3` | Set the number of target cluster proxy Amazon ECS tasks. In most cases, keep this setting at `0` until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into the existing cluster security groups by the migration 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). From 5c8bd768b333c0f60579a292b3ce80bc2184884b Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Fri, 13 Jun 2025 09:39:07 -0500 Subject: [PATCH 03/13] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 11bf99890e2..041987dcd03 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -123,7 +123,7 @@ Performing a live capture migration requires that a Capture Proxy be configured | :--- | :--- | :--- | | `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` | `3` | Set the number of capture proxy ecs tasks. In many cases it can be a good idea to keep this at 0 until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into existing cluster security groups by the migration security groups. | +| `captureProxyDesiredCount` | `3` | Set the number of capture proxy Amazon ECS tasks. In most cases, keep this at 0 until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into the existing cluster security groups by the migration security groups. | | `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. | From 0ecda9fe808d49bc14c6072e5dfa0f63f7530ff0 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Fri, 13 Jun 2025 10:15:25 -0500 Subject: [PATCH 04/13] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../deploying-migration-assistant/configuration-options.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 041987dcd03..2ca054330b4 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -123,11 +123,11 @@ Performing a live capture migration requires that a Capture Proxy be configured | :--- | :--- | :--- | | `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` | `3` | Set the number of capture proxy Amazon ECS tasks. In most cases, keep this at 0 until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into the existing cluster security groups by the migration security groups. | +| `captureProxyDesiredCount` | `3` | Sets the number of capture 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. | | `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. | -| `targetClusterProxyDesiredCount` | `3` | Set the number of target cluster proxy Amazon ECS tasks. In most cases, keep this setting at `0` until after verifying connectivity with the source and target cluster in the migration console. After deploying the networking setup can be modified to allow ingress into the existing cluster security groups by the migration security groups. | +| `targetClusterProxyDesiredCount` | `3` | 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). From 08aa93d3d998215e6474d1131c7a0de864de0f47 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Fri, 27 Jun 2025 13:23:34 -0500 Subject: [PATCH 05/13] Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 2ca054330b4..cdc0a852766 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -98,7 +98,7 @@ The following sample CDK performs a live capture migration with C&R: } }, - "// settingsForCaptureAndReplay": "Enable the below services for live traffic capture and replay", + "// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay", "trafficReplayerServiceEnabled": true, "// help trafficReplayerExtraArgs": "Increase speedup factor in order replay requests at a faster rate to catchup", From a239d6c4a89f01b63c61a49f06fc765f0dc5238e Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 30 Jun 2025 12:34:43 -0500 Subject: [PATCH 06/13] Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../deploying-migration-assistant/configuration-options.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index cdc0a852766..0a486ea7cd9 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -101,10 +101,10 @@ The following sample CDK performs a live capture migration with C&R: "// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay", "trafficReplayerServiceEnabled": true, - "// help trafficReplayerExtraArgs": "Increase speedup factor in order replay requests at a faster rate to catchup", + "// help trafficReplayerExtraArgs": "Increase speedup factor in order replay requests at a faster rate to catch up", "trafficReplayerExtraArgs": "--speedup-factor 1.5", - "// help capture/target proxy pt. 1 of 2": "captureProxyService and targetClusterProxyService require networking access configured to successfully deploy,", + "// help capture/target proxy pt. 1 of 2": "captureProxyService and targetClusterProxyService require networking access to be configured in order to successfully deploy", "// help capture/target proxy pt. 2 of 2": "consider deploying without first and enabling after ensuring cluster networking access on the migration console", "captureProxyServiceEnabled": true, "captureProxyDesiredCount": 3, @@ -123,7 +123,7 @@ Performing a live capture migration requires that a Capture Proxy be configured | :--- | :--- | :--- | | `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` | `3` | Sets the number of capture 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. | +| `captureProxyDesiredCount` | `3` | 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. | | `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. | From e26a9b6e77d3610a53c668939dc021a0baf1b4e7 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Wed, 2 Jul 2025 09:21:19 -0500 Subject: [PATCH 07/13] Update _migration-assistant/deploying-migration-assistant/configuration-options.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 0a486ea7cd9..856abee9959 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -105,7 +105,7 @@ The following sample CDK performs a live capture migration with C&R: "trafficReplayerExtraArgs": "--speedup-factor 1.5", "// help capture/target proxy pt. 1 of 2": "captureProxyService and targetClusterProxyService require networking access to be configured in order to successfully deploy", - "// help capture/target proxy pt. 2 of 2": "consider deploying without first and enabling after ensuring cluster networking access on the migration console", + "// help capture/target proxy pt. 2 of 2": "Consider deploying without the proxy first. After verifying cluster network access in the migration console, you can enable the proxy.", "captureProxyServiceEnabled": true, "captureProxyDesiredCount": 3, "targetClusterProxyServiceEnabled": true, From d39ba85c9678136eced3deb382b059d1fb879799 Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Tue, 8 Jul 2025 10:44:51 -0500 Subject: [PATCH 08/13] Update example targetClusterProxyDesiredCount and captureProxyDesiredCount to be 0 Signed-off-by: Andre Kurait --- .../configuration-options.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 856abee9959..54190d2e697 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -119,15 +119,15 @@ The following sample CDK performs a live capture migration with C&R: 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). | -| `captureProxyDesiredCount` | `3` | 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. | -| `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. | -| `targetClusterProxyDesiredCount` | `3` | 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. | +| 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. | +| `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. | +| `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). From a2984c6b65b66d8e514c965db7555eda862fbdce Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Tue, 8 Jul 2025 10:50:37 -0500 Subject: [PATCH 09/13] Improve language on preventing failing deployments on capture/target proxy Signed-off-by: Andre Kurait --- .../deploying-migration-assistant/configuration-options.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 54190d2e697..ac0c0f1a63a 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -104,8 +104,8 @@ The following sample CDK performs a live capture migration with C&R: "// help trafficReplayerExtraArgs": "Increase speedup factor in order replay requests at a faster rate to catch up", "trafficReplayerExtraArgs": "--speedup-factor 1.5", - "// help capture/target proxy pt. 1 of 2": "captureProxyService and targetClusterProxyService require networking access to be configured in order to successfully deploy", - "// help capture/target proxy pt. 2 of 2": "Consider deploying without the proxy first. After verifying cluster network access in the migration console, you can enable the proxy.", + "// 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": "Consider deploying first with desired count as 0, then after verifying connection in migration console, redeploying with a higher desired count.", "captureProxyServiceEnabled": true, "captureProxyDesiredCount": 3, "targetClusterProxyServiceEnabled": true, From 1a5c546666ac4dc215990308bcfaeffcb1c55d88 Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Tue, 8 Jul 2025 12:08:35 -0500 Subject: [PATCH 10/13] Update _migration-assistant/deploying-migration-assistant/configuration-options.md Co-authored-by: Nathan Bower Signed-off-by: Andre Kurait --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index ac0c0f1a63a..1e03192baf0 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -123,7 +123,7 @@ Performing a live capture migration requires that a Capture Proxy be configured | :--- |:-----------------------------------------------------------------------| :--- | | `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. | +| `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. | | `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. | From dfd942e16297ae3b1d9cb65a2870c7fa5bb8b6f2 Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Tue, 8 Jul 2025 14:46:47 -0500 Subject: [PATCH 11/13] Update _migration-assistant/deploying-migration-assistant/configuration-options.md Co-authored-by: Nathan Bower Signed-off-by: Andre Kurait --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 1e03192baf0..0c44afefaab 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -101,7 +101,7 @@ The following sample CDK performs a live capture migration with C&R: "// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay", "trafficReplayerServiceEnabled": true, - "// help trafficReplayerExtraArgs": "Increase speedup factor in order replay requests at a faster rate to catch up", + "// 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.", From 5e6bc0e8bac703e68286ff108d370f933e312ce1 Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Tue, 8 Jul 2025 14:47:14 -0500 Subject: [PATCH 12/13] Update _migration-assistant/deploying-migration-assistant/configuration-options.md Co-authored-by: Nathan Bower Signed-off-by: Andre Kurait --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index 0c44afefaab..e75b098e2ae 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -105,7 +105,7 @@ The following sample CDK performs a live capture migration with C&R: "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": "Consider deploying first with desired count as 0, then after verifying connection in migration console, redeploying with a higher desired count.", + "// 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, From 0641445628f33a1bfba3ae08d8e454df9cb78e49 Mon Sep 17 00:00:00 2001 From: Andre Kurait Date: Tue, 8 Jul 2025 14:47:46 -0500 Subject: [PATCH 13/13] Update _migration-assistant/deploying-migration-assistant/configuration-options.md Co-authored-by: Nathan Bower Signed-off-by: Andre Kurait --- .../deploying-migration-assistant/configuration-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_migration-assistant/deploying-migration-assistant/configuration-options.md b/_migration-assistant/deploying-migration-assistant/configuration-options.md index e75b098e2ae..cfd1c5147c7 100644 --- a/_migration-assistant/deploying-migration-assistant/configuration-options.md +++ b/_migration-assistant/deploying-migration-assistant/configuration-options.md @@ -98,7 +98,7 @@ The following sample CDK performs a live capture migration with C&R: } }, - "// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay", + "// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay:", "trafficReplayerServiceEnabled": true, "// help trafficReplayerExtraArgs": "Increase the speedup factor to replay requests at a faster rate in order to catch up.",