Extend Snapshot Creation with Local Download Support

Start date

Description

Extend the existing snapshot creation command to include the capability to take and store a snapshot at a user defined S3 Snapshot Repo. User executes this command from within the migration console - this will allow users to download snapshots on their local environment and prepare them for dashboard migration.

Since the snapshot already captures the .kibana index, a decision needs to be made to continue with console snapshot create supporting additional parameters, or a specific dashboards-related command support using console snapshot create --capture-dashboards

A user should be able to provide details using command line arguments like --repo-name, --size-per-index, and --include-signed-url.

Background

The “size-per-index“ is expected to be greater than equal to the size of .kibana index on the source. We want a snapshot such that it has ALL .kibana documents while it just has a fewer documents/data from the other data indexes. Reason for this is that we show users how their existing dashboards looked like with less data, and how the migrated dashboards are going to look like with this same data (from snapshot).
#2439 : will launch a replicated source kibana to display the user
#2440 : will launch a local target opensearch-dashboards to provide preview to the user
Both of these stages will retain the limited data documents from the custom snapshot, while having all content for .kibana index.

 

AC

  • command successfully creates a snapshot containing all indices

  • command uploads snapshot on specific --repo-name path for a new S3 Repo

  • command returns a signed URL that allows for temporary download access when --include-signed-url is passed

  • proper error handling for connectivity or permission issues

Activity

Show:
Pro tip: press M to comment
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Story Points

Fix versions

Priority

Created March 18, 2025 at 7:19 AM
Updated April 15, 2025 at 2:42 PM