Link Search Menu Expand Document Documentation Menu
Documentation

Accessing the migration console

The bootstrap box deployed through Migration Assistant contains a script that simplifies access to the migration console through that instance.

To access the migration console, use the following commands:

export STAGE=dev  # Use the same stage value from your cdk.context.json deployment
export AWS_REGION=us-west-2
/opensearch-migrations/deployment/cdk/opensearch-service-migration/accessContainer.sh migration-console ${STAGE} ${AWS_REGION}

Important: The STAGE value must match the stage parameter you used in your CDK context configuration. For example:

  • If you deployed with "stage": "test", use export STAGE=test.
  • If you deployed with "stage": "prod", use export STAGE=prod.
  • If you deployed with "stage": "dev", use export STAGE=dev.

When opening the console a message will appear above the command prompt, Welcome to the Migration Assistant Console.

On a machine with the AWS Command Line Interface (AWS CLI) and the AWS Session Manager plugin, you can directly connect to the migration console. Ensure that you’ve run aws configure with credentials that have access to the environment.

Use the following commands:

export STAGE=dev  # Match your deployment stage
export SERVICE_NAME=migration-console
export TASK_ARN=$(aws ecs list-tasks --cluster migration-${STAGE}-ecs-cluster --family "migration-${STAGE}-${SERVICE_NAME}" | jq --raw-output '.taskArns[0]')
aws ecs execute-command --cluster "migration-${STAGE}-ecs-cluster" --task "${TASK_ARN}" --container "${SERVICE_NAME}" --interactive --command "/bin/bash"

Stage configuration examples

For different deployment environments, adjust the stage accordingly:

# For test environment deployment
export STAGE=test
./accessContainer.sh migration-console test us-west-2

# For production environment deployment  
export STAGE=prod
./accessContainer.sh migration-console prod us-west-2

# For development environment deployment
export STAGE=dev
./accessContainer.sh migration-console dev us-west-2

The STAGE value corresponds to the stage parameter you specified in your AWS CDK context configuration during deployment.

350 characters left

Have a question? .

Want to contribute? or .