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

[8.13](backport #38534) [DOCS] Add the read_pipeline cluster privilege to winlogbeat documentation #39490

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion libbeat/docs/security/api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ POST /_security/api_key
"index": [
{
"names": ["{beat_default_index_prefix}-*"],
"privileges": ["view_index_metadata", "create_doc"]
"privileges": ["view_index_metadata", "create_doc", "auto_configure"]
}
]
}
Expand Down
19 changes: 17 additions & 2 deletions libbeat/docs/security/users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,9 @@ To grant the required privileges:
. Create a *writer role*, called something like +{beat_default_index_prefix}_writer+,
that has the following privileges:
+
NOTE: The `monitor` cluster privilege and the `create_doc` privilege on
+{beat_default_index_prefix}-*+ indices are required in every configuration.
NOTE: The `monitor` cluster privilege and the `create_doc` and `auto_configure`
privileges on +{beat_default_index_prefix}-*+ indices are required in every
configuration.
+
[options="header"]
|====
Expand All @@ -259,10 +260,24 @@ ifeval::["{beatname_lc}"=="filebeat"]
|Check for ingest pipelines used by modules. Needed when using modules.
endif::[]

ifeval::["{beatname_lc}"=="winlogbeat"]
|Cluster
|`read_pipeline`
|Check for ingest pipelines used by {beatname_uc}.
endif::[]

|Index
|`create_doc` on +{beat_default_index_prefix}-*+ indices
|Write events into {es}

|Index
|`auto_configure` on +{beat_default_index_prefix}-*+ indices
|Update the datastream mapping. Consider either disabling entirely or adding the
rule `-{beat_default_index_prefix}-*` to the cluster settings
https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#index-creation[action.auto_create_index]
to prevent unwanted indices creations from the agents.
|====

ifndef::apm-server[]
+
Omit any privileges that aren't relevant in your environment.
Expand Down
Loading