Link Search Menu Expand Document Documentation Menu

You're viewing the current version of Migration Assistant documentation (Kubernetes-based). For the classic ECS/CDK-based version, see the classic documentation.

Migration Assistant playbooks

Playbooks are step-by-step migration guides for specific source and target combinations. Each playbook provides the complete sequence of commands and configuration required for that migration path.

Prerequisites

Before using a playbook, ensure the following prerequisites are met:

  • Migration Assistant is deployed on a Kubernetes platform (Amazon EKS on AWS, Google Kubernetes Engine on GCP, or any other Kubernetes cluster).
  • You have determined whether your migration requires planned downtime or zero downtime.
  • You have loaded the version-matched sample configuration by running workflow configure sample --load.

Using a playbook

To use a playbook, follow these steps:

  1. Choose the playbook that matches your source and target.
  2. Follow the prerequisite checklist before editing the workflow.
  3. Run a pilot migration first.
  4. After the pilot migration succeeds, run the full migration.

Available playbooks

The following table lists the available playbooks.

Playbook Use case
Elasticsearch 6.8 to OpenSearch 3.5 Self-managed Elasticsearch sources requiring metadata transformation and snapshot-based backfill
Amazon OpenSearch Service to OpenSearch Serverless NextGen Managed AWS sources targeting Serverless NextGen collections
Solr 8.11 to OpenSearch 3 Solr snapshot-based backfill to OpenSearch

Deploy Migration Assistant before following a playbook. Choose the deployment path for your environment:

350 characters left

Have a question? .

Want to contribute? or .