root
/
prometheus
mirror of https://github.com/prometheus/prometheus.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity
prometheus/docs/installation.md

128 lines
3.6 KiB
Markdown
Raw Normal View History

Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
---
Import querying documentation from prometheus/docs
2017-10-26 21:53:27 +08:00
title: Installation
sort_rank: 2
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
---
Import querying documentation from prometheus/docs
2017-10-26 21:53:27 +08:00
# Installation
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
## Using pre-compiled binaries
We provide precompiled binaries for most official Prometheus components. Check
out the [download section](https://prometheus.io/download) for a list of all
available versions.
## From source
For building Prometheus components from source, see the `Makefile` targets in
the respective repository.
## Using Docker
Migrate all Docker image references to Docker Hub (#4864) Signed-off-by: noqcks <benny@noqcks.io>
2018-11-16 19:26:10 +08:00
All Prometheus services are available as Docker images on
[Quay.io](https://quay.io/repository/prometheus/prometheus) or
Fix docker hub link in installation guide Signed-off-by: c2c-engg-20170100 <c2c-20170100@click2cloud.net>
2019-07-01 18:56:23 +08:00
[Docker Hub](https://hub.docker.com/r/prom/prometheus/).
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
Running Prometheus on Docker is as simple as `docker run -p 9090:9090
Migrate all Docker image references to Docker Hub (#4864) Signed-off-by: noqcks <benny@noqcks.io>
2018-11-16 19:26:10 +08:00
prom/prometheus`. This starts Prometheus with a sample
configuration and exposes it on port 9090.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
The Prometheus image uses a volume to store the actual metrics. For
docs: minor corrections to the docker documentation (#6869) The documentation referenced "data volume containers", which were superseded by named volume support in Docker several years ago. There were to bind-mounting examples in the docs that are effectively doing the same thing, but the description of the second was somewhat erroneous. Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
2020-08-31 22:44:08 +08:00
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.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
docs: clarify default Docker command line parameters (#14194) * docs: clarify default Docker command line parameters Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> * docs: move Docker command line parameters section and refer to Dockerfile Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> * Add link to Dockerfile in documentation Co-authored-by: Ayoub Mrini <ayoubmrini424@gmail.com> Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> --------- Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> Co-authored-by: Ayoub Mrini <ayoubmrini424@gmail.com>
2024-06-11 02:16:02 +08:00
### Setting command line parameters
The Docker image is started with a number of default command line parameters, which
can be found in the [Dockerfile](https://github.com/prometheus/prometheus/blob/main/Dockerfile) (adjust the link to correspond with the version in use).
If you want to add extra command line parameters to the `docker run` command,
you will need to re-add these yourself as they will be overwritten.
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
### Volumes & bind-mount
docs: clarify default Docker command line parameters (#14194) * docs: clarify default Docker command line parameters Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> * docs: move Docker command line parameters section and refer to Dockerfile Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> * Add link to Dockerfile in documentation Co-authored-by: Ayoub Mrini <ayoubmrini424@gmail.com> Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> --------- Signed-off-by: Rens Groothuijsen <l.groothuijsen@alumni.maastrichtuniversity.nl> Co-authored-by: Ayoub Mrini <ayoubmrini424@gmail.com>
2024-06-11 02:16:02 +08:00
To provide your own configuration, there are several options. Here are
two examples.
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
Bind-mount your `prometheus.yml` from the host by running:
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
```bash
Correct the docker run volume parameter (#6247) * Fixes prometheus/docs#1418 Signed-off-by: Matt Russi <mattrussi@users.noreply.github.com>
2019-11-02 18:49:36 +08:00
docker run \
-p 9090:9090 \
docs: minor corrections to the docker documentation (#6869) The documentation referenced "data volume containers", which were superseded by named volume support in Docker several years ago. There were to bind-mounting examples in the docs that are effectively doing the same thing, but the description of the second was somewhat erroneous. Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
2020-08-31 22:44:08 +08:00
-v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml \
Correct the docker run volume parameter (#6247) * Fixes prometheus/docs#1418 Signed-off-by: Matt Russi <mattrussi@users.noreply.github.com>
2019-11-02 18:49:36 +08:00
prom/prometheus
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
```
docs: minor corrections to the docker documentation (#6869) The documentation referenced "data volume containers", which were superseded by named volume support in Docker several years ago. There were to bind-mounting examples in the docs that are effectively doing the same thing, but the description of the second was somewhat erroneous. Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
2020-08-31 22:44:08 +08:00
Or bind-mount the directory containing `prometheus.yml` onto
`/etc/prometheus` by running:
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
```bash
Correct the docker run volume parameter (#6247) * Fixes prometheus/docs#1418 Signed-off-by: Matt Russi <mattrussi@users.noreply.github.com>
2019-11-02 18:49:36 +08:00
docker run \
-p 9090:9090 \
-v /path/to/config:/etc/prometheus \
prom/prometheus
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
```
Add instructions how to persist prometheus docker container data Signed-off-by: shoce <rslnx@icloud.com>
2021-10-19 01:13:31 +08:00
### Save your Prometheus data
Prometheus data is stored in `/prometheus` dir inside the container, so the data is cleared every time the container gets restarted. To save your data, you need to set up persistent storage (or bind mounts) for your container.
Run Prometheus container with persistent storage:
```bash
# Create persistent volume for your data
docker volume create prometheus-data
# Start Prometheus container
docker run \
-p 9090:9090 \
-v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml \
-v prometheus-data:/prometheus \
prom/prometheus
```
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
### Custom image
To avoid managing a file on the host and bind-mount it, the
configuration can be baked into the image. This works well if the
configuration itself is rather static and the same across all
environments.
For this, create a new directory with a Prometheus configuration and a
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
`Dockerfile` like this:
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
```Dockerfile
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
FROM prom/prometheus
ADD prometheus.yml /etc/prometheus/
```
Now build and run it:
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
```bash
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
docker build -t my-prometheus .
docker run -p 9090:9090 my-prometheus
```
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
A more advanced option is to render the configuration dynamically on start
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
with some tooling or even have a daemon update it periodically.
## Using configuration management systems
If you prefer using configuration management systems you might be interested in
the following third-party contributions:
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
### Ansible
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
docs: update ansible installation link Signed-off-by: g3offrey <11151445+g3offrey@users.noreply.github.com>
2023-03-15 22:57:15 +08:00
* [prometheus-community/ansible](https://github.com/prometheus-community/ansible)
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
### Chef
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
* [rayrod2030/chef-prometheus](https://github.com/rayrod2030/chef-prometheus)
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
### Puppet
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
* [puppet/prometheus](https://forge.puppet.com/puppet/prometheus)
Integrate changes from prometheus/docs
2017-10-26 21:42:07 +08:00
### SaltStack
Import first batch of Prometheus documentation In order to provide documentation for each individual version, this commit starts moving Prometheus server specific documentation into the repository itself.
2017-10-10 20:58:52 +08:00
Update link to SaltStack formula (#6024) Use the "official" saltstack-formulas version. The existing one hasn't been updated since 2015. Signed-off-by: Ben Kochie <superq@gmail.com>
2019-09-15 22:59:16 +08:00
* [saltstack-formulas/prometheus-formula](https://github.com/saltstack-formulas/prometheus-formula)