aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Kochie <superq@gmail.com>2016-12-20 18:36:34 +0100
committerGitHub <noreply@github.com>2016-12-20 18:36:34 +0100
commit481392d75cbcb9ae94f47b448f411311c5c54560 (patch)
tree7857a190e3249f97ca59c948cded45c6b71884aa /README.md
parent08c9347e884d4436f68e51b2419e4be3e293f6cc (diff)
parent21173e21f06d14af1bdbdfe101a3de7bce168f80 (diff)
downloadprometheus_node_collector-481392d75cbcb9ae94f47b448f411311c5c54560.tar.bz2
prometheus_node_collector-481392d75cbcb9ae94f47b448f411311c5c54560.tar.xz
prometheus_node_collector-481392d75cbcb9ae94f47b448f411311c5c54560.zip
Merge pull request #376 from prometheus/fish-update-docker-readme
Improve Docker documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 17 insertions, 7 deletions
diff --git a/README.md b/README.md
index c51544d..f20fc72 100644
--- a/README.md
+++ b/README.md
@@ -93,17 +93,27 @@ mv /path/to/directory/role.prom.$$ /path/to/directory/role.prom
93 93
94 94
95## Using Docker 95## Using Docker
96 96The node\_exporter is designed to monitor the host system. It's not recommended
97You can deploy this exporter using the [prom/node-exporter](https://registry.hub.docker.com/u/prom/node-exporter/) Docker image. 97to deploy it as Docker container because it requires access to the host system.
98 98If you need to run it on Docker, you can deploy this exporter using the
99For example: 99[node-exporter Docker
100image](https://quay.io/repository/prometheus/node-exporter) with the following
101options and bind-mounts:
100 102
101```bash 103```bash
102docker pull prom/node-exporter 104docker run -d -p 9100:9100 \
103 105 -v "/proc:/host/proc" \
104docker run -d -p 9100:9100 --net="host" prom/node-exporter 106 -v "/sys:/host/sys" \
107 -v "/:/rootfs" \
108 --net="host" \
109 quay.io/prometheus/node-exporter \
110 -collector.procfs /host/proc \
111 -collector.sysfs /host/sys \
112 -collector.filesystem.ignored-mount-points "^/(sys|proc|dev|host|etc)($|/)"
105``` 113```
106 114
115Be aware though that the mountpoint label in various metrics will now have
116`/host` as prefix.
107 117
108[travis]: https://travis-ci.org/prometheus/node_exporter 118[travis]: https://travis-ci.org/prometheus/node_exporter
109[hub]: https://hub.docker.com/r/prom/node-exporter/ 119[hub]: https://hub.docker.com/r/prom/node-exporter/