Skip to content

Commit

Permalink
[Heartbeat] Fix docs around ICMP sysctl settings (elastic#35285)
Browse files Browse the repository at this point in the history
We really only test against / have confirmed this working well with
`setcap`. This PR updates the docs to reflect our recommended usage.
  • Loading branch information
andrewvc committed May 2, 2023
1 parent 433a1a1 commit c0b84e4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions heartbeat/docs/monitors/monitor-icmp.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ must execute Heartbeat with elevated permissions to perform ICMP pings.

On Linux, regular users may perform pings if the right file capabilities are set. Run
`sudo setcap cap_net_raw+eip /path/to/heartbeat` to grant {beatname_uc} ping capabilities on Linux.
Alternatively, one may grant ping permissions to the user {beatname_uc} runs as. To grant ping permissions
in this way, run `sudo sysctl -w net.ipv4.ping_group_range='myuserid myuserid'`.

The binary has the correct capabilities already set on the container image, however your container runtime
must allow the use of these privileges for them to be used. On docker this can be achieved with `--cap-add=NET_RAW`.

Other platforms may require {beatname_uc} to run as root or administrator to execute pings.

Expand Down

0 comments on commit c0b84e4

Please sign in to comment.