Skip to content

Commit

Permalink
Document file locations for agent installations
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton committed Oct 1, 2020
1 parent d816b62 commit f6f12b7
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 0 deletions.
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?
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

0 comments on commit f6f12b7

Please sign in to comment.