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

[DOCS] Add the read_pipeline cluster privilege to winlogbeat documentation #38534

Merged
merged 9 commits into from
May 9, 2024
Merged

[DOCS] Add the read_pipeline cluster privilege to winlogbeat documentation #38534

merged 9 commits into from
May 9, 2024

Conversation

herrBez
Copy link
Contributor

@herrBez herrBez commented Mar 21, 2024 •
edited
Loading

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

@herrBez herrBez added bug docs Team:Docs Label for the Observability docs team labels Mar 21, 2024
@herrBez herrBez requested a review from a team as a code owner March 21, 2024 16:43
@herrBez herrBez requested review from ycombinator and belimawr and removed request for a team March 21, 2024 16:43
@botelastic 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
@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@elasticmachine
Copy link
Collaborator

elasticmachine commented Mar 21, 2024 •
edited
Loading

💔 Build Failed

Failed CI Steps

History

cc @herrBez

@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@elasticmachine
Copy link
Collaborator

elasticmachine commented Mar 21, 2024 •
edited
Loading

💔 Build Failed

Failed CI Steps

History

cc @herrBez

@elasticmachine
Copy link
Collaborator

💔 Build Failed

Failed CI Steps

cc @herrBez

@pierrehilbert pierrehilbert added the Team:Elastic-Agent Label for the Agent team label Mar 21, 2024
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

elasticmachine commented Mar 21, 2024 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

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
Copy link
Contributor

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

@herrBez
Copy link
Contributor Author

herrBez commented Mar 22, 2024 •
edited
Loading

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:
image

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

debadair and others added 2 commits April 1, 2024 15:49
@herrBez herrBez requested review from a team as code owners April 1, 2024 22:50
@ycombinator ycombinator removed request for a team April 1, 2024 22:55
@ycombinator ycombinator added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Apr 29, 2024
@elasticmachine
Copy link
Collaborator

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

@pierrehilbert pierrehilbert requested review from leehinman and removed request for ycombinator April 30, 2024 07:24
@cmacknz cmacknz added the backport-v8.14.0 Automated backport with mergify label Apr 30, 2024
@herrBez
Copy link
Contributor Author

herrBez commented May 2, 2024

Hi there,

The only failing check is:
image

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 herrBez mentioned this pull request May 8, 2024
Closed
@herrBez
Copy link
Contributor Author

herrBez commented May 8, 2024

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
Copy link
Member

@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

@herrBez herrBez merged commit edf4568 into main May 9, 2024
110 checks passed
@herrBez herrBez deleted the herrBez-patch-1 branch May 9, 2024 14:47
mergify bot pushed a commit that referenced this pull request May 9, 2024
@herrBez @mergify
[DOCS] Add the read_pipeline cluster privilege for winlogbeat and t…
39651ee 
…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 mentioned this pull request May 9, 2024
Closed
6 tasks
mergify bot pushed a commit that referenced this pull request May 9, 2024
@herrBez @mergify
[DOCS] Add the read_pipeline cluster privilege for winlogbeat and t…
e7b8c36 
…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 mentioned this pull request May 9, 2024
Merged
6 tasks
@herrBez herrBez mentioned this pull request May 9, 2024
Closed
v1v added a commit to v1v/beats that referenced this pull request May 15, 2024
@v1v
Merge remote-tracking branch 'upstream/main' into feature/check-on-gh…
4c5e0d6 
…-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)
  ...
herrBez added a commit that referenced this pull request Jun 14, 2024
@mergify @herrBez @pierrehilbert
[8.14](backport #38534) [DOCS] Add the read_pipeline cluster privil…
522cf44 
…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 <[email protected]>
Co-authored-by: Andrew Kroh <[email protected]>
(cherry picked from commit edf4568)

* Update users.asciidoc to fix the rendeing issue

---------

Co-authored-by: Mirko Bez <[email protected]>
Co-authored-by: Pierre HILBERT <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewkroh andrewkroh andrewkroh approved these changes

@leehinman leehinman leehinman approved these changes

@belimawr belimawr Awaiting requested review from belimawr belimawr is a code owner automatically assigned from elastic/elastic-agent-data-plane

Assignees

@herrBez herrBez

Labels
backport-v8.13.0 Automated backport with mergify backport-v8.14.0 Automated backport with mergify bug docs Team:Automation Label for the Observability productivity team Team:Docs Label for the Observability docs team Team:Elastic-Agent Label for the Agent team Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@herrBez @elasticmachine @belimawr @ycombinator @andrewkroh @leehinman @pierrehilbert @cmacknz @debadair