Skip to content

Commit

Permalink
[docs] Update systemd documentation for APM (elastic#15126)
Browse files Browse the repository at this point in the history
bmorelli25 authored Dec 17, 2019

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 90ede95 commit fa1a173
Showing 2 changed files with 20 additions and 7 deletions.
10 changes: 7 additions & 3 deletions libbeat/docs/command-reference.asciidoc
Original file line number Diff line number Diff line change
@@ -925,10 +925,14 @@ details.
Sets the path for log files. See the <<directory-layout>> section for details.

*`--strict.perms`*::
Sets strict permission checking on configuration files. The default is
`-strict.perms=true`. See
{beats-ref}/config-file-permissions.html[Config file ownership and permissions] in
Sets strict permission checking on configuration files. The default is `-strict.perms=true`.
ifndef::apm-server[]
See {beats-ref}/config-file-permissions.html[Config file ownership and permissions] in
the _Beats Platform Reference_ for more information.
endif::[]
ifdef::apm-server[]
See <<config-file-ownership>> for more information.
endif::[]

*`-v, --v`*::
Logs INFO-level messages.
17 changes: 13 additions & 4 deletions libbeat/docs/shared-systemd.asciidoc
Original file line number Diff line number Diff line change
@@ -5,31 +5,36 @@ The DEB and RPM packages include a service unit for Linux systems with
systemd. On these systems, you can manage {beatname_uc} by using the usual
systemd commands.

ifdef::apm-server[]
We recommend that the {beatname_lc} process is run as a non-root user.
Therefore, that is the default setup for {beatname_uc}'s DEB package and RPM installation.
endif::apm-server[]

==== Start and stop {beatname_uc}

Use `systemctl` to start or stop {beatname_uc}:

["source", "sh", subs="attributes"]
------------------------------------------------
systemctl start {beatname_lc}
sudo systemctl start {beatname_lc}
------------------------------------------------

["source", "sh", subs="attributes"]
------------------------------------------------
systemctl stop {beatname_lc}
sudo systemctl stop {beatname_lc}
------------------------------------------------

By default, the {beatname_uc} service starts automatically when the system
boots. To enable or disable auto start use:

["source", "sh", subs="attributes"]
------------------------------------------------
systemctl enable {beatname_lc}
sudo systemctl enable {beatname_lc}
------------------------------------------------

["source", "sh", subs="attributes"]
------------------------------------------------
systemctl disable {beatname_lc}
sudo systemctl disable {beatname_lc}
------------------------------------------------


@@ -101,3 +106,7 @@ systemctl restart {beatname_lc}
NOTE: It is recommended that you use a configuration management tool to
include drop-in unit files. If you need to add a drop-in manually, use
+systemctl edit {beatname_lc}.service+.

ifdef::apm-server[]
include::./../config-ownership.asciidoc[]
endif::apm-server[]

0 comments on commit fa1a173

Please sign in to comment.