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 Create Snapshot API documentation with Snapshot Interoperability w/ Remote Store related changes #4599

Closed
1 of 4 tasks
harishbhakuni opened this issue Jul 21, 2023 · 0 comments · Fixed by #4977
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.
Create Snapshot API Response Fields: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/#response-fields

With Snapshot Interoperability Feature, we will have a new field in Create Snapshot API response which will determine if a snapshot was shallow copy or full copy.

Field Data type Description
remote_store_index_shallow_copy boolean Whether current snapshot is full copy or shallow copy.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Related PR for code changes: opensearch-project/OpenSearch#7118
Design Document: opensearch-project/OpenSearch#6575

changes for this feature are already in 2.9 behind remote store experimental flag. to test, first bring up the opensearch node with 2.9 version, enable remote store feature. Update Repository setting with new flag as mentioned in #4598 and then a new snapshot response should have flag remote_store_index_shallow_copy as true.

Sample Response

curl -X PUT "localhost:9200/_snapshot/fullCopyRepository/full_snap10?wait_for_completion=true&pretty"
{
  "snapshot" : {
    "snapshot" : "full_snap",
    "uuid" : "06fAWrFURQmijsKJlSuNcg",
    "version_id" : 137217827,
    "version" : "3.0.0",
    "remote_store_index_shallow_copy" : false,
    "indices" : [
      "testidx-rs"
    ],
    "data_streams" : [ ],
    "include_global_state" : true,
    "state" : "SUCCESS",
    "start_time" : "2023-07-11T04:21:26.754Z",
    "start_time_in_millis" : 1689049286754,
    "end_time" : "2023-07-11T04:21:26.754Z",
    "end_time_in_millis" : 1689049286754,
    "duration_in_millis" : 0,
    "failures" : [ ],
    "shards" : {
      "total" : 5,
      "failed" : 0,
      "successful" : 5
    }
  }
}
@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 added this to the v2.10 milestone Aug 1, 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