From 21173e21f06d14af1bdbdfe101a3de7bce168f80 Mon Sep 17 00:00:00 2001 From: Johannes 'fish' Ziemke Date: Mon, 19 Dec 2016 13:28:02 +0100 Subject: [PATCH] Improve Docker documentation This adds bind-mounts and ignore flags to Docker example and explains why it's best run uncontainerized. --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 507851c1..03779b93 100644 --- a/README.md +++ b/README.md @@ -92,17 +92,27 @@ mv /path/to/directory/role.prom.$$ /path/to/directory/role.prom ## Using Docker - -You can deploy this exporter using the [prom/node-exporter](https://registry.hub.docker.com/u/prom/node-exporter/) Docker image. - -For example: +The node\_exporter is designed to monitor the host system. It's not recommended +to deploy it as Docker container because it requires access to the host system. +If you need to run it on Docker, you can deploy this exporter using the +[node-exporter Docker +image](https://quay.io/repository/prometheus/node-exporter) with the following +options and bind-mounts: ```bash -docker pull prom/node-exporter - -docker run -d -p 9100:9100 --net="host" prom/node-exporter +docker run -d -p 9100:9100 \ + -v "/proc:/host/proc" \ + -v "/sys:/host/sys" \ + -v "/:/rootfs" \ + --net="host" \ + quay.io/prometheus/node-exporter \ + -collector.procfs /host/proc \ + -collector.sysfs /host/sys \ + -collector.filesystem.ignored-mount-points "^/(sys|proc|dev|host|etc)($|/)" ``` +Be aware though that the mountpoint label in various metrics will now have +`/host` as prefix. [travis]: https://travis-ci.org/prometheus/node_exporter [hub]: https://hub.docker.com/r/prom/node-exporter/