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

Document file locations for agent installations #21277

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
70 changes: 70 additions & 0 deletions x-pack/elastic-agent/docs/directory-layout.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
[[elastic-agent-directory-layout]]
= Directory layout

When you install and run {agent}, it creates files in the following locations.

[discrete]
== deb and rpm

These paths are set in the init script or in the systemd unit file. Make sure
that you start the {agent} service by using the preferred operating system
method (init scripts or `systemctl`). Otherwise the paths might be set
incorrectly.

[options="header"]
|====
| Description | Location
| {agent} installation home | `/usr/share/elastic-agent`
| {agent} binaries | `/usr/share/elastic-agent/bin`
| Managed {beats} binaries | `/var/lib/elastic-agent/install`
| Configuration files (standalone) | `/etc/elastic-agent`
| Persistent data files | `/var/lib/elastic-agent`
| {agent} logs | `/var/lib/elastic-agent/logs`
| {beats} logs | `/var/lib/elastic-agent/logs/default`
| {elastic-endpoint} logs | `/opt/Elastic/Endpoint/state/log`
|====

//REVIEWERS: Should we mention any other paths, like
// /var/lib/elastic-agent/downloads for downloads?

[discrete]
== tar.gz

For the zip or tar.gz distributions, these paths are based on the location
of the extracted binary file.

[options="header"]
|====
| Description | Location
| {agent} installation home | `{extract.path}`
| {agent} binaries | `{extract.path}`
| Managed {beats} binaries | `{extract.path}/data/install`
| Configuration files (standalone) | `{extract.path}`
| Persistent data files | `{extract.path}/data`
| {agent} logs | `{extract.path}/data/logs`
| {beats} logs | `{extract.path}/data/logs/default`
| {elastic-endpoint} logs | ???
|====

// REVIEWERS: Where do the Endpoint logs end up on MacOS/Linux? I couldn't find
// them.

[discrete]
== zip

These paths are based on the location of the extracted binary file.

[options="header"]
|====
| Description | Location
| {agent} installation home | `{extract.path}`
| {agent} binaries | `{extract.path}`
| Managed {beats} binaries | `{extract.path}\data\install`
| Configuration files (standalone) | `{extract.path}`
| Persistent data files | `{extract.path}\data`
| {agent} logs | `{extract.path}\data\logs`
| {beats} logs | `{extract.path}\data\logs\default`
| {elastic-endpoint} logs | `C:\Program Files\Elastic\Endpoint\state\log`
|====

// REVIEWERS: Is the log path for Endpoint relative to the extract path?
Copy link
Contributor

Choose a reason for hiding this comment

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

the path for Endpoint is not related to extracted path, since Agent controls and downloads it, it always puts it to the same location (different on different systems)

3 changes: 3 additions & 0 deletions x-pack/elastic-agent/docs/elastic-agent.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ collect data and send it to the {stack}. Behind the scenes, {agent} runs the
To learn how to install, configure, and run your {agent}s, see:

* <<elastic-agent-installation>>
* <<elastic-agent-directory-layout>>
* <<run-elastic-agent>>
* <<stop-elastic-agent>>
* <<unenroll-elastic-agent>>
Expand All @@ -24,6 +25,8 @@ To learn how to install, configure, and run your {agent}s, see:

include::install-elastic-agent.asciidoc[leveloffset=+1]

include::directory-layout.asciidoc[leveloffset=+1]

include::run-elastic-agent.asciidoc[leveloffset=+1]

include::stop-elastic-agent.asciidoc[leveloffset=+1]
Expand Down