Skip to content
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

[DOC] Update Snapshot Restore API Documentation with Snapshot Interoperability w/ Remote Store Changes. #4600

Closed
1 of 4 tasks
harishbhakuni opened this issue Jul 21, 2023 · 0 comments · Fixed by #4977
Closed
1 of 4 tasks
Assignees
Labels
3 - Done Issue is done/complete Sev2 High-medium priority. Upcoming release or incorrect information. snapshots v2.10.0
Milestone

Comments

@harishbhakuni
Copy link

harishbhakuni commented Jul 21, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
For our new feature Snapshot Interoperability w/ Remote Store, we need to update the request fields for Restore Snapshot API with a new field remote_store_index_shallow_copy:

Parameter Data type Description
source_remote_store_repository String Remote Store Repository name of source indices which are being restored, if it was modified after snapshot creation. Optional.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
For testing, follow the steps mentioned in this doc to create shallow copy snapshot: #4599.
After taking snapshot, change repository name for remote store repo. Now, normal snapshot would fail for remote store indices, but if the updated repository name is passed as shown in below example, snapshot restore would work fine.

Sample Request:

curl -X POST "localhost:9200/_snapshot/shallowCopyRepository/shallow_snap/_restore?wait_for_completion=true" -H 'Content-Type: application/json' -d'
{
  "indices": "testidx-dr",
  "rename_pattern": "(.+)",
  "rename_replacement": "restored_shallow-$0",
  "source_remote_store_repository": "remoteStoreRepoUpdated"
}
'
@harishbhakuni harishbhakuni changed the title [DOC] [DOC] Update Snapshot Restore API Documentation with Snapshot Interoperability w/ Remote Store Changes. Jul 21, 2023
@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started v2.10.0 snapshots and removed untriaged labels Aug 1, 2023
@Naarcha-AWS Naarcha-AWS self-assigned this Aug 1, 2023
@hdhalter hdhalter added this to the v2.10 milestone Aug 9, 2023
@hdhalter hdhalter added the Sev2 High-medium priority. Upcoming release or incorrect information. label Aug 25, 2023
@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Sep 13, 2023
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete Sev2 High-medium priority. Upcoming release or incorrect information. snapshots v2.10.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants