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] Documentation changes for Snapshot Status API for 2.17 and above #8231

Closed
1 of 4 tasks
ltaragi opened this issue Sep 12, 2024 · 0 comments · Fixed by #8235
Closed
1 of 4 tasks

[DOC] Documentation changes for Snapshot Status API for 2.17 and above #8231

ltaragi opened this issue Sep 12, 2024 · 0 comments · Fixed by #8235
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.17.0

Comments

@ltaragi
Copy link
Contributor

ltaragi commented Sep 12, 2024

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.
This documentation change addresses the necessary changes to Snapshot Status API as part of V2 snapshots:

  • Allow index filter in the status API if the request contains only one snapshot name. Thus, the status API response will only consist of the specified indices in the filter (if any).
  • For non-shallow-V2 snapshots:
    • The status API call works only if the total number of shards across the requested resources (snapshots or the indices of a particular snapshot) is less than a certain amount determined by the cluster setting snapshot.max_shards_allowed_in_status_api
  • For shallow snapshots of type V2, the file count and size stats are 0 at all levels. For these snapshots, snapshot.max_shards_allowed_in_status_api cluster setting is not honoured

*Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
2.17 and above

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
PR for the mentioned changes - opensearch-project/OpenSearch#15463

@ltaragi ltaragi self-assigned this Sep 12, 2024
@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.17.0
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants