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

winlogbeat/docs/getting-started.asciidoc: Document minimum permissions required for local user account #37176

Merged
merged 12 commits into from
Dec 4, 2023

Conversation

kcreddy
Copy link
Contributor

@kcreddy kcreddy commented Nov 22, 2023

Proposed commit message

Document minimum permissions required to start Winlogbeat service by a local user account which is not a Windows Administrator.

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

  • Have to check if entry in CHANGELOG.next.asciidoc is needed

Related issues

@kcreddy kcreddy added the docs label Nov 22, 2023
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Nov 22, 2023
Copy link
Contributor

mergify bot commented Nov 22, 2023

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @kcreddy? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

@kcreddy kcreddy changed the title [Winlogbeat] Add permissions required for local user account winlogbeat/docs/getting-started.asciidoc: Add permissions required for local user account Nov 22, 2023
@kcreddy kcreddy changed the title winlogbeat/docs/getting-started.asciidoc: Add permissions required for local user account winlogbeat/docs/getting-started.asciidoc: Update docs to add permissions required for local user account Nov 22, 2023
@kcreddy kcreddy changed the title winlogbeat/docs/getting-started.asciidoc: Update docs to add permissions required for local user account winlogbeat/docs/getting-started.asciidoc: Document permissions required for local user account Nov 22, 2023
@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 12 min 43 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!)

@kcreddy kcreddy changed the title winlogbeat/docs/getting-started.asciidoc: Document permissions required for local user account winlogbeat/docs/getting-started.asciidoc: Document minimum permissions required for local user account Nov 22, 2023
@elasticmachine
Copy link
Collaborator

❕ Build Aborted

Either there was a build timeout or someone aborted the build.

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

Expand to view the summary

Build stats

  • Duration: 6 min 52 sec

🤖 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!)

@kcreddy kcreddy marked this pull request as ready for review November 22, 2023 09:44
@kcreddy kcreddy requested a review from a team as a code owner November 22, 2023 09:44
@kcreddy kcreddy requested a review from andrewkroh November 22, 2023 09:44
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Nov 22, 2023
@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 10 min 36 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!)

@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 9 min 41 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!)

@kcreddy kcreddy added 8.12 candidate backport-7.17 Automated backport to the 7.17 branch with mergify labels Nov 22, 2023
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
@@ -150,6 +150,26 @@ Before starting {beatname_uc}, modify the user credentials in
+{beatname_lc}.yml+ and specify a user who is
<<privileges-to-publish-events,authorized to publish events>>.
Copy link
Member

Choose a reason for hiding this comment

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

Either use {beatname_uc} or {beatname_lc} instead of "Winlogbeat" and "winlogbeat" respectively.

Copy link
Contributor Author

@kcreddy kcreddy Nov 23, 2023

Choose a reason for hiding this comment

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

@andrewkroh I updated them. But in the PR, I don't see them getting transformed into "Winlogbeat" and "winlogbeat". Is that applied during the CI?

winlogbeat/docs/getting-started.asciidoc Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
@elasticmachine
Copy link
Collaborator

💚 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: 2023-11-23T09:17:21.527+0000

  • Duration: 8 min 17 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!)

@elasticmachine
Copy link
Collaborator

💚 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: 2023-11-23T11:43:55.913+0000

  • Duration: 8 min 19 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!)

@kcreddy kcreddy requested a review from andrewkroh November 27, 2023 14:00
@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 9 min 32 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!)

winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
winlogbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
@kcreddy kcreddy requested a review from efd6 December 4, 2023 10:37
@elasticmachine
Copy link
Collaborator

🤖 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!)

@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 8 min 15 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!)

@kcreddy
Copy link
Contributor Author

kcreddy commented Dec 4, 2023

/test

@elasticmachine
Copy link
Collaborator

💚 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: 2023-12-04T11:04:33.668+0000

  • Duration: 7 min 41 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!)

@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 8 min 16 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!)

@elasticmachine
Copy link
Collaborator

💚 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

  • Duration: 8 min 15 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!)

@kcreddy kcreddy merged commit 0baba39 into elastic:main Dec 4, 2023
16 checks passed
mergify bot pushed a commit that referenced this pull request Dec 4, 2023
…s required for local user account (#37176)

* Document minimum permissions required for running winlogbeat as local user account

(cherry picked from commit 0baba39)
kcreddy added a commit that referenced this pull request Dec 4, 2023
…ument minimum permissions required for local user account (#37287)

* winlogbeat/docs/getting-started.asciidoc: Document minimum permissions required for local user account (#37176)

* Document minimum permissions required for running winlogbeat as local user account

(cherry picked from commit 0baba39)

---------

Co-authored-by: Krishna Chaitanya Reddy Burri <[email protected]>
Co-authored-by: kcreddy <[email protected]>
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
…s required for local user account (elastic#37176)

* Document minimum permissions required for running winlogbeat as local user account
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.12 candidate backport-7.17 Automated backport to the 7.17 branch with mergify docs Winlogbeat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Winlogbeat] Document minimum permissions for Windows service user
4 participants