From ae9125cefd9d3c59e232aa73dd2fa356011d8694 Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Tue, 22 Jul 2025 15:28:11 -0400 Subject: [PATCH 1/3] add availability information and port over privileges --- docs/reference/elasticsearch/rest-apis/api-conventions.md | 7 +++++-- docs/reference/elasticsearch/security-privileges.md | 5 +++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/reference/elasticsearch/rest-apis/api-conventions.md b/docs/reference/elasticsearch/rest-apis/api-conventions.md index 35b068e4603df..5ba1e7720064d 100644 --- a/docs/reference/elasticsearch/rest-apis/api-conventions.md +++ b/docs/reference/elasticsearch/rest-apis/api-conventions.md @@ -421,7 +421,10 @@ GET /_nodes/ra*:2 GET /_nodes/ra*:2* ``` -### Component Selectors [api-component-selectors] +### Component selectors [api-component-selectors] +```{applies_to} +stack: ga 9.1 +``` A data stream component is a logical grouping of indices that help organize data inside a data stream. All data streams contain a `data` component by default. The `data` component comprises the data stream's backing indices. When searching, managing, or indexing into a data stream, the `data` component is what you are interacting with by default. @@ -429,7 +432,7 @@ Some data stream features are exposed as additional components alongside its `da Some APIs that accept a ``, ``, or `` request path parameter also support *selector syntax* which defines which component on a data stream the API should operate on. To use a selector, it is appended to the index or data stream name. Selectors can be combined with other index pattern syntax like [date math](#api-date-math-index-names) and wildcards. -There are currently two selector suffixes supported by {{es}} APIs: +There are two selector suffixes supported by {{es}} APIs: `::data` : Refers to a data stream's backing indices containing regular data. Data streams always contain a data component. diff --git a/docs/reference/elasticsearch/security-privileges.md b/docs/reference/elasticsearch/security-privileges.md index ae3438cec16c6..9920225a458d1 100644 --- a/docs/reference/elasticsearch/security-privileges.md +++ b/docs/reference/elasticsearch/security-privileges.md @@ -359,6 +359,9 @@ This section lists the privileges that you can assign to a role. `manage_data_stream_lifecycle` : All [Data stream lifecycle](docs-content://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` {applies_to}`stack: ga 9.1` +: 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. @@ -388,6 +391,8 @@ This section lists the privileges that you can assign to a role. This privilege is not available in {{serverless-full}}. +`read_failure_store` {applies_to}`stack: ga 9.1` +: 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. From a00e6f3e80a2f300d6b5b491cc3fa7280515494f Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Tue, 22 Jul 2025 15:51:27 -0400 Subject: [PATCH 2/3] change to internal links --- docs/reference/elasticsearch/security-privileges.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/elasticsearch/security-privileges.md b/docs/reference/elasticsearch/security-privileges.md index 9920225a458d1..e5b7af0d81d74 100644 --- a/docs/reference/elasticsearch/security-privileges.md +++ b/docs/reference/elasticsearch/security-privileges.md @@ -360,7 +360,7 @@ This section lists the privileges that you can assign to a role. : All [Data stream lifecycle](docs-content://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` {applies_to}`stack: ga 9.1` -: 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). +: 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](/reference/elasticsearch/rest-apis/api-conventions.md#api-component-selectors). `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. @@ -392,7 +392,7 @@ This section lists the privileges that you can assign to a role. This privilege is not available in {{serverless-full}}. `read_failure_store` {applies_to}`stack: ga 9.1` -: 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). +: 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](/reference/elasticsearch/rest-apis/api-conventions.md#api-component-selectors). `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. From 96c5186cf4be11dae40ae57673e87e300977c067 Mon Sep 17 00:00:00 2001 From: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Date: Fri, 25 Jul 2025 13:03:46 -0400 Subject: [PATCH 3/3] grammar, no latinisms Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> --- docs/reference/elasticsearch/security-privileges.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/elasticsearch/security-privileges.md b/docs/reference/elasticsearch/security-privileges.md index e5b7af0d81d74..017eda84d6253 100644 --- a/docs/reference/elasticsearch/security-privileges.md +++ b/docs/reference/elasticsearch/security-privileges.md @@ -360,7 +360,7 @@ This section lists the privileges that you can assign to a role. : All [Data stream lifecycle](docs-content://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` {applies_to}`stack: ga 9.1` -: 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](/reference/elasticsearch/rest-apis/api-conventions.md#api-component-selectors). +: All `monitor` privileges plus index and data stream administration limited to failure stores only. Applies only to data streams when accessed through the [index component selector syntax](/reference/elasticsearch/rest-apis/api-conventions.md#api-component-selectors). `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. @@ -392,7 +392,7 @@ This section lists the privileges that you can assign to a role. This privilege is not available in {{serverless-full}}. `read_failure_store` {applies_to}`stack: ga 9.1` -: 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](/reference/elasticsearch/rest-apis/api-conventions.md#api-component-selectors). +: 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). Applies only to data streams when accessed through the [index component selector syntax](/reference/elasticsearch/rest-apis/api-conventions.md#api-component-selectors). `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.