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.14](backport #38534) [DOCS] Add the read_pipeline cluster privilege to winlogbeat documentation #39491

Merged
merged 4 commits into from
Jun 14, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 9, 2024

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 winlogbeat

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-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).

…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)
@mergify mergify bot requested a review from a team as a code owner May 9, 2024 14:49
@mergify mergify bot requested review from rdner and fearful-symmetry and removed request for a team May 9, 2024 14:49
@mergify mergify bot added the backport label May 9, 2024
@mergify mergify bot assigned herrBez May 9, 2024
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label May 9, 2024
@botelastic
Copy link

botelastic bot commented May 9, 2024

This pull request doesn't have a Team:<team> label.

Copy link
Contributor Author

mergify bot commented May 13, 2024

This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏

@herrBez
Copy link
Contributor

herrBez commented May 13, 2024

Hi there,

As I reported https://github.com/elastic/beats/pull/38534/files I noticed a rendering error
image in the version https://www.elastic.co/guide/en/beats/filebeat/master/privileges-to-publish-events.html.

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

Copy link
Contributor Author

mergify bot commented May 14, 2024

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b mergify/bp/8.14/pr-38534 upstream/mergify/bp/8.14/pr-38534
git merge upstream/8.14
git push upstream mergify/bp/8.14/pr-38534

Copy link
Contributor Author

mergify bot commented May 20, 2024

This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏

Copy link
Contributor Author

mergify bot commented May 27, 2024

This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏

1 similar comment
Copy link
Contributor Author

mergify bot commented Jun 3, 2024

This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏

Copy link
Contributor Author

mergify bot commented Jun 10, 2024

This pull request has not been merged yet. Could you please review and merge it @herrBez? 🙏

@pierrehilbert
Copy link
Collaborator

@kilfoyle could you please have a look here?

|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

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.

@herrBez herrBez requested a review from kilfoyle June 13, 2024 15:39
@herrBez herrBez merged commit 522cf44 into 8.14 Jun 14, 2024
109 checks passed
@herrBez herrBez deleted the mergify/bp/8.14/pr-38534 branch June 14, 2024 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport needs_team Indicates that the issue/PR needs a Team:* label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants