docs: update docker env description

This commit is contained in:
Roman Khavronenko 2021-09-01 09:18:56 +03:00
parent cfb6436be5
commit 0d6735106b

View file

@ -1,19 +1,19 @@
### Folder contains basic images and tools for building and running Victoria Metrics in docker
# Docker compose environment for VictoriaMetrics
#### Docker compose
To spin-up setup of VictoriaMetrics, vmagent and Grafana run following command:
To spin-up VictoriaMetrics, vmagent, vmalert, Alertmanager and Grafana run the following command:
`docker-compose up`
##### VictoriaMetrics
For clustered version check [docker compose in cluster branch](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/deployment/docker).
VictoriaMetrics opens following ports:
## VictoriaMetrics
VictoriaMetrics will be accessible on the following ports:
* `--graphiteListenAddr=:2003`
* `--opentsdbListenAddr=:4242`
* `--httpListenAddr=:8428`
##### vmagent
## vmagent
vmagent is used for scraping and pushing timeseries to
VictoriaMetrics instance. It accepts Prometheus-compatible
@ -21,7 +21,7 @@ configuration `prometheus.yml` with listed targets for scraping.
[Web interface link](http://localhost:8429/).
##### vmalert
## vmalert
vmalert evaluates alerting rules (`alerts.yml`) to track VictoriaMetrics
health state. It is connected with AlertManager for firing alerts,
@ -29,14 +29,14 @@ and with VictoriaMetrics for executing queries and storing alert's state.
[Web interface link](http://localhost:8880/).
##### alertmanager
## alertmanager
AlertManager accepts notifications from `vmalert` and fires alerts.
All notifications are blackholed according to `alertmanager.yml` config.
[Web interface link](http://localhost:9093/).
##### Grafana
## Grafana
To access service open following [link](http://localhost:3000).