Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-23 20:37:12 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

docs: update VictoriaMetrics release from v1.100.1 to v1.101.0 across all the docs

Browse Source 
This is a follow-up for 5e8c087d42

Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6194
This commit is contained in:
Aliaksandr Valialkin 2024-07-03 01:06:27 +02:00
parent 61d794c5e7
commit 916d285f9f
No known key found for this signature in database
GPG Key ID: 52C003EE2BCDB9EB
3 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/anomaly-detection/guides/guide-vmanomaly-vmalert.md
View File

@ -19,9 +19,9 @@ aliases:
- To use *vmanomaly*, part of the enterprise package, a license key is required. Obtain your key [here](https://victoriametrics.com/products/enterprise/trial/) for this tutorial or for enterprise use. - To use *vmanomaly*, part of the enterprise package, a license key is required. Obtain your key [here](https://victoriametrics.com/products/enterprise/trial/) for this tutorial or for enterprise use.
- In the tutorial, we'll be using the following VictoriaMetrics components: - In the tutorial, we'll be using the following VictoriaMetrics components:
- [VictoriaMetrics Single-Node](https://docs.victoriametrics.com/single-server-victoriametrics/) (v1.100.1) - [VictoriaMetrics Single-Node](https://docs.victoriametrics.com/single-server-victoriametrics/) (v1.101.0)
- [vmalert](https://docs.victoriametrics.com/vmalert/) (v1.100.1) - [vmalert](https://docs.victoriametrics.com/vmalert/) (v1.101.0)
- [vmagent](https://docs.victoriametrics.com/vmagent/) (v1.100.1) - [vmagent](https://docs.victoriametrics.com/vmagent/) (v1.101.0)
- [Grafana](https://grafana.com/) (v.10.2.1) - [Grafana](https://grafana.com/) (v.10.2.1)
- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/) - [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/)
- [Node exporter](https://github.com/prometheus/node_exporter#node-exporter) (v1.7.0) and [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) (v0.27.0) - [Node exporter](https://github.com/prometheus/node_exporter#node-exporter) (v1.7.0) and [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) (v0.27.0)
@ -330,7 +330,7 @@ Let's wrap it all up together into the `docker-compose.yml` file.
services: services:
vmagent: vmagent:
container_name: vmagent container_name: vmagent
image: victoriametrics/vmagent:v1.100.1 image: victoriametrics/vmagent:v1.101.0
depends_on: depends_on:
- "victoriametrics" - "victoriametrics"
ports: ports:
@ -347,7 +347,7 @@ services:
victoriametrics: victoriametrics:
container_name: victoriametrics container_name: victoriametrics
image: victoriametrics/victoria-metrics:v1.100.1 image: victoriametrics/victoria-metrics:v1.101.0
ports: ports:
- 8428:8428 - 8428:8428
volumes: volumes:
@ -380,7 +380,7 @@ services:
vmalert: vmalert:
container_name: vmalert container_name: vmalert
image: victoriametrics/vmalert:v1.100.1 image: victoriametrics/vmalert:v1.101.0
depends_on: depends_on:
- "victoriametrics" - "victoriametrics"
ports: ports:
@ -529,4 +529,4 @@ Key takeaways include:
As you continue to use VictoriaMetrics Anomaly Detection and `vmalert`, remember that the effectiveness of anomaly detection largely depends on the appropriateness of the model chosen, the accuracy of configurations and the data patterns observed. This guide serves as a starting point, and we encourage you to experiment with different configurations and models to best suit your specific data needs and use cases. In case you need a helping hand - [contact us](https://victoriametrics.com/contact-us/). As you continue to use VictoriaMetrics Anomaly Detection and `vmalert`, remember that the effectiveness of anomaly detection largely depends on the appropriateness of the model chosen, the accuracy of configurations and the data patterns observed. This guide serves as a starting point, and we encourage you to experiment with different configurations and models to best suit your specific data needs and use cases. In case you need a helping hand - [contact us](https://victoriametrics.com/contact-us/).
> **Note:** Starting from [v1.13.0](/anomaly-detection/CHANGELOG#v1130) `node-exporter` observability preset is available for `vmanomaly`. Please find the guide [here](/anomaly-detection/presets/#node-exporter). > **Note:** Starting from [v1.13.0](/anomaly-detection/CHANGELOG#v1130) `node-exporter` observability preset is available for `vmanomaly`. Please find the guide [here](/anomaly-detection/presets/#node-exporter).

22
docs/enterprise.md
View File

@ -85,7 +85,7 @@ VictoriaMetrics Enterprise components are available in the following forms:
It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise). It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
Binary releases of VictoriaMetrics Enterprise are available [at the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). Binary releases of VictoriaMetrics Enterprise are available [at the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest).
Enterprise binaries and packages have `enterprise` suffix in their names. For example, `victoria-metrics-linux-amd64-v1.100.1-enterprise.tar.gz`. Enterprise binaries and packages have `enterprise` suffix in their names. For example, `victoria-metrics-linux-amd64-v1.101.0-enterprise.tar.gz`.
In order to run binary release of VictoriaMetrics Enterprise component, please download the `*-enterprise.tar.gz` archive for your OS and architecture In order to run binary release of VictoriaMetrics Enterprise component, please download the `*-enterprise.tar.gz` archive for your OS and architecture
from the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and unpack it. Then run the unpacked binary. from the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and unpack it. Then run the unpacked binary.
@ -102,8 +102,8 @@ For example, the following command runs VictoriaMetrics Enterprise binary with t
obtained at [this page](https://victoriametrics.com/products/enterprise/trial/): obtained at [this page](https://victoriametrics.com/products/enterprise/trial/):
```sh ```sh
wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.100.1/victoria-metrics-linux-amd64-v1.100.1-enterprise.tar.gz wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.101.0/victoria-metrics-linux-amd64-v1.101.0-enterprise.tar.gz
tar -xzf victoria-metrics-linux-amd64-v1.100.1-enterprise.tar.gz tar -xzf victoria-metrics-linux-amd64-v1.101.0-enterprise.tar.gz
./victoria-metrics-prod -license=BASE64_ENCODED_LICENSE_KEY ./victoria-metrics-prod -license=BASE64_ENCODED_LICENSE_KEY
``` ```
@ -118,7 +118,7 @@ Alternatively, VictoriaMetrics Enterprise license can be stored in the file and
It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise). It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
Docker images for VictoriaMetrics Enterprise are available [at VictoriaMetrics DockerHub](https://hub.docker.com/u/victoriametrics). Docker images for VictoriaMetrics Enterprise are available [at VictoriaMetrics DockerHub](https://hub.docker.com/u/victoriametrics).
Enterprise docker images have `enterprise` suffix in their names. For example, `victoriametrics/victoria-metrics:v1.100.1-enterprise`. Enterprise docker images have `enterprise` suffix in their names. For example, `victoriametrics/victoria-metrics:v1.101.0-enterprise`.
In order to run Docker image of VictoriaMetrics Enterprise component, it is required to provide the license key via command-line In order to run Docker image of VictoriaMetrics Enterprise component, it is required to provide the license key via command-line
flag as described [here](#binary-releases). flag as described [here](#binary-releases).
@ -128,13 +128,13 @@ Enterprise license key can be obtained at [this page](https://victoriametrics.co
For example, the following command runs VictoriaMetrics Enterprise Docker image with the specified license key: For example, the following command runs VictoriaMetrics Enterprise Docker image with the specified license key:
```sh ```sh
docker run --name=victoria-metrics victoriametrics/victoria-metrics:v1.100.1-enterprise -license=BASE64_ENCODED_LICENSE_KEY docker run --name=victoria-metrics victoriametrics/victoria-metrics:v1.101.0-enterprise -license=BASE64_ENCODED_LICENSE_KEY
``` ```
Alternatively, the license code can be stored in the file and then referred via `-licenseFile` command-line flag: Alternatively, the license code can be stored in the file and then referred via `-licenseFile` command-line flag:
```sh ```sh
docker run --name=victoria-metrics -v /vm-license:/vm-license victoriametrics/victoria-metrics:v1.100.1-enterprise -licenseFile=/path/to/vm-license docker run --name=victoria-metrics -v /vm-license:/vm-license victoriametrics/victoria-metrics:v1.101.0-enterprise -licenseFile=/path/to/vm-license
``` ```
Example docker-compose configuration: Example docker-compose configuration:
@ -143,7 +143,7 @@ version: "3.5"
services: services:
victoriametrics: victoriametrics:
container_name: victoriametrics container_name: victoriametrics
image: victoriametrics/victoria-metrics:v1.100.1 image: victoriametrics/victoria-metrics:v1.101.0
ports: ports:
- 8428:8428 - 8428:8428
volumes: volumes:
@ -175,7 +175,7 @@ is used to provide key in plain-text:
```yaml ```yaml
server: server:
image: image:
tag: v1.100.1-enterprise tag: v1.101.0-enterprise
license: license:
key: {BASE64_ENCODED_LICENSE_KEY} key: {BASE64_ENCODED_LICENSE_KEY}
@ -186,7 +186,7 @@ In order to provide key via existing secret, the following values file is used:
```yaml ```yaml
server: server:
image: image:
tag: v1.100.1-enterprise tag: v1.101.0-enterprise
license: license:
secret: secret:
@ -233,7 +233,7 @@ spec:
license: license:
key: {BASE64_ENCODED_LICENSE_KEY} key: {BASE64_ENCODED_LICENSE_KEY}
image: image:
tag: v1.100.1-enterprise tag: v1.101.0-enterprise
``` ```
In order to provide key via existing secret, the following custom resource is used: In order to provide key via existing secret, the following custom resource is used:
@ -250,7 +250,7 @@ spec:
name: vm-license name: vm-license
key: license key: license
image: image:
tag: v1.100.1-enterprise tag: v1.101.0-enterprise
``` ```
Example secret with license key: Example secret with license key:

8
docs/scrape_config_examples.md
View File

@ -34,8 +34,8 @@ scrape_configs:
After you created the `scrape.yaml` file, download and unpack [single-node VictoriaMetrics](https://docs.victoriametrics.com/) to the same directory: After you created the `scrape.yaml` file, download and unpack [single-node VictoriaMetrics](https://docs.victoriametrics.com/) to the same directory:
``` ```
wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.100.1/victoria-metrics-linux-amd64-v1.100.1.tar.gz wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.101.0/victoria-metrics-linux-amd64-v1.101.0.tar.gz
tar xzf victoria-metrics-linux-amd64-v1.100.1.tar.gz tar xzf victoria-metrics-linux-amd64-v1.101.0.tar.gz
``` ```
Then start VictoriaMetrics and instruct it to scrape targets defined in `scrape.yaml` and save scraped metrics Then start VictoriaMetrics and instruct it to scrape targets defined in `scrape.yaml` and save scraped metrics
@ -150,8 +150,8 @@ Then start [single-node VictoriaMetrics](https://docs.victoriametrics.com/) acco
```yaml ```yaml
# Download and unpack single-node VictoriaMetrics # Download and unpack single-node VictoriaMetrics
wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.100.1/victoria-metrics-linux-amd64-v1.100.1.tar.gz wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.101.0/victoria-metrics-linux-amd64-v1.101.0.tar.gz
tar xzf victoria-metrics-linux-amd64-v1.100.1.tar.gz tar xzf victoria-metrics-linux-amd64-v1.101.0.tar.gz
# Run single-node VictoriaMetrics with the given scrape.yaml # Run single-node VictoriaMetrics with the given scrape.yaml
./victoria-metrics-prod -promscrape.config=scrape.yaml ./victoria-metrics-prod -promscrape.config=scrape.yaml