mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
docs/enterprise: add info about license flags (#5085)
* docs/enterprise: add info about license flags Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/enterprise: add more examples on how to run enterprise components Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/enterprise: address review feedback Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/enterprise: specify release version Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/enterprise: fix image tag in example Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> * docs/enterprise: add docker-compose example, fix secret name Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
This commit is contained in:
Zakhar Bessarab
Aliaksandr Valialkin
parent
5c87066f8c
commit
07586c1d8f
2 changed files with 226 additions and 6 deletions
|
|
@ -20,16 +20,17 @@ and [the license](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master
|
|||
|
||||
The use of VictoriaMetrics enterprise components is permitted in the following cases:
|
||||
|
||||
- Evaluation use in non-production setups. Just download and run enterprise binaries or packages of VictoriaMetrics
|
||||
components from usual places - [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) and [docker hub](https://hub.docker.com/u/victoriametrics).
|
||||
- Evaluation use in non-production setups. Please, request trial license [here](https://victoriametrics.com/products/enterprise/).
|
||||
Trial key will be sent to your email after filling the trial form.
|
||||
Download components from usual places - [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) and [docker hub](https://hub.docker.com/u/victoriametrics).
|
||||
Enterprise binaries and packages have `enterprise` suffix in their names.
|
||||
|
||||
- Production use if you have a valid enterprise contract or valid permit from VictoriaMetrics company.
|
||||
[Contact us](mailto:info@victoriametrics.com) if you need such contract.
|
||||
[Contact us](mailto:sales@victoriametrics.com) if you need such contract.
|
||||
|
||||
- [Managed VictoriaMetrics](https://docs.victoriametrics.com/managed-victoriametrics/) is built on top of enterprise binaries of VictoriaMetrics.
|
||||
|
||||
All the enterprise apps require `-eula` command-line flag to be passed to them. This flag acknowledges that your usage fits one of the cases listed above.
|
||||
See [running VictoriaMetrics enterprise](#running-victoriametrics-enterprise) for details on how to run VictoriaMetrics enterprise.
|
||||
|
||||
## VictoriaMetrics enterprise features
|
||||
|
||||
|
|
@ -61,3 +62,222 @@ On top of this, enterprise package of VictoriaMetrics includes the following imp
|
|||
- Prioritizing of feature requests from Enterprise customers.
|
||||
|
||||
[Contact us](mailto:info@victoriametrics.com) if you are interested in VictoriaMetrics enterprise.
|
||||
|
||||
## Running VictoriaMetrics enterprise
|
||||
|
||||
There are several ways to run VictoriaMetrics enterprise:
|
||||
- [Binary releases](#binary-releases)
|
||||
- [Docker images](#docker-images)
|
||||
- [Helm charts](#helm-charts)
|
||||
- [Kubernetes operator](#kubernetes-operator)
|
||||
|
||||
### Binary releases
|
||||
|
||||
Binary releases of VictoriaMetrics enterprise are available [here](https://github.com/VictoriaMetrics/VictoriaMetrics/releases).
|
||||
Enterprise binaries and packages have `enterprise` suffix in their names. For example, `victoria-metrics-linux-amd64-v1.94.0-enterprise.tar.gz`.
|
||||
|
||||
In order to run binary release of VictoriaMetrics enterprise, download the release for your OS and unpack it.
|
||||
Then run `victoria-metrics-enterprise` binary from the unpacked directory.
|
||||
|
||||
Before v1.94.0 all the enterprise apps required `-eula` command-line flag to be passed to them.
|
||||
This flag acknowledges that your usage fits one of the cases listed above.
|
||||
|
||||
After v1.94.0 either `-eula` flag or the following flags are used:
|
||||
```console
|
||||
-license string
|
||||
See https://victoriametrics.com/products/enterprise/ for trial license
|
||||
-license-file string
|
||||
See https://victoriametrics.com/products/enterprise/ for trial license
|
||||
-license.forceOffline
|
||||
Force offline verification of license code. License is verified online by default. This flag runs license verification offline.
|
||||
```
|
||||
|
||||
For example, the following command runs `victoria-metrics-enterprise` binary with the specified license:
|
||||
```console
|
||||
wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.94.0/victoria-metrics-linux-amd64-v1.94.0-enterprise.tar.gz
|
||||
tar -xzf victoria-metrics-linux-amd64-v1.94.0-enterprise.tar.gz
|
||||
./victoria-metrics-prod -license={VM_KEY_VALUE}
|
||||
```
|
||||
|
||||
Alternatively, the license can be specified via `-license-file` command-line flag:
|
||||
```console
|
||||
./victoria-metrics-prod -license-file=/path/to/license/file
|
||||
```
|
||||
|
||||
The license file must contain the license key.
|
||||
|
||||
### Docker images
|
||||
|
||||
Docker images for VictoriaMetrics enterprise are available [here](https://hub.docker.com/u/victoriametrics).
|
||||
Enterprise docker images have `enterprise` suffix in their names. For example, `victoriametrics/victoria-metrics:v1.94.0-enteprise`.
|
||||
|
||||
In order to run docker image of VictoriaMetrics enterprise component it is required to provide the license key command-line
|
||||
flag similar to the one described in the previous section.
|
||||
|
||||
For example, the following command runs [VictoriaMetrics single-node](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html) docker image with the specified license:
|
||||
```console
|
||||
docker run --name=victoria-metrics victoriametrics/victoria-metrics:v1.94.0-enteprise -license={VM_KEY_VALUE}
|
||||
```
|
||||
|
||||
Alternatively, the license can be specified via `-license-file` command-line flag:
|
||||
```console
|
||||
docker run --name=victoria-metrics -v /vm-license:/vm-license victoriametrics/victoria-metrics:v1.94.0-enteprise -license-file=/vm-license
|
||||
```
|
||||
|
||||
Example docker-compose configuration:
|
||||
```yaml
|
||||
version: "3.5"
|
||||
services:
|
||||
victoriametrics:
|
||||
container_name: victoriametrics
|
||||
image: victoriametrics/victoria-metrics:v1.94.0
|
||||
ports:
|
||||
- 8428:8428
|
||||
volumes:
|
||||
- vmdata:/storage
|
||||
- /vm-license:/vm-license
|
||||
command:
|
||||
- "--storageDataPath=/storage"
|
||||
- "--license-file=/vm-license"
|
||||
volumes:
|
||||
vmdata: {}
|
||||
```
|
||||
Note, that example assumes that license file is located at `/vm-license` path on the host.
|
||||
|
||||
### Helm charts
|
||||
|
||||
Helm charts for VictoriaMetrics components are available [here](https://github.com/VictoriaMetrics/helm-charts).
|
||||
|
||||
In order to run VictoriaMetrics enterprise helm chart it is required to provide the license key via `license` value in `values.yaml` file
|
||||
and adjust the image tag to the enterprise one.
|
||||
|
||||
For example, the following values file for [VictoriaMetrics single-node chart](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-single)
|
||||
is used to provide key in plain-text:
|
||||
```yaml
|
||||
server:
|
||||
image:
|
||||
tag: v1.94.0-enterprise
|
||||
|
||||
license:
|
||||
key: {VM_KEY_VALUE}
|
||||
```
|
||||
|
||||
In order to provide key via existing secret, the following values file is used:
|
||||
```yaml
|
||||
server:
|
||||
image:
|
||||
tag: v1.94.0-enterprise
|
||||
|
||||
license:
|
||||
secret:
|
||||
name: vm-license
|
||||
key: license
|
||||
```
|
||||
|
||||
Example secret with license key:
|
||||
```yaml
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: vm-license
|
||||
type: Opaque
|
||||
data:
|
||||
license: {BASE64_ENCODED_LICENSE_KEY}
|
||||
```
|
||||
|
||||
Or create secret via `kubectl`:
|
||||
```console
|
||||
kubectl create secret generic vm-license --from-literal=license={VM_KEY_VALUE}
|
||||
```
|
||||
|
||||
### Kubernetes operator
|
||||
|
||||
VictoriaMetrics enterprise components can be deployed via [VictoriaMetrics operator](https://docs.victoriametrics.com/operator/).
|
||||
In order to use enterprise components it is required to provide the license key via `license` field and adjust the image tag to the enterprise one.
|
||||
|
||||
For example, the following custom resource for [VictoriaMetrics single-node](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html)
|
||||
is used to provide key in plain-text:
|
||||
```yaml
|
||||
apiVersion: operator.victoriametrics.com/v1beta1
|
||||
kind: VMSingle
|
||||
metadata:
|
||||
name: example-vmsingle
|
||||
spec:
|
||||
retentionPeriod: "1"
|
||||
license:
|
||||
key: "VM_KEY_VALUE"
|
||||
image:
|
||||
tag: v1.94.0-enterprise
|
||||
```
|
||||
|
||||
In order to provide key via existing secret, the following custom resource is used:
|
||||
```yaml
|
||||
apiVersion: operator.victoriametrics.com/v1beta1
|
||||
kind: VMSingle
|
||||
metadata:
|
||||
name: example-vmsingle
|
||||
spec:
|
||||
retentionPeriod: "1"
|
||||
license:
|
||||
keyRef:
|
||||
name: vm-license
|
||||
key: license
|
||||
image:
|
||||
tag: v1.94.0-enterprise
|
||||
```
|
||||
|
||||
Example secret with license key:
|
||||
```yaml
|
||||
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: vm-license
|
||||
type: Opaque
|
||||
data:
|
||||
license: {BASE64_ENCODED_LICENSE_KEY}
|
||||
```
|
||||
|
||||
Or create secret via `kubectl`:
|
||||
```console
|
||||
kubectl create secret generic vm-license --from-literal=license={VM_KEY_VALUE}
|
||||
```
|
||||
|
||||
See full list of CRD specifications [here](https://docs.victoriametrics.com/operator/api.html).
|
||||
|
||||
## Monitoring license expiration
|
||||
|
||||
All victoria metrics enterprise components expose the following metrics:
|
||||
```
|
||||
vm_license_expires_at 1694304000
|
||||
vm_license_expires_in_seconds 1592720
|
||||
```
|
||||
Please, refer to monitoring section of each component for details on how to scrape these metrics.
|
||||
|
||||
`vm_license_expires_at` is the expiration date in unix timestamp format.
|
||||
`vm_license_expires_in_seconds` is the amount of seconds until the license expires.
|
||||
|
||||
Example alerts for [vmalert](https://docs.victoriametrics.com/vmalert.html):
|
||||
```yaml
|
||||
groups:
|
||||
- name: vm-license
|
||||
# note the `job` label and update accordingly to your setup
|
||||
rules:
|
||||
- alert: LicenseExpiresInLessThan30Days
|
||||
expr: vm_license_expires_in_seconds < 30 * 24 * 3600
|
||||
labels:
|
||||
severity: warning
|
||||
annotations:
|
||||
summary: "{{ $labels.job }} instance {{ $labels.instance }} license expires in less than 30 days"
|
||||
description: "{{ $labels.instance }} of job {{ $labels.job }} license expires in {{ $value | humanizeDuration }}.
|
||||
Please make sure to update the license before it expires."
|
||||
|
||||
- alert: LicenseExpiresInLessThan7Days
|
||||
expr: vm_license_expires_in_seconds < 7 * 24 * 3600
|
||||
labels:
|
||||
severity: critical
|
||||
annotations:
|
||||
summary: "{{ $labels.job }} instance {{ $labels.instance }} license expires in less than 7 days"
|
||||
description: "{{ $labels.instance }} of job {{ $labels.job }} license expires in {{ $value | humanizeDuration }}.
|
||||
Please make sure to update the license before it expires."
|
||||
```
|
||||
|
|
|
|||
|
|
@ -205,11 +205,11 @@ vm_license_expires_at 1.6963776e+09
|
|||
vm_license_expires_in_seconds 4.886608e+06
|
||||
```
|
||||
|
||||
You can find example alerts for [vmalert](https://docs.victoriametrics.com/vmalert.html):
|
||||
Example alerts for [vmalert](https://docs.victoriametrics.com/vmalert.html):
|
||||
```yaml
|
||||
groups:
|
||||
- name: vm-license
|
||||
# note the `job` filter and update accordingly to your setup
|
||||
# note the `job` label and update accordingly to your setup
|
||||
rules:
|
||||
- alert: LicenseExpiresInLessThan30Days
|
||||
expr: vm_license_expires_in_seconds < 30 * 24 * 3600
|
||||
|
|
|
|||
Loading…
Reference in a new issue