Skip to content

Commit

Permalink
Docs: Badger file permission as non-root service (#5282)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?
- Related jaegertracing/documentation#683

## Description of the changes
- Badger file permission as non-root service

## How was this change tested?
- No

## Checklist
- [x] I have read
https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
- [x] I have signed all commits
- [ ] I have added unit tests for the new functionality
- [ ] I have run lint and test steps successfully
  - for `jaeger`: `make lint test`
  - for `jaeger-ui`: `yarn lint` and `yarn test`

Signed-off-by: tico88612 <[email protected]>
  • Loading branch information
tico88612 committed Mar 19, 2024
1 parent 55ceba9 commit 29e3fe8
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions plugin/storage/badger/docs/storage-file-non-root-permission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Badger file permissions as non-root service

After the release of 1.50, Jaeger's Docker image is no longer running with root privileges (in [#4783](https://github.com/jaegertracing/jaeger/pull/4783)). In some installations it may cause issues such as "permission denied" errors when writing data.

A possible workaround for this ([proposed here](https://github.com/jaegertracing/jaeger/issues/4906#issuecomment-1991779425)) is to run an initialization step as `root` that pre-creates the Badger data directory and updates its owner to the user that will run the main Jaeger process.

```yaml
version: "3.9"

services:
[...]
jaeger:
image: jaegertracing/all-in-one:latest
command:
- "--badger.ephemeral=false"
- "--badger.directory-key=/badger/data/keys"
- "--badger.directory-value=/badger/data/values"
- "--badger.span-store-ttl=72h0m0s" # limit storage to 72hrs
environment:
- SPAN_STORAGE_TYPE=badger
# Mount host directory "jaeger_badger_data" as "/badger" inside the container.
# The actual data directory will be "/badger/data",
# since we cannot change permissions on the mount.
volumes:
- jaeger_badger_data:/badger
ports:
- "16686:16686"
- "14250"
- "4317"
depends_on:
prepare-data-dir:
condition: service_completed_successfully

prepare-data-dir:
# Run this step as root so that we can change the directory owner.
user: root
image: jaegertracing/all-in-one:latest
command: "/bin/sh -c 'mkdir -p /badger/data && touch /badger/data/.initialized && chown -R 10001:10001 /badger/data'"
volumes:
- jaeger_badger_data:/badger

volumes:
jaeger_badger_data:
```

0 comments on commit 29e3fe8

Please sign in to comment.