Skip to content

Existing S3 Snapshot Repo Configuration

Tanner Lewis edited this page Nov 8, 2024 · 4 revisions

This page lays out additional configuration that is necessary for configuring the Migration tooling to use an existing S3 snapshot repository

Configuration Options

Before deployment, the CDK context options should specify the desired existing S3 snapshot repository to use for Reindex-from-Snapshot

Name Example Description
<BUCKET_NAME> app-us-east-1-bucket The name of the existing S3 bucket
<REPOSITORY_PATH> app-repo The path used by the source cluster snapshot repository to store snapshots
<SOURCE_VERSION> ES_7_17 The source cluster version in the format in the format of OS_x_y or ES_x_y
<AWS_REGION> us-east-1 The AWS region of the S3 bucket
<SNAPSHOT_NAME> app-snapshot The name of the existing snapshot in the source cluster snapshot repository, or the name that will be used if creating a new snapshot (default is rfs-snapshot)
{
  "default": {
    ...
    "reindexFromSnapshotServiceEnabled": true,
    "reindexFromSnapshotExtraArgs": "--s3-repo-uri s3://<BUCKET_NAME>/<REPOSITORY_NAME> --source-version <SOURCE_VERSION> --s3-region <AWS_REGION> --snapshot-name <SNAPSHOT_NAME>"
  }
}

IAM Role Updates

After deployment,

Migration Console YAML Updates

After deployment, the migration_services.yaml on the migration-console will need to be updated in order to perform any metadata migrations as well as create any new snapshots in the existing S3 snapshot repository.

  1. Access the Migration Console
Clone this wiki locally