Skip to content

Adding documentation for append only indices #9809

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RS146BIJAY
Copy link

@RS146BIJAY RS146BIJAY commented May 2, 2025

Description

Adding documentation for append only indices

Issues Resolved

Closes #9646

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented May 2, 2025

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws kolchfa-aws added v3.0.0 release-notes PR: Include this PR in the automated release notes labels May 2, 2025
@peterzhuamazon peterzhuamazon added the 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. label May 2, 2025
@kolchfa-aws kolchfa-aws removed the 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. label May 2, 2025
@Naarcha-AWS Naarcha-AWS added the 4 - Doc review PR: Doc review in progress label May 2, 2025
The following example request creates a new index named `my-append-only-index` which has all forms of updates disabled on it:

```json
PUT /my-append-only-index
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be through the cluster-settings API?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an index level setting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Append only index feature documentation
4 participants