prometheus / prometheus/docs

Documentation: missing examples with named docker volumes / no info about the right data-path (/prometheus) in container

Open Beginner friendly
#2,285 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
717
Forks
1.2k
Avg merge
3d 15h
Merged PRs (30d)
19

Description

Hi there,

i took me some time to create a prometheus-docker-container with a named volume, because its not clearly documented.

On https://prometheus.io/docs/prometheus/latest/installation/ there is written:
[...] "For production deployments it is highly recommended to use a named volume (https://docs.docker.com/storage/volumes/) to ease managing the data on Prometheus upgrades."

But unfortunaltey there is no example about named volumes. What made me sad is that there is no hint which data-path in the container (/prometheus) should be mounted to the named volume.

If you look at the grafana-documentation its pretty good documented and there is an example with named volumes:

https://grafana.com/docs/grafana/latest/setup-grafana/configure-docker/

Run Grafana container with persistent storage (recommended)

docker volume create grafana-storage
docker run -d -p 3000:3000 --name=grafana -v grafana-storage:/var/lib/grafana grafana/grafana-enterprise

Best Regards
Zen

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Prometheus installation documentation page linked in the issue and review its production deployment guidance. Add a named-volume example that shows mounting the container's /prometheus path; done when users can follow the example and understand where Prometheus data is stored.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.