From d42908133ce499508f841a87da813119a35f66e0 Mon Sep 17 00:00:00 2001 From: Artem Navoiev Date: Fri, 26 Jan 2024 13:06:48 -0800 Subject: [PATCH] docs: remove

for imanges (#5702) Signed-off-by: Artem Navoiev --- README.md | 4 +--- docs/Cluster-VictoriaMetrics.md | 4 +--- docs/README.md | 8 ++----- docs/Single-server-VictoriaMetrics.md | 8 ++----- .../guides/guide-vmanomaly-vmalert.md | 4 +--- .../getting-started-with-vm-operator.md | 12 +++------- ...uide-vmcluster-multiple-retention-setup.md | 4 +--- .../k8s-ha-monitoring-via-vm-cluster.md | 20 ++++------------ docs/guides/k8s-monitoring-via-vm-cluster.md | 23 +++++++------------ docs/guides/k8s-monitoring-via-vm-single.md | 18 +++++---------- .../multi-regional-setup-dedicated-regions.md | 7 +----- 11 files changed, 31 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index e3d0671997..6c10a32c46 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,7 @@ Each service may scale independently and may run on the most suitable hardware. This is a [shared nothing architecture](https://en.wikipedia.org/wiki/Shared-nothing_architecture). It increases cluster availability, and simplifies cluster maintenance as well as cluster scaling. -

- -

+ ## Multitenancy diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index d68d778a7c..b92514d3e3 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -56,9 +56,7 @@ Each service may scale independently and may run on the most suitable hardware. This is a [shared nothing architecture](https://en.wikipedia.org/wiki/Shared-nothing_architecture). It increases cluster availability, and simplifies cluster maintenance as well as cluster scaling. -

- -

+ ## Multitenancy diff --git a/docs/README.md b/docs/README.md index 63ac21a6ce..51918e7932 100644 --- a/docs/README.md +++ b/docs/README.md @@ -520,9 +520,7 @@ via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit DataDog agent allows configuring destinations for metrics sending via ENV variable `DD_DD_URL` or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`. -

- -

+ To configure DataDog agent via ENV variable add the following prefix: @@ -549,9 +547,7 @@ pick [single-node or cluster URL](https://docs.victoriametrics.com/url-examples. DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guide/dual-shipping/) for metrics sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`. -

- -

+ Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver: diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 922fc8a8e2..e7e3c02878 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -528,9 +528,7 @@ via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit DataDog agent allows configuring destinations for metrics sending via ENV variable `DD_DD_URL` or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`. -

- -

+ To configure DataDog agent via ENV variable add the following prefix: @@ -557,9 +555,7 @@ pick [single-node or cluster URL](https://docs.victoriametrics.com/url-examples. DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guide/dual-shipping/) for metrics sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`. -

- -

+ Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver: diff --git a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md index 52768ff0ef..63b173363f 100644 --- a/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md +++ b/docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md @@ -451,9 +451,7 @@ networks: Before running our docker-compose make sure that your directory contains all required files: -

- all files -

+all files This docker-compose file will pull docker images, set up each service and run them all together with the command: diff --git a/docs/guides/getting-started-with-vm-operator.md b/docs/guides/getting-started-with-vm-operator.md index 4ea49bef8c..522675948f 100644 --- a/docs/guides/getting-started-with-vm-operator.md +++ b/docs/guides/getting-started-with-vm-operator.md @@ -231,9 +231,7 @@ Forwarding from [::1]:8429 -> 8429 To check that `VMAgent` collects metrics from the k8s cluster open in the browser [http://127.0.0.1:8429/targets](http://127.0.0.1:8429/targets) . You will see something like this: -

- -

+ `VMAgent` connects to [kubernetes service discovery](https://kubernetes.io/docs/concepts/services-networking/service/) and gets targets which needs to be scraped. This service discovery is controlled by [VictoriaMetrics Operator](https://github.com/VictoriaMetrics/operator) @@ -311,15 +309,11 @@ EOF To check that [VictoriaMetrics](https://victoriametrics.com) collecting metrics from the k8s cluster open in your browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose the `VictoriaMetrics - cluster` dashboard. Use `admin` for login and the `password` that you previously got from kubectl. -

- grafana dashboards -

+grafana dashboards The expected output is: -

- grafana dashboards -

+grafana dashboards ## 6. Summary diff --git a/docs/guides/guide-vmcluster-multiple-retention-setup.md b/docs/guides/guide-vmcluster-multiple-retention-setup.md index 897b140789..7ed6959398 100644 --- a/docs/guides/guide-vmcluster-multiple-retention-setup.md +++ b/docs/guides/guide-vmcluster-multiple-retention-setup.md @@ -34,9 +34,7 @@ The [-retentionPeriod](https://docs.victoriametrics.com/#retention) sets how lon The diagram below shows a proposed solution -

- -

+ **Implementation Details** diff --git a/docs/guides/k8s-ha-monitoring-via-vm-cluster.md b/docs/guides/k8s-ha-monitoring-via-vm-cluster.md index 243fa9ce85..2e08714261 100644 --- a/docs/guides/k8s-ha-monitoring-via-vm-cluster.md +++ b/docs/guides/k8s-ha-monitoring-via-vm-cluster.md @@ -377,21 +377,15 @@ The expected result of the query `count(up{kubernetes_pod_name=~".*vmselect.*"}) To test via Grafana, we need to install it first. [Install and connect Grafana to VictoriaMetrics](https://docs.victoriametrics.com/guides/k8s-monitoring-via-vm-cluster.html#4-install-and-connect-grafana-to-victoriametrics-with-helm), login into Grafana and open the metrics [Explore](http://127.0.0.1:3000/explore) page. -

- grafana explore -

+grafana explore Choose `victoriametrics` from the list of datasources and enter `count(up{kubernetes_pod_name=~".*vmselect.*"})` to the **Metric browser** field as shown on the screenshot, then press **Run query** button: -

- -

+ The expected output is: -

- -

+ ## 5. High Availability @@ -423,17 +417,13 @@ Return to Grafana Explore and press the **Run query** button again. The expected output is: -

- -

+ As you can see, after we scaled down the `vmstorage` replicas number from three to two pods, metrics are still available and correct. The response is not partial as it was before scaling. Also we see that query `count(up{kubernetes_pod_name=~".*vmselect.*"})` returns the same value as before. To confirm that the number of `vmstorage` pods is equivalent to two, execute the following request in Grafana Explore: -

- -

+ ## 6. Final thoughts diff --git a/docs/guides/k8s-monitoring-via-vm-cluster.md b/docs/guides/k8s-monitoring-via-vm-cluster.md index 6a95c7e991..18af05dde5 100644 --- a/docs/guides/k8s-monitoring-via-vm-cluster.md +++ b/docs/guides/k8s-monitoring-via-vm-cluster.md @@ -26,9 +26,7 @@ We will use: * [Helm 3 ](https://helm.sh/docs/intro/install) * [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl) -

- VictoriaMetrics Cluster on Kubernetes cluster -

+VictoriaMetrics Cluster on Kubernetes cluster ## 1. VictoriaMetrics Helm repository @@ -535,24 +533,19 @@ kubectl --namespace default port-forward $POD_NAME 3000 To check that [VictoriaMetrics](https://victoriametrics.com) collects metrics from k8s cluster open in browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose the `Kubernetes Cluster Monitoring (via Prometheus)` dashboard. Use `admin` for login and `password` that you previously got from kubectl. -

- grafana dashboards -

+grafana dashboards You will see something like this: -

- Kubernetes metrics provided by vmcluster -

+ +Kubernetes metrics provided by vmcluster The VictoriaMetrics dashboard is also available to use: -

- VictoriaMetrics cluster dashboard -

+ +VictoriaMetrics cluster dashboard vmagent has its own dashboard: -

- vmagent dashboard -

+ +vmagent dashboard ## 6. Final thoughts diff --git a/docs/guides/k8s-monitoring-via-vm-single.md b/docs/guides/k8s-monitoring-via-vm-single.md index b82fe9adc2..81a3d84b72 100644 --- a/docs/guides/k8s-monitoring-via-vm-single.md +++ b/docs/guides/k8s-monitoring-via-vm-single.md @@ -26,9 +26,7 @@ We will use: * [Helm 3 ](https://helm.sh/docs/intro/install) * [kubectl 1.21](https://kubernetes.io/docs/tasks/tools/install-kubectl) -

- VictoriaMetrics Single on Kubernetes cluster -

+VictoriaMetrics Single on Kubernetes cluster ## 1. VictoriaMetrics Helm repository @@ -340,19 +338,15 @@ Now Grafana should be accessible on the [http://127.0.0.1:3000](http://127.0.0.1 To check that VictoriaMetrics has collects metrics from the k8s cluster open in browser [http://127.0.0.1:3000/dashboards](http://127.0.0.1:3000/dashboards) and choose `Kubernetes Cluster Monitoring (via Prometheus)` dashboard. Use `admin` for login and `password` that you previously obtained from kubectl. -

- -

+ You will see something like this: -

- -

+ + VictoriaMetrics dashboard also available to use: -

- -

+ + ## 5. Final thoughts diff --git a/docs/guides/multi-regional-setup-dedicated-regions.md b/docs/guides/multi-regional-setup-dedicated-regions.md index 58627dde9f..fbb1174792 100644 --- a/docs/guides/multi-regional-setup-dedicated-regions.md +++ b/docs/guides/multi-regional-setup-dedicated-regions.md @@ -16,12 +16,7 @@ Let's cover the case. You have multiple regions with workloads and want to colle The monitoring setup is in the dedicated regions as shown below: -

- Multi-regional setup with VictoriaMetrics: Dedicated regions for monitoring -

+Multi-regional setup with VictoriaMetrics: Dedicated regions for monitoring Every workload region (Earth, Mars, Venus) has a vmagent that sends data to multiple regions with a monitoring setup. The monitoring setup (Ground Control 1,2) contains VictoriaMetrics Time Series Database(TSDB) cluster or single.