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.

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: a few improvements to quickstart guide #446

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

Conversation

tjhop
Copy link

@tjhop tjhop commented Jan 25, 2025

Some attempted improvements. More details in each commit. Feedback welcome!

tjhop added 2 commits January 25, 2025 12:38
This isn't the location of the binary anyway, but the entrypoint is
already set to the binary in the Dockerfile for the agent:
https://github.com/parca-dev/parca-agent/blob/68dcb27ca4292ca7e7ff38a80ec22d1b0fa3fecb/Dockerfile#L6

Having the extra arg in there causes the container agent (and thus
container) to bail:

```
~ -> podman 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:v0.35.3 /bin/parca-agent  --remote-store-address=127.0.0.1:7070 --remote-store-insecure
2025/01/25 17:32:33 INFO memory is not limited, skipping package=github.com/KimMachineGun/automemlimit/memlimit
parca-agent: error: unexpected argument /bin/parca-agent
```

Signed-off-by: TJ Hoplock <[email protected]>
As of the last release or two of the agent, the container no longer
crashes on podman when run as a non-root user due to permission failure
accessing `/proc/kallsyms`, but root usage should be recommended for
parity with the docker equivalent's access/suggested usage.

Prevents:
```
time="2025-01-25T17:30:41Z" level=error msg="Failed to load eBPF tracer: failed to read kernel symbols: all addresses from kallsyms are zero - check process permissions"
```

Signed-off-by: TJ Hoplock <[email protected]>
Copy link

vercel bot commented Jan 25, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
parca-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 25, 2025 5:50pm

@CLAassistant
Copy link

CLAassistant commented Jan 25, 2025

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants