[DOCS] Add the `read_pipeline` cluster privilege to winlogbeat documentation by herrBez · Pull Request #38534 · elastic/beats

herrBez · 2024-03-21T16:43:21Z

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

[Docs] Corrections needed for winlogbeat role privileges #39067

Use cases

Adhere to the least privilege principles

Screenshots

Logs

elasticmachine · 2024-03-21T16:45:25Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/filebeat/filebeat-pipeline.yml

cc @herrBez

elasticmachine · 2024-03-21T16:45:28Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/metricbeat/pipeline.yml

cc @herrBez

elasticmachine · 2024-03-21T16:45:42Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/heartbeat/heartbeat-pipeline.yml

cc @herrBez

elasticmachine · 2024-03-21T16:45:43Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/packetbeat/pipeline.packetbeat.yml

cc @herrBez

elasticmachine · 2024-03-21T16:45:43Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/libbeat/pipeline.libbeat.yml

cc @herrBez

elasticmachine · 2024-03-21T16:45:54Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/x-pack/pipeline.xpack.libbeat.yml

History

cc @herrBez

elasticmachine · 2024-03-21T16:46:09Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/x-pack/pipeline.xpack.metricbeat.yml

cc @herrBez

elasticmachine · 2024-03-21T16:46:09Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/winlogbeat/pipeline.winlogbeat.yml

cc @herrBez

elasticmachine · 2024-03-21T16:46:09Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/x-pack/pipeline.xpack.packetbeat.yml

History

cc @herrBez

elasticmachine · 2024-03-21T16:46:10Z

💔 Build Failed

Buildkite Build
Commit: b426e85

Failed CI Steps

:pipeline:⬆️ Upload Pipeline: .buildkite/x-pack/pipeline.xpack.winlogbeat.yml

cc @herrBez

elasticmachine · 2024-03-21T16:47:46Z

Pinging @elastic/elastic-agent (Team:Elastic-Agent)

elasticmachine · 2024-03-21T16:52:31Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2024-05-09T11:26:20.786+0000
Duration: 9 min 49 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

belimawr · 2024-03-22T08:04:14Z

LGTM, however CI is failing, @herrBez could you take a look at this failure?

herrBez · 2024-03-22T08:46:15Z

Hi,

Thank you for the fast feedback. Maybe we can extend the PR to add also the auto_configure permission to allow the users to dynamically update the mapping of the datastreams. Read more in the (internal) Slack discussions:

About the build:
I have only the rights to view the Jenkins Job and I am not allowed to view the buildkite result.
The jenkins job is failing during a go install:

I hardly believe it has something to do with the change I introduced.

Add the "read_pipeline" privilege for Winlogbeat too

… for beat agents

elasticmachine · 2024-04-29T19:49:24Z

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

herrBez · 2024-05-02T09:00:57Z

Hi there,

The only failing check is:

I honestly don't know if and where I should put this ECS version. Can someone help me in figure out what it's needed here to fix the problem? (I don't have access to the buildkite agent logs).

herrBez · 2024-05-08T14:40:00Z

Hi there,
I am not able to merge the change even though it has been approved, because the build is not successful. By looking at the errors I don't think they are related with the changes I did. Can someone help me in understand what I need to do to be able to merge the PR?

andrewkroh · 2024-05-08T15:54:05Z

@herrBez There appears to be an issue with the links.

https://buildkite.com/elastic/docs-build-pr/builds/73547#018f58b1-6108-49d9-9876-4753c957356f/54-1560

INFO:build_docs:Bad cross-document links:
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/beats/auditbeat/master/privileges-to-publish-events.html contains broken links to:
INFO:build_docs: - en/elasticsearch/reference/current/docs-index_.html#index-creation,action.auto_create_index
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/beats/filebeat/master/privileges-to-publish-events.html contains broken links to:
INFO:build_docs: - en/elasticsearch/reference/current/docs-index_.html#index-creation,action.auto_create_index
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/beats/functionbeat/master/privileges-to-publish-events.html contains broken links to:
INFO:build_docs: - en/elasticsearch/reference/current/docs-index_.html#index-creation,action.auto_create_index
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/beats/heartbeat/master/privileges-to-publish-events.html contains broken links to:
INFO:build_docs: - en/elasticsearch/reference/current/docs-index_.html#index-creation,action.auto_create_index
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/beats/metricbeat/master/privileges-to-publish-events.html contains broken links to:
INFO:build_docs: - en/elasticsearch/reference/current/docs-index_.html#index-creation,action.auto_create_index
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/beats/packetbeat/master/privileges-to-publish-events.html contains broken links to:
INFO:build_docs: - en/elasticsearch/reference/current/docs-index_.html#index-creation,action.auto_create_index
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/beats/winlogbeat/master/privileges-to-publish-events.html contains broken links to:
INFO:build_docs: - en/elasticsearch/reference/current/docs-index_.html#index-creation,action.auto_create_index

…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 <debadair@elastic.co> Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co> (cherry picked from commit edf4568)

…-actions * upstream/main: (313 commits) github-action: delete opentelemetry workflow (elastic#39559) updatecli: move to the .github folder and support for signed commits (elastic#39472) Osquerybeat: Add action responses data stream (elastic#39143) [winlogbeat] performance improvment; avoid rendering event message twice (elastic#39544) Fix the AWS SDK dependencies issue causing the "not found, ResolveEndpointV2" error (elastic#39454) x-pack/filebeat/input/cel: add http metrics collection (elastic#39503) build(deps): bump github.com/elastic/elastic-agent-libs from 0.9.4 to 0.9.7 (elastic#39424) Remove unused env vars from pipelines (elastic#39534) [BK] - Remove osx steps from branch execution (elastic#39552) [BK] - Remove certain steps from running for Branches (elastic#39533) Allow dependabot report BK status checks (elastic#39540) Remove hardcoded module definitions in CI (elastic#39506) Explicitly set DOCKER_PULL, RACE_DETECTOR and TEST_COVERAGE for pipelines (elastic#39510) Fixed pipelines formatting (elastic#39513) Update filebeat pipeline to match Jenkins steps (elastic#39261) Add error check to groupToEvents so we don't blindly add error values (elastic#39404) Remove fields not needed for session view in add_session_view processor (elastic#39500) `aws-s3` input: Split S3 poller and SQS reader into explicit input objects (elastic#39353) ci(jenkins): remove post-build notifications (elastic#39483) [DOCS] Add the `read_pipeline` cluster privilege for winlogbeat and the `auto_configure` index privilege to beats documentation (elastic#38534) ...

…ege to winlogbeat documentation (#39491) * [DOCS] Add the `read_pipeline` cluster privilege for winlogbeat and the `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 <debadair@elastic.co> Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co> (cherry picked from commit edf4568) * Update users.asciidoc to fix the rendeing issue --------- Co-authored-by: Mirko Bez <herrBez@users.noreply.github.com> Co-authored-by: Pierre HILBERT <pierre.hilbert@elastic.co>

herrBez added bug docs Team:Docs Label for the Observability docs team labels Mar 21, 2024

herrBez requested a review from a team as a code owner March 21, 2024 16:43

herrBez requested review from belimawr and ycombinator and removed request for a team March 21, 2024 16:43

botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Mar 21, 2024

mergify bot assigned herrBez Mar 21, 2024

pierrehilbert added the Team:Elastic-Agent Label for the Agent team label Mar 21, 2024

debadair and others added 2 commits April 1, 2024 15:49

[DOCS] Removed reference to the Stack GS (#32119)

9b7254c

Update users.asciidoc

8bd7a8b

Add the "read_pipeline" privilege for Winlogbeat too

ycombinator force-pushed the herrBez-patch-1 branch from b426e85 to 8bd7a8b Compare April 1, 2024 22:50

herrBez requested review from a team as code owners April 1, 2024 22:50

ycombinator removed request for a team April 1, 2024 22:55

[Docs] add auto_configure index privilege to the required permissions…

74fea57

… for beat agents

ycombinator added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Apr 29, 2024

pierrehilbert requested review from leehinman and removed request for ycombinator April 30, 2024 07:24

leehinman approved these changes Apr 30, 2024

View reviewed changes

cmacknz added the backport-v8.14.0 Automated backport with mergify label Apr 30, 2024

Merge branch 'main' into herrBez-patch-1

23991aa

Merge branch 'main' into herrBez-patch-1

bad3701

andrewkroh approved these changes May 3, 2024

View reviewed changes

Merge branch 'main' into herrBez-patch-1

df8cef2

herrBez mentioned this pull request May 8, 2024

[Docs] Corrections needed for winlogbeat role privileges #39067

Closed

Merge branch 'main' into herrBez-patch-1

a8f2eb1

herrBez added 2 commits May 9, 2024 07:45

Update link that was broken

48387db

Merge branch 'main' into herrBez-patch-1

cdf4044

herrBez merged commit edf4568 into main May 9, 2024

herrBez deleted the herrBez-patch-1 branch May 9, 2024 14:47

mergify bot mentioned this pull request May 9, 2024

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

Closed

6 tasks

mergify bot mentioned this pull request May 9, 2024

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

Merged

6 tasks

herrBez mentioned this pull request May 9, 2024

[Docs] Incorrect privileges listed in API key documentation #35612

Closed

Conversation

herrBez commented Mar 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed commit message

Checklist

Author's Checklist

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Failed CI Steps

History

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Failed CI Steps

History

Uh oh!

elasticmachine commented Mar 21, 2024

💔 Build Failed

Failed CI Steps

Uh oh!

elasticmachine commented Mar 21, 2024

Uh oh!

elasticmachine commented Mar 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

Uh oh!

belimawr commented Mar 22, 2024

Uh oh!

herrBez commented Mar 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Apr 29, 2024

Uh oh!

herrBez commented May 2, 2024

Uh oh!

herrBez commented May 8, 2024

Uh oh!

andrewkroh commented May 8, 2024

Uh oh!

Reviewers

Assignees

herrBez commented Mar 21, 2024 •

edited

Loading

elasticmachine commented Mar 21, 2024 •

edited

Loading

elasticmachine commented Mar 21, 2024 •

edited

Loading

elasticmachine commented Mar 21, 2024 •

edited

Loading

herrBez commented Mar 22, 2024 •

edited

Loading