From 4c94fe0f0abd7272878cb59775b135a9be1078d0 Mon Sep 17 00:00:00 2001 From: Craig Rodrigues Date: Mon, 6 Mar 2023 03:44:33 -0800 Subject: [PATCH] docs: move installation methods further up in README (#3904) --- docs/README.md | 26 +++++++++++++++----------- docs/Single-server-VictoriaMetrics.md | 26 +++++++++++++++----------- 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/docs/README.md b/docs/README.md index eb7a413f9..fa36a4205 100644 --- a/docs/README.md +++ b/docs/README.md @@ -127,11 +127,22 @@ See also [articles and slides about VictoriaMetrics from our users](https://docs ## Operation -### How to start VictoriaMetrics +### Install -Just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. +To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. See also [QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for additional information. +VictoriaMetrics can also be installed via these installation methods: + +* [Helm charts for single-node and cluster versions of VictoriaMetrics](https://github.com/VictoriaMetrics/helm-charts). +* [Kubernetes operator for VictoriaMetrics](https://github.com/VictoriaMetrics/operator). +* [Ansible role for installing cluster VictoriaMetrics (by VictoriaMetrics)](https://github.com/VictoriaMetrics/ansible-playbooks). +* [Ansible role for installing cluster VictoriaMetrics (by community)](https://github.com/Slapper/ansible-victoriametrics-cluster-role). +* [Ansible role for installing single-node VictoriaMetrics (by community)](https://github.com/dreamteam-gg/ansible-victoriametrics-role). +* [Snap package for VictoriaMetrics](https://snapcraft.io/victoriametrics). + +### How to start VictoriaMetrics + The following command-line flags are used the most: * `-storageDataPath` - VictoriaMetrics stores all the data in this directory. Default path is `victoria-metrics-data` in the current working directory. @@ -2040,17 +2051,10 @@ It is safe sharing the collected profiles from security point of view, since the ## Integrations -* [Helm charts for single-node and cluster versions of VictoriaMetrics](https://github.com/VictoriaMetrics/helm-charts). -* [Kubernetes operator for VictoriaMetrics](https://github.com/VictoriaMetrics/operator). -* [netdata](https://github.com/netdata/netdata) can push data into VictoriaMetrics via `Prometheus remote_write API`. - See [these docs](https://github.com/netdata/netdata#integrations). * [go-graphite/carbonapi](https://github.com/go-graphite/carbonapi) can use VictoriaMetrics as time series backend. See [this example](https://github.com/go-graphite/carbonapi/blob/main/cmd/carbonapi/carbonapi.example.victoriametrics.yaml). -* [Ansible role for installing cluster VictoriaMetrics (by VictoriaMetrics)](https://github.com/VictoriaMetrics/ansible-playbooks). -* [Ansible role for installing cluster VictoriaMetrics (by community)](https://github.com/Slapper/ansible-victoriametrics-cluster-role). -* [Ansible role for installing single-node VictoriaMetrics (by community)](https://github.com/dreamteam-gg/ansible-victoriametrics-role). - -* [Snap package for VictoriaMetrics](https://snapcraft.io/victoriametrics). +* [netdata](https://github.com/netdata/netdata) can push data into VictoriaMetrics via `Prometheus remote_write API`. + See [these docs](https://github.com/netdata/netdata#integrations). * [vmalert-cli](https://github.com/aorfanos/vmalert-cli) - a CLI application for managing [vmalert](https://docs.victoriametrics.com/vmalert.html). ## Third-party contributions diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index ddaf0f2ed..cbb832610 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -130,11 +130,22 @@ See also [articles and slides about VictoriaMetrics from our users](https://docs ## Operation -### How to start VictoriaMetrics +### Install -Just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. +To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. See also [QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for additional information. +VictoriaMetrics can also be installed via these installation methods: + +* [Helm charts for single-node and cluster versions of VictoriaMetrics](https://github.com/VictoriaMetrics/helm-charts). +* [Kubernetes operator for VictoriaMetrics](https://github.com/VictoriaMetrics/operator). +* [Ansible role for installing cluster VictoriaMetrics (by VictoriaMetrics)](https://github.com/VictoriaMetrics/ansible-playbooks). +* [Ansible role for installing cluster VictoriaMetrics (by community)](https://github.com/Slapper/ansible-victoriametrics-cluster-role). +* [Ansible role for installing single-node VictoriaMetrics (by community)](https://github.com/dreamteam-gg/ansible-victoriametrics-role). +* [Snap package for VictoriaMetrics](https://snapcraft.io/victoriametrics). + +### How to start VictoriaMetrics + The following command-line flags are used the most: * `-storageDataPath` - VictoriaMetrics stores all the data in this directory. Default path is `victoria-metrics-data` in the current working directory. @@ -2043,17 +2054,10 @@ It is safe sharing the collected profiles from security point of view, since the ## Integrations -* [Helm charts for single-node and cluster versions of VictoriaMetrics](https://github.com/VictoriaMetrics/helm-charts). -* [Kubernetes operator for VictoriaMetrics](https://github.com/VictoriaMetrics/operator). -* [netdata](https://github.com/netdata/netdata) can push data into VictoriaMetrics via `Prometheus remote_write API`. - See [these docs](https://github.com/netdata/netdata#integrations). * [go-graphite/carbonapi](https://github.com/go-graphite/carbonapi) can use VictoriaMetrics as time series backend. See [this example](https://github.com/go-graphite/carbonapi/blob/main/cmd/carbonapi/carbonapi.example.victoriametrics.yaml). -* [Ansible role for installing cluster VictoriaMetrics (by VictoriaMetrics)](https://github.com/VictoriaMetrics/ansible-playbooks). -* [Ansible role for installing cluster VictoriaMetrics (by community)](https://github.com/Slapper/ansible-victoriametrics-cluster-role). -* [Ansible role for installing single-node VictoriaMetrics (by community)](https://github.com/dreamteam-gg/ansible-victoriametrics-role). - -* [Snap package for VictoriaMetrics](https://snapcraft.io/victoriametrics). +* [netdata](https://github.com/netdata/netdata) can push data into VictoriaMetrics via `Prometheus remote_write API`. + See [these docs](https://github.com/netdata/netdata#integrations). * [vmalert-cli](https://github.com/aorfanos/vmalert-cli) - a CLI application for managing [vmalert](https://docs.victoriametrics.com/vmalert.html). ## Third-party contributions