From d76e338505368aeac0a7285b71235b382b19afca Mon Sep 17 00:00:00 2001 From: hagen1778 Date: Thu, 25 Jan 2024 15:27:57 +0100 Subject: [PATCH] docs: simplify instructions for spinning up docker env Signed-off-by: hagen1778 --- deployment/docker/README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/deployment/docker/README.md b/deployment/docker/README.md index 3aedffc0ee..319ceceeab 100644 --- a/deployment/docker/README.md +++ b/deployment/docker/README.md @@ -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. **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 -``` - -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 +make docker-single-down # shutdown single server VictoriaMetrics + or +make docker-cluster-down # shutdown cluster VictoriaMetrics ``` 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. +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 See below a list of recommended alerting rules for various VictoriaMetrics components for running in production.