Skip to content

Updated Is "Migration Right for you?" page and some dependencies #10158

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.

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 15 commits into
base: main
Choose a base branch
from

Conversation

sumobrian
Copy link
Collaborator

@sumobrian sumobrian commented Jun 29, 2025

Description

This update consolidates and improves content across multiple documentation pages related to Migration Assistant. Key changes include:

Replaces outdated and redundant prerequisites in the Getting Started guide with a link to “Is Migration Assistant right for you?” page.

Rewrites and clarifies the purpose of the “Is Migration Assistant right for you?” page:

Improves opening rationale

  • Introduces a new assumptions and limitations section grouped into General, Reindex-from-Snapshot, and Capture-and-Replay

  • Updates migration path matrix heading for clarity

  • Replaces hardcoded AWS Region list with a link to the authoritative AWS documentation

  • Renames “Supported components” section to “Supported features” and uses clearer column headers

  • Refactors checklist for conciseness and use-case alignment

Fixes ordering issue in the sidebar nav items list for the Overview section

Issues Resolved

https://opensearch.atlassian.net/browse/MIGRATIONS-2618

Version

N/A

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
…cluded in a seperate migration patterns page. Updated checklist.

Signed-off-by: Brian Presley <bjpres@amazon.com>
Copy link

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.

Copy link
Contributor

@jugal-chauhan jugal-chauhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve of these changes as marked in the PR.

Note to include these in a follow-up PR based on 'Execution'

  • Snapshots must include global cluster state (include_global_stateistrue)
  • User should perform a successful console metadata migrate before performing console backfill start or else RFS will create new indices with default mappings on the target cluster.
  • User should know when not to use Traffic Replayer during deployment
  • Point users to our RFS CloudWatch Dashboard on Step 11 to help validate work done by RFS, during Execution

Signed-off-by: Brian Presley <bjpres@amazon.com>
- If deploying Migration Assistant into an existing AWS VPC, you must configure VPC interface endpoints and IAM permissions for the following AWS services:
- **Amazon CloudWatch Logs** – for log ingestion from ECS tasks.
- **Amazon CloudWatch** – for metrics published during migration
- **Amazon Elastic Container Registry (ECR)** – for pulling container images.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this enough detail for customers? there are two ECR endpoints
com.amazonaws.region.ecr.dkr and com.amazonaws.region.ecr.api, we need the former to pull images not the later

https://docs.aws.amazon.com/AmazonECR/latest/userguide/vpc-endpoints.html#ecr-setting-up-vpc-create

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a level of detail that should be included on another page. On this page I'd like customers to think about the access that they will need.

sumobrian added 7 commits July 7, 2025 15:49
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
- **Amazon Elastic File System (Amazon EFS)** – Stores persistent logs.
- **Amazon Managed Streaming for Apache Kafka** – *(`Capture-and-Replay` only)* - Used as a durable storage to capture and replay HTTP live traffic.
- **Amazon S3** – Stores and retrieves snapshots and artifacts.
- **AWS Elastic Load Balancing (ELB)** – *(Capture-and-Replay only)* – Used by the Migration Console to connect to the Application Load Balancer (ALB).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Duplicated between ELB and ALB in this list

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AndreKurait @sumobrian Global editorial note: Please use "Elastic Load Balancing" (not ELB) and "Application Load Balancer" (without ALB) in all instances. Related resources include Network Load Balancer, Gateway Load Balancer, and Classic Load Balancer. Use just "load balancer" when referencing the common noun.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated references and noted for future changes. I left the acronym in parenthesis since often users are more familiar with the acronym.

sumobrian added 4 commits July 8, 2025 12:41
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Signed-off-by: Brian Presley <bjpres@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants