update documentation for managed service migrations using migration assistant #9338
Conversation
jugal-chauhan
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
Signed-off-by: Jugal Chauhan <[email protected]>
| @@ -145,10 +145,16 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, | |||
| } | |||
| }, | |||
| "reindexFromSnapshotExtraArgs": "<RFS PARAMETERS (see below)>", | |||
| "reindexFromSnapshotServiceEnabled": true, | |||
| "reindexFromSnapshotMaxShardSizeGiB": 80, | |||
| "trafficReplayerServiceEnabled": true, | |||
There was a problem hiding this comment.
This quickstart outlines how to deploy Migration Assistant for OpenSearch and execute an existing data migration using
Reindex-from-Snapshot(RFS).
Per the top of the doc, we should not enable the replayer or capture proxy.
| "otelCollectorEnabled": true, | ||
| "migrationConsoleServiceEnabled": true, | ||
| "reindexFromSnapshotServiceEnabled": true, | ||
| "migrationAssistanceEnabled": true | ||
| "migrationAssistanceEnabled": true, |
There was a problem hiding this comment.
This flag is enabled by default, lets keep this context defintion as simple as possible and remove this value.
| @@ -145,10 +145,16 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, | |||
| } | |||
| }, | |||
| "reindexFromSnapshotExtraArgs": "<RFS PARAMETERS (see below)>", | |||
| "reindexFromSnapshotServiceEnabled": true, | |||
There was a problem hiding this comment.
This flag is enabled by default, lets keep this context definition as simple as possible and remove this value.
| @@ -145,10 +145,16 @@ Use the following steps to configure and deploy RFS, deploy Migration Assistant, | |||
| } | |||
| }, | |||
| "reindexFromSnapshotExtraArgs": "<RFS PARAMETERS (see below)>", | |||
| "reindexFromSnapshotServiceEnabled": true, | |||
| "reindexFromSnapshotMaxShardSizeGiB": 80, | |||
There was a problem hiding this comment.
👍 I think this could be useful to leave in since it makes obvious what the max shard size is, and if the user runs into trouble this might help them fix it.
| "reindexFromSnapshotServiceEnabled": true, | ||
| "migrationAssistanceEnabled": true | ||
| "migrationAssistanceEnabled": true, | ||
| "targetClusterProxyServiceEnabled": true, |
There was a problem hiding this comment.
Also per the top of the doc, lets not include any proxy or replayer settings
| 3. **Managed Service Role Mapping (Cross-Managed Migrations)** | ||
|
|
||
| When migrating between two managed clusters (for ex. both domains created using Amazon OpenSearch Service): | ||
| 1. Locate these IAM roles created during the CDK deployment and copy their ARN: |
There was a problem hiding this comment.
"Locate" isn't obvious, lets tell the user to open the cloud formation and find the IAM roles in that list, could you update with more specific instructions?
| - under "Mapped users", add each ARN as a backend role | ||
| - Save changes | ||
|
|
||
| *Note: This grants the migration assistant components necessary permissions to modify both source and target managed clusters.* |
There was a problem hiding this comment.
This seems like the reason to perform this step 3, lets rewrite this line to the top and make it clear the purpose e.g. "Provide Migration Assistant roles with access to the source and target clusters."
| 1. **Bucket Permissions** | ||
| Confirm the `OSMigrations-dev-<region>-CustomS3AutoDeleteObjects` stack has S3 object deletion rights. |
There was a problem hiding this comment.
? Why is this needed, shouldn't this already be done with the CDK setup assuming you use the S3 bucket that MA created?
jugal-chauhan
force-pushed
the
managed-service-migration-doc-updates
branch
from
9e30d34 to
a124749
Compare
Description
This PR improves documentation for managed service-to-service migrations by:
cdk.context.jsonMigrationServiceTaskRole,reindexfromsnapshotTaskRole, andtrafficreplayerdefaultTaskRoleReviewer Request
@peternied, could you review this PR from the migrations team perspective?
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.