Skip to content

docs: a few improvements to quickstart guide #446

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: a few improvements to quickstart guide #446

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b07715c
docs(quickstart): remove extra arg from docker instructions for agent
tjhop Jan 25, 2025
b0c68bf
docs(quickstart): add note for podman users that agent needs root
tjhop Jan 25, 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
4 changes: 3 additions & 1 deletion docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,12 @@ Run Parca and access the Web UI on port 7070
**Agent**

Run Parca Agent (requires privileged mode) and access the Web UI on port 7071 (assumes Parca is running as a container on the same host. Replace IP for "--remote-store-address")

__NOTE:__ If using `podman` to manage containers as a non-root user, you may need to use `sudo` and run the container as the root user to properly access `/proc/kallsyms`.
<WithVersions language="bash">
{ versions =>
<CodeBlock className="language-bash">
docker run --rm -it --privileged --pid host -p 7071:7071 -v /run:/run -v /boot:/boot -v /lib/modules:/lib/modules -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket ghcr.io/parca-dev/parca-agent:{versions.agent} /bin/parca-agent --remote-store-address=parca-container-ip:7070 --remote-store-insecure
docker run --rm -it --privileged --pid host -p 7071:7071 -v /run:/run -v /boot:/boot -v /lib/modules:/lib/modules -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket ghcr.io/parca-dev/parca-agent:{versions.agent} --remote-store-address=parca-container-ip:7070 --remote-store-insecure
</CodeBlock>
}
</WithVersions>
Expand Down