Skip to content

[8.x] Use correct technical preview tags (backport #1514) #1519

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

Merged
merged 3 commits into from
Dec 3, 2024
Merged

[8.x] Use correct technical preview tags (backport #1514) #1519

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c03249
Use correct technical preview tags (#1514)
kilfoyle Dec 3, 2024
0e5948c
Update commands.asciidoc
kilfoyle Dec 3, 2024
308607a
Merge branch '8.x' into mergify/bp/8.x/pr-1514
kilfoyle Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions docs/en/ingest-management/commands.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ invoking the wrong binary.
* <<elastic-agent-help-command,help>>
* <<elastic-agent-inspect-command,inspect>>
* <<elastic-agent-install-command,install>>
* <<elastic-agent-otel-command,otel>> [technical preview]
* <<elastic-agent-privileged-command,privileged>> [technical preview]
* <<elastic-agent-otel-command,otel>> preview:[]
* <<elastic-agent-privileged-command,privileged>>
* <<elastic-agent-restart-command,restart>>
* <<elastic-agent-run-command,run>>
* <<elastic-agent-status-command,status>>
Expand Down Expand Up @@ -825,6 +825,20 @@ This option is useful in organizations that limit `root` access on Linux or macO
For details and limitations for running {agent} in this mode, refer to {fleet-guide}/elastic-agent-unprivileged.html[Run {agent} without administrative privileges].

Note that changing to `unprivileged` mode is prevented if the agent is currently enrolled in a policy that includes an integration that requires administrative access, such as the {elastic-defend} integration.
+
preview:[] To run {agent} without superuser privileges as a pre-existing user or group, for instance under an Active Directory account, you can specify the user or group, and the password to use.
+
For example:
+
[source,shell]
----
elastic-agent install --unprivileged --user="my.path\username" --password="mypassword"
----
+
[source,shell]
----
elastic-agent install --unprivileged --group="my.path\groupname" --password="mypassword"
----

`--url <string>`::
{fleet-server} URL to use to enroll the {agent} into {fleet}.
Expand Down Expand Up @@ -1177,6 +1191,8 @@ For details and limitations for running {agent} in this mode, refer to {fleet-gu

Note that changing a running {agent} to `unprivileged` mode is prevented if the agent is currently enrolled with a policy that contains the {elastic-defend} integration.

preview:[] To run {agent} without superuser privileges as a pre-existing user or group, for instance under an Active Directory account, add either a `--user` or `--group` parameter together with a `--password` parameter.

[discrete]
=== Examples

Expand All @@ -1185,6 +1201,20 @@ Note that changing a running {agent} to `unprivileged` mode is prevented if the
elastic-agent unprivileged
----

preview:[] Run {agent} without administrative privileges, as a pre-existing user:

[source,shell]
----
elastic-agent unprivileged --user="my.pathl\username" --password="mypassword"
----

preview:[] Run {agent} without administrative privileges, as a pre-existing group:

[source,shell]
----
elastic-agent unprivileged --group="my.pathl\groupname" --password="mypassword"
----

++++
<hr>
++++
Expand Down