Skip to content
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

docs: add rootless example #3635

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: add rootless example #3635

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da6ddd9
docs: add rootless example
Ekhorn Dec 8, 2024
ca9a4d9
docs: fix rootless example docker/podman arguments location
Ekhorn Jan 12, 2025
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
25 changes: 25 additions & 0 deletions docs/running.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,31 @@ If you are using Docker with the LXC exec driver, then you need to manually spec

This is a problem seen in older versions of Docker. To fix, start cAdvisor without the `--volume=/:/rootfs:ro` mount. cAdvisor will degrade gracefully by dropping stats that depend on access to the machine root.

### Rootless (Docker / Podman)

Running cAdivsor on rootless container runtimes works for the most part. However granting access to the host kernel message buffer (`--device /dev/kmsg`) for OOM (out of memory) detection does not work.

Based on the container runtime used the socket needs to be changed appriopriately. Additionally the container storage volume, must be changed to the corresponding container runtime user directory. When using Podman you must also include `--volume=/sys/fs/cgroup:/sys/fs/cgroup:ro`.

```sh
VERSION=v0.49.1 # use the latest release version from https://github.com/google/cadvisor/releases
docker run \
--volume=/:/rootfs:ro \
--volume=/var/run:/var/run:ro \
--volume=/sys:/sys:ro \
# --volume=/sys/fs/cgroup:/sys/fs/cgroup:ro \ # Required for Podman subcontainers
--volume=$HOME/.local/share/docker/:/var/lib/docker:ro \ # Docker Rootless
# --volume=$HOME/.local/share/containers:/var/lib/containers:ro # Podman Rootless
--volume=/dev/disk/:/dev/disk:ro \
--publish=8080:8080 \
--detach=true \
--name=cadvisor \
--privileged \
gcr.io/cadvisor/cadvisor:$VERSION \
--docker=unix:///var/run/user/$(id -u)/docker.sock
# --podman=unix:///var/run/user/$(id -u)/podman/podman.sock # Podman Rootless
```

## Standalone

cAdvisor is a static Go binary with no external dependencies. To run it standalone all you should need to do is run it! Note that some data sources may require root privileges. cAdvisor will gracefully degrade its features to those it can expose with the access given.
Expand Down
Loading