Pebble user on k8s is undocumented and depends on charm-user
Metadata
Current evaluation
Documentation request to clarify how charm-user affects charm and workload containers on Kubernetes. Maintainer @dwilding acknowledged and offered to update docs.
Suggested action: keep open
Reason: This is a valid documentation improvement request that has been acknowledged by maintainer @dwilding, who explicitly stated 'I agree with you that the docs can be improved. I'd be very happy to tackle the Charmcraft doc update.' The issue has clear scope with suggested wording and active maintainer engagement, so it should remain open for the documentation update to be completed.
Evaluated by: mr-cal-bot
Impact:
35
Quick Win:
24
Complexity:
15
Confidence:
85
Actionability:
80
Issue body
### Check existing issues
- [x] I've verified that this request isn't described by any existing issues.
### Request
The documentation for `charm-user` in `charmcraft.yaml` should be updated. It currently says that `charm-user` lets charm authors specify that their charm hook code does not need to run as root, that in combination with `uid` and `gid` in containers it allows the charm to be run rootless, and that `root` is assumed if it is not specified. It does not say which users are used, or how `charm-user` affects workload containers.
Please change it to say something like (please review if this is correct and intended):
If neither `charm-user` nor any container's `uid`/`gid` is set, all containers run as root.
Otherwise:
- The charm container runs as the `charm-user` value: `root` (0), `sudoer` (171, with sudo) or `non-root` (170). If `charm-user` is not set, it runs as root.
- A workload container runs as its `uid`/`gid`. If not set, it runs as the user defined in its image.
### Document location
https://canonical.com/juju/docs/charmcraft/4/reference/files/charmcraft-yaml-file/#charm-user
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b |
Impact:
35
Quick Win:
24
Complexity:
15
Confidence:
85
Actionability:
80
|
keep open | Documentation request to clarify how charm-user affects charm and workload containers on Kubernetes. Maintainer @dwilding acknowledged and offered to update docs. | |
| qwen/qwen3.6-35b-a3b |
Impact:
35
Quick Win:
24
Complexity:
15
Confidence:
85
Actionability:
80
|
keep open | Documentation request to clarify how charm-user affects charm and workload containers on Kubernetes. Maintainer @dwilding acknowledged and offered to update docs. |
Update history
| Date | Change |
|---|---|
| updated | |
| updated | |
| created |
Related issues
No related issues found above the similarity threshold.