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.15] Fixes for 'unprivileged' agent docs (backport #1200) #1204

Merged
merged 1 commit into from
Jul 23, 2024

Conversation

mergify[bot]
Copy link

@mergify mergify bot commented Jul 23, 2024

This updates the Run Elastic Agent without administrative privileges page based on suggestions in #1197

Closes: #1197

Preview pages:


Fixes mapped to the "Unprivileged mode docs review" issue

  1. Updates the warning about running commands in unprivileged mode to be more clear.

  2. Describes the privileged and unprivileged commands for changing an agent's running mode.

  3. Nothing to do for now.

  4. Adds steps to view an agent's running status (privileged vs unprivileged) in the "Agent details" UI.

  5. Nothing to do for now.

Additional fix

  1. Updates the Command Reference to the --privileged parameter to the elastic-agent install command.
    @ycombinator Do you think elastic-agent privileged and elastic-agent unprivileged should also be documented as full commands, similar to elastic-agent inspect, elastic-agent status, etc.? From Add unprivileged and privileged subcommand to Elastic Agent elastic-agent#4621 it seems so. That is, they're actual commands rather than just parameters on the elastic-agent install command. However, these are also referred to as "subcommands" so I'm kind of puzzled. :-)

This is an automatic backport of pull request #1200 done by [Mergify](https://mergify.com).

* Fixes for 'unprivileged' agent docs

* Add clause about required re-enroll

* fixup

* Improve warning about running sub-commands without sudo

* Add 'privileged' and 'unprivileged' as commands

* Note that sudo is still needed for install command

* fixup

* Fixup

(cherry picked from commit e409b9d)
@mergify mergify bot requested a review from a team as a code owner July 23, 2024 20:27
@mergify mergify bot added the backport label Jul 23, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@kilfoyle kilfoyle merged commit 369d240 into 8.15 Jul 23, 2024
4 checks passed
@mergify mergify bot deleted the mergify/bp/8.15/pr-1200 branch July 23, 2024 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant