-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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.14](backport #38534) [DOCS] Add the read_pipeline
cluster privilege to winlogbeat documentation
#39491
Conversation
…he `auto_configure` index privilege to beats documentation (#38534) * [DOCS] Removed reference to the Stack GS (#32119) * Update users.asciidoc Add the "read_pipeline" privilege for Winlogbeat too * [Docs] add auto_configure index privilege to the required permissions for beat agents * Update link that was broken --------- Co-authored-by: debadair <[email protected]> Co-authored-by: Andrew Kroh <[email protected]> (cherry picked from commit edf4568)
This pull request doesn't have a |
This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏 |
Hi there, As I reported https://github.com/elastic/beats/pull/38534/files I noticed a rendering error I am not entirely sure on how to fix that. I think: |
This pull request is now in conflicts. Could you fix it? 🙏
|
This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏 |
This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏 |
1 similar comment
This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏 |
This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏 |
@kilfoyle could you please have a look here? |
libbeat/docs/security/users.asciidoc
Outdated
|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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 :) )
There was a problem hiding this comment.
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:
- clone the elastic/docs repo
- have this doc_build_aliases file in the root of your local github directory
Then, use any of the aliases in that file with --open
. For example:
docbldfb --open
- generates the Filebeat docsdocbldim --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.
Add the "read_pipeline" privilege to the Grant privileges and roles needed for publishing documentation as reported in the Grant access using API keys.
Proposed commit message
[Winlogbeat][Doc] Add
read_pipeline
cluster privilege to winlogbeatChecklist
CHANGELOG.next.asciidoc
orCHANGELOG-developer.next.asciidoc
.Author's Checklist
How to test this PR locally
Related issues
Use cases
Adhere to the least privilege principles
Screenshots
Logs
This is an automatic backport of pull request #38534 done by [Mergify](https://mergify.com).