Skip to content

[Fix] Migration Assistant docs on uploading basic AUTH with AWS Secrets #11552

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[Fix] Migration Assistant docs on uploading basic AUTH with AWS Secrets #11552

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d64952d
Add comment for clarity, fix spacing and fix layout of secrets for ba…
jugal-chauhan Nov 14, 2025
0a85089
Remove default options to avoid confusion for the reader
jugal-chauhan Nov 14, 2025
e7f2185
Merge remote-tracking branch 'origin/main' into fix-doc-auth-secrets
jugal-chauhan Nov 14, 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
11 changes: 11 additions & 0 deletions _migration-assistant/migration-phases/deploy/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ The following CDK performs a backfill migrations using RFS:
"userSecretArn": <SECRET_WITH_USERNAME_AND_PASSWORD_KEYS>
}
},
"// 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"
Expand Down Expand Up @@ -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,

Expand Down
14 changes: 7 additions & 7 deletions _migration-assistant/migration-phases/deploy/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,16 +163,18 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant,
},
"reindexFromSnapshotExtraArgs": "<RFS PARAMETERS (see below)>",
"reindexFromSnapshotMaxShardSizeGiB": 80,
"otelCollectorEnabled": true,
"migrationConsoleServiceEnabled": true
"// Note": "The following three options are true by default:",
"migrationAssistanceEnabled": true,
"migrationConsoleServiceEnabled": true,
"otelCollectorEnabled": true
}
}
```
{% include copy.html %}

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:

Expand All @@ -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"
}
}
},
Expand Down