Skip to content

docs(docker): mount /sys/class/powercap and /proc read-only #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bdossantos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(docker): mount /sys/class/powercap and /proc read-only #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs_src/tutorials/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To quickly run scaphandre in your terminal you may use [docker](https://www.docker.com/):

docker run -v /sys/class/powercap:/sys/class/powercap -v /proc:/proc -ti hubblo/scaphandre stdout -t 15
docker run -v /sys/class/powercap:/sys/class/powercap:ro -v /proc:/proc:ro -ti hubblo/scaphandre stdout -t 15

Or if you downloaded or built a [binary](https://github.com/hubblo-org/scaphandre/releases/latest/download/scaphandre-v0.1.1-Ubuntu_20.04-x86_64.gz), you'd run:

Expand Down Expand Up @@ -34,7 +34,7 @@ At that point, you're ready to use scaphandre. The Stdout exporter is very basic

The [prometheus exporter](references/exporter-prometheus.md), for example, allows you to expose power consumption metrics as an HTTP endpoint that can be scrapped by a [prometheus](https://prometheus.io) instance:

docker run -v /sys/class/powercap:/sys/class/powercap -v /proc:/proc -p 8080:8080 -ti hubblo/scaphandre prometheus
docker run -v /sys/class/powercap:/sys/class/powercap:ro -v /proc:/proc:ro -p 8080:8080 -ti hubblo/scaphandre prometheus

Here is the same command with a simple binary:

Expand Down