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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 4 commits into from
Jun 14, 2024
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e7b8c36
[DOCS] Add the `read_pipeline` cluster privilege for winlogbeat and t…
herrBez May 9, 2024
e3f0d10
Merge branch '8.14' into mergify/bp/8.14/pr-38534
pierrehilbert May 20, 2024
66031aa
Merge branch '8.14' into mergify/bp/8.14/pr-38534
pierrehilbert Jun 3, 2024
3293233
Update users.asciidoc to fix the rendeing issue
herrBez Jun 13, 2024
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
View file
Open in desktop
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
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
rule `-{beat_default_index_prefix}-*` to the cluster settings
rule `+-{beat_default_index_prefix}-*+` to the cluster settings

This would render like the following:

Screenshot 2024-06-11 at 10 00 15 AM

Copy link
Contributor

Choose a reason for hiding this comment

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

I am not entirely sure on how to fix that. I think:
-{beat_default_index_prefix}-*
Should actually become:
+-{beat_default_index_prefix}-*+

@herrBez The suggestion above will add those + signs, if I understand correctly that that's what should be changed.

Copy link
Contributor

@herrBez herrBez Jun 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Sorry, I want it to render to (e.g., filebeat-*). How can I achieve that :)? ASCIIDoc and variables are not my forte.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I'm sorry! I misunderstood. I don't work with Beats much so I missed that {beat_default_index_prefix} is a variable. Variables won't be interpolated when they're inside backticks. So, I think the best we can do here is to take them out, like this:

rule {beat_default_index_prefix}-* to the cluster settings

Screenshot 2024-06-13 at 9 46 42 AM

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you, I guess I got it (it should be the same as on the one on the right). How are you doing the rendering ? (To avoid this problem in the future :) )

Copy link
Contributor

Choose a reason for hiding this comment

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

My pleasure Mirko! It looks good now.

To do the local rendering, you can:

Then, use any of the aliases in that file with --open. For example:

  • docbldfb --open - generates the Filebeat docs
  • docbldim --open - generates the Fleet & Agent Guide

Most docs builds take just a minute or two. The largest, for Elasticsearch docs (dodbldes --open) takes about five minutes.

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