From 8771e44d232591876570effa28ff41126219bd20 Mon Sep 17 00:00:00 2001
From: hagen1778 <roman@victoriametrics.com>
Date: Thu, 8 Feb 2024 15:11:13 +0100
Subject: [PATCH] deployment/docker: update README with ToC

The change also moves commands for starting/stopping env to corresponding
sections.

Signed-off-by: hagen1778 <roman@victoriametrics.com>
---
 deployment/docker/README.md | 63 ++++++++++++++++++++++---------------
 1 file changed, 38 insertions(+), 25 deletions(-)

diff --git a/deployment/docker/README.md b/deployment/docker/README.md
index 319ceceea..4f289b70f 100644
--- a/deployment/docker/README.md
+++ b/deployment/docker/README.md
@@ -7,32 +7,24 @@ 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 with VictoriaMetrics components run one of the following commands:
-```
-make docker-single-up  # start single server VictoriaMetrics 
- or
-make docker-cluster-up # start cluster VictoriaMetrics 
-```
+* [VictoriaMetrics single server](#victoriametrics-single-server)
+* [VictoriaMetrics cluster](#victoriametrics-cluster)
+* [vmagent](#vmagent)
+* [vmauth](#vmauth)
+* [vmalert](#vmalert)
+* [alertmanager](#alertmanager)
+* [Alerts](#alerts)
+* [Grafana](#grafana)
+* [VictoriaLogs](#victoriaLogs-server)
 
-To shut down the docker-compose environment run one the following commands:
-```
-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)
-can be started with the following commands:
-```
-make docker-single-vm-datasource-up    # start single server
-make docker-single-vm-datasource-down  # shut down single server
-
-make docker-cluster-vm-datasource-up   # start cluster
-make docker-cluster-vm-datasource-down # shutdown cluster
-```
 
 ## VictoriaMetrics single server
 
+To spin-up environment with VictoriaMetrics single server run the following command:
+```
+make docker-single-up 
+```
+
 VictoriaMetrics will be accessible on the following ports:
 
 * `--graphiteListenAddr=:2003`
@@ -53,9 +45,19 @@ use link [http://localhost:8428/vmui](http://localhost:8428/vmui).
 
 To access `vmalert` use link [http://localhost:8428/vmalert](http://localhost:8428/vmalert/).
 
+To shutdown environment execute the following command:
+```
+make docker-single-down
+```
+
 
 ## VictoriaMetrics cluster
 
+To spin-up environment with VictoriaMetrics cluster run the following command:
+```
+make docker-cluster-up
+```
+
 VictoriaMetrics cluster environment consists of `vminsert`, `vmstorage` and `vmselect` components.
 `vminsert` has exposed port `:8480`, access to `vmselect` components goes through `vmauth` on port `:8427`,
 and the rest of components are available only inside the environment.
@@ -77,6 +79,11 @@ use link [http://localhost:8427/select/0/prometheus/vmui/](http://localhost:8427
 
 To access `vmalert` use link [http://localhost:8427/select/0/prometheus/vmalert/](http://localhost:8427/select/0/prometheus/vmalert/).
 
+To shutdown environment execute the following command:
+```
+make docker-cluster-down
+```
+
 ## vmagent
 
 vmagent is used for scraping and pushing time series to VictoriaMetrics instance. 
@@ -127,9 +134,15 @@ 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.
+Optionally, environment with [VictoriaMetrics Grafana datasource](https://github.com/VictoriaMetrics/grafana-datasource)
+can be started with the following commands:
+```
+make docker-single-vm-datasource-up    # start single server
+make docker-single-vm-datasource-down  # shut down single server
+
+make docker-cluster-vm-datasource-up   # start cluster
+make docker-cluster-vm-datasource-down # shutdown cluster
+```
 
 ## Alerts