Skip to content

Add documentation for failure stores. #1368

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

Merged
merged 37 commits into from
Jun 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
b3f8af4
[WIP] Add documentation for failure stores.
jbaiera May 5, 2025
32d9336
Change ??? to "wip"
jbaiera May 6, 2025
356cd62
Fix wip links
jbaiera May 6, 2025
6c18018
fix wip please?
jbaiera May 6, 2025
075abe2
fix
jbaiera May 6, 2025
eac4005
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 8, 2025
dfbefc1
clarify that we do not redirect backpressure or version conflicts
jbaiera May 8, 2025
2019367
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 8, 2025
2847fe9
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 8, 2025
840a8be
suspended -> disabled
jbaiera May 8, 2025
1591e7b
reword document.source docs
jbaiera May 8, 2025
cec305f
clarify default retention application
jbaiera May 8, 2025
f1cb727
Add placeholder link for put data streams api
jbaiera May 8, 2025
28287fe
Mention flags in the intro
jbaiera May 8, 2025
08b2ac3
Note lazy creation
jbaiera May 8, 2025
e978f6e
edit configuration section for more clarity
jbaiera May 9, 2025
2db178a
mention override directly
jbaiera May 9, 2025
87f3a47
Add recipes to the failure store narrative docs
jbaiera May 28, 2025
3f0e7c6
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 29, 2025
0003ca2
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 29, 2025
39cf08f
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 29, 2025
7cb071e
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 29, 2025
2f4d026
Update manage-data/data-store/data-streams/failure-store.md
jbaiera May 29, 2025
1ac9c09
Apply suggestions from code review
jbaiera May 29, 2025
8869cda
Split recipes into sub-page
jbaiera May 29, 2025
959bfd8
Apply suggestions from code review
jbaiera May 30, 2025
fd8939e
typo
jbaiera May 30, 2025
ccda059
Update links and add privilege info
jbaiera Jun 2, 2025
86c4c7e
Update example
jbaiera Jun 2, 2025
c338df6
Merge branch 'main' into failure-store-docs
shainaraskas Jun 20, 2025
8675b51
Update manage-data/data-store/data-streams/failure-store.md
jbaiera Jun 25, 2025
3a88cc7
Updates for security docs
jbaiera Jun 24, 2025
d521fd7
Review comments
jbaiera Jun 25, 2025
72de0d1
Updates from docs team
jbaiera Jun 25, 2025
d741c52
Fix link
jbaiera Jun 26, 2025
9ba44ae
Merge branch 'main' into failure-store-docs
jbaiera Jun 26, 2025
a99f884
Apply suggestions from code review
shainaraskas Jun 26, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,9 @@ To learn how to assign privileges to a role, refer to [](/deploy-manage/users-ro
`manage_data_stream_lifecycle`
: All [Data stream lifecycle](../../../manage-data/lifecycle/data-stream.md) operations relating to reading and managing the built-in lifecycle of a data stream. This includes operations such as adding and removing a lifecycle from a data stream.

`manage_failure_store`
: All `monitor` privileges plus index and data stream administration limited to failure stores only. Only applies to data streams when accessing them via the [index component selector syntax](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md).

`manage_follow_index`
: All actions that are required to manage the lifecycle of a follower index, which includes creating a follower index, closing it, and converting it to a regular index. This privilege is necessary only on clusters that contain follower indices.

Expand Down Expand Up @@ -383,6 +386,8 @@ To learn how to assign privileges to a role, refer to [](/deploy-manage/users-ro

This privilege is not available in {{serverless-full}}.

`read_failure_store`
: Read-only access to actions performed on a data stream's failure store. Required for access to failure store data (count, explain, get, mget, get indexed scripts, more like this, multi percolate/search/termvector, percolate, scroll, clear_scroll, search, suggest, tv). Only applies to data streams when accessing them via the [index component selector syntax](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md).

`view_index_metadata`
: Read-only access to index and data stream metadata (aliases, exists, field capabilities, field mappings, get index, get data stream, ilm explain, mappings, search shards, settings, validate query). This privilege is available for use primarily by {{kib}} users.
Expand Down
Loading
Loading