From d64952d93d3208942f6398ea71ac341417119efb Mon Sep 17 00:00:00 2001 From: Jugal Chauhan Date: Fri, 14 Nov 2025 10:52:48 -0600 Subject: [PATCH 1/2] Add comment for clarity, fix spacing and fix layout of secrets for basic auth Signed-off-by: Jugal Chauhan --- .../deploy/configuration-options.md | 11 +++++++++++ .../migration-phases/deploy/index.md | 14 +++++++------- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/_migration-assistant/migration-phases/deploy/configuration-options.md b/_migration-assistant/migration-phases/deploy/configuration-options.md index 9fe37d57801..c005c493e33 100644 --- a/_migration-assistant/migration-phases/deploy/configuration-options.md +++ b/_migration-assistant/migration-phases/deploy/configuration-options.md @@ -60,6 +60,12 @@ The following CDK performs a backfill migrations using RFS: "userSecretArn": } }, + "// Note": "The following three options are true by default:", + "migrationAssistanceEnabled": true, + "migrationConsoleServiceEnabled": true, + "otelCollectorEnabled": true, + + "// Note": "Additional options specific to this migration type:", "reindexFromSnapshotServiceEnabled": true, "reindexFromSnapshotExtraArgs": "", "artifactBucketRemovalPolicy": "DESTROY" @@ -102,6 +108,11 @@ The following sample CDK performs a live capture migration with C&R: } }, + "// Note": "The following three options are true by default:", + "migrationAssistanceEnabled": true, + "migrationConsoleServiceEnabled": true, + "otelCollectorEnabled": true, + "// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay:", "trafficReplayerServiceEnabled": true, diff --git a/_migration-assistant/migration-phases/deploy/index.md b/_migration-assistant/migration-phases/deploy/index.md index 72df2f3a1a9..0ea7f241ac1 100644 --- a/_migration-assistant/migration-phases/deploy/index.md +++ b/_migration-assistant/migration-phases/deploy/index.md @@ -163,8 +163,10 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, }, "reindexFromSnapshotExtraArgs": "", "reindexFromSnapshotMaxShardSizeGiB": 80, - "otelCollectorEnabled": true, - "migrationConsoleServiceEnabled": true + "// Note": "The following three options are true by default:", + "migrationAssistanceEnabled": true, + "migrationConsoleServiceEnabled": true, + "otelCollectorEnabled": true } } ``` @@ -172,7 +174,7 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, The source and target cluster authorization can be configured to have no authorization, `basic` with a username and password, or `sigv4`. - ### Environment configuration examples +### Environment configuration examples To avoid conflicts with existing deployments, consider using different context IDs and stage names: @@ -188,16 +190,14 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, "version": "ES_7.10", "auth": { "type": "basic", - "username": "admin", - "passwordFromSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:migration-source-password" + "userSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:migration-source-password" } }, "targetCluster": { "endpoint": "https://migration-target-os219.us-west-2.es.amazonaws.com", "auth": { "type": "basic", - "username": "admin", - "passwordFromSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:migration-target-password" + "userSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:migration-target-password" } } }, From 0a85089e7be618dbfedad53f53e8d6863c8fb1c8 Mon Sep 17 00:00:00 2001 From: Jugal Chauhan Date: Fri, 14 Nov 2025 15:34:12 -0600 Subject: [PATCH 2/2] Remove default options to avoid confusion for the reader Signed-off-by: Jugal Chauhan --- .../migration-phases/deploy/configuration-options.md | 11 ----------- _migration-assistant/migration-phases/deploy/index.md | 10 +--------- 2 files changed, 1 insertion(+), 20 deletions(-) diff --git a/_migration-assistant/migration-phases/deploy/configuration-options.md b/_migration-assistant/migration-phases/deploy/configuration-options.md index c005c493e33..9fe37d57801 100644 --- a/_migration-assistant/migration-phases/deploy/configuration-options.md +++ b/_migration-assistant/migration-phases/deploy/configuration-options.md @@ -60,12 +60,6 @@ The following CDK performs a backfill migrations using RFS: "userSecretArn": } }, - "// Note": "The following three options are true by default:", - "migrationAssistanceEnabled": true, - "migrationConsoleServiceEnabled": true, - "otelCollectorEnabled": true, - - "// Note": "Additional options specific to this migration type:", "reindexFromSnapshotServiceEnabled": true, "reindexFromSnapshotExtraArgs": "", "artifactBucketRemovalPolicy": "DESTROY" @@ -108,11 +102,6 @@ The following sample CDK performs a live capture migration with C&R: } }, - "// Note": "The following three options are true by default:", - "migrationAssistanceEnabled": true, - "migrationConsoleServiceEnabled": true, - "otelCollectorEnabled": true, - "// settingsForCaptureAndReplay": "Enable the following services for live traffic capture and replay:", "trafficReplayerServiceEnabled": true, diff --git a/_migration-assistant/migration-phases/deploy/index.md b/_migration-assistant/migration-phases/deploy/index.md index 0ea7f241ac1..d663dea0ebd 100644 --- a/_migration-assistant/migration-phases/deploy/index.md +++ b/_migration-assistant/migration-phases/deploy/index.md @@ -162,11 +162,7 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, } }, "reindexFromSnapshotExtraArgs": "", - "reindexFromSnapshotMaxShardSizeGiB": 80, - "// Note": "The following three options are true by default:", - "migrationAssistanceEnabled": true, - "migrationConsoleServiceEnabled": true, - "otelCollectorEnabled": true + "reindexFromSnapshotMaxShardSizeGiB": 80 } } ``` @@ -182,8 +178,6 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, { "test-deploy": { "stage": "test", - "migrationAssistanceEnabled": true, - "migrationConsoleServiceEnabled": true, "reindexFromSnapshotServiceEnabled": true, "sourceCluster": { "endpoint": "https://migration-source-es710.us-west-2.es.amazonaws.com", @@ -203,8 +197,6 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, }, "prod-deploy": { "stage": "prod", - "migrationAssistanceEnabled": true, - "migrationConsoleServiceEnabled": true, "reindexFromSnapshotServiceEnabled": true, "// ... additional production-specific configuration" }