github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2025-01-10 15:14:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: simplify instructions for spinning up docker env

Browse source 
Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
hagen1778 2024-01-25 15:27:57 +01:00 committed by Aliaksandr Valialkin
parent 8fa6c42396
commit d76e338505
No known key found for this signature in database
GPG key ID: 52C003EE2BCDB9EB
1 changed files with 12 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
deployment/docker/README.md
View file

@ -7,24 +7,18 @@ and [Grafana](https://grafana.com/).
For starting the docker-compose environment ensure you have docker installed and running and access to the Internet. For starting the docker-compose environment ensure you have docker installed and running and access to the Internet.
**All commands should be executed from the root directory of [the repo](https://github.com/VictoriaMetrics/VictoriaMetrics).** **All commands should be executed from the root directory of [the repo](https://github.com/VictoriaMetrics/VictoriaMetrics).**
To spin-up environment for single server VictoriaMetrics run the following command: To spin-up environment with VictoriaMetrics components run one of the following commands:
``` ```
make docker-single-up make docker-single-up # start single server VictoriaMetrics
or
make docker-cluster-up # start cluster VictoriaMetrics
``` ```
To shut down the docker-compose environment for single server run the following command: To shut down the docker-compose environment run one the following commands:
``` ```
make docker-single-down make docker-single-down # shutdown single server VictoriaMetrics
``` or
make docker-cluster-down # shutdown cluster VictoriaMetrics
For cluster version the command will be the following:
```
make docker-cluster-up
```
To shut down the docker compose environment for cluster version run the following command:
```
make docker-cluster-down
``` ```
Optionally, environment with [VictoriaMetrics Grafana datasource](https://github.com/VictoriaMetrics/grafana-datasource) Optionally, environment with [VictoriaMetrics Grafana datasource](https://github.com/VictoriaMetrics/grafana-datasource)
@ -133,6 +127,10 @@ Grafana is provisioned by default with following entities:
Remember to pick `VictoriaMetrics - cluster` datasource when viewing `VictoriaMetrics - cluster` dashboard. Remember to pick `VictoriaMetrics - cluster` datasource when viewing `VictoriaMetrics - cluster` dashboard.
If environment was started via `docker-single-vm-datasource-up` or `docker-cluster-vm-datasource-up`, then
Grafana will have [VictoriaMetrics Grafana datasource](https://github.com/VictoriaMetrics/grafana-datasource)
installed by default.
## Alerts ## Alerts
See below a list of recommended alerting rules for various VictoriaMetrics components for running in production. See below a list of recommended alerting rules for various VictoriaMetrics components for running in production.