github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/docs/enterprise.md

307 lines
13 KiB
Markdown
Raw Normal View History

docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
---
sort: 99
prepare static docs to migration Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-30 10:31:45 +00:00
weight: 99
title: VictoriaMetrics Enterprise
menu:
docs:
vmalert-tool: implement unittest (#4789) 1. split package rule under /app/vmalert, expose needed objects 2. add vmalert-tool with unittest subcmd https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2945
2023-10-13 11:54:33 +00:00
parent: 'victoriametrics'
prepare static docs to migration Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-30 10:31:45 +00:00
weight: 99
aliases:
- /enterprise.html
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
---
docs: fix enterprise page title to match with official name Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-29 20:39:56 +00:00
# VictoriaMetrics Enterprise
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
VictoriaMetrics components are provided in two kinds - [Community edition](https://victoriametrics.com/products/open-source/)
and [Enterprise edition](https://victoriametrics.com/products/enterprise/).
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
VictoriaMetrics community components are open source and are free to use - see [the source code](https://github.com/VictoriaMetrics/VictoriaMetrics/)
and [the license](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/LICENSE).
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest releases at the top, such as LTS releases or VictoriaLogs releases. So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link, which always redirect to the latest available release of VictoriaMetrics.
2023-10-18 18:06:23 +00:00
VictoriaMetrics Enterprise components are available in binary form at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest)
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
and at [docker hub](https://hub.docker.com/u/victoriametrics). Enterprise binaries and packages have `enterprise` suffix in their names.
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
## Valid cases for VictoriaMetrics Enterprise
The use of VictoriaMetrics Enterprise components is permitted in the following cases:
- Evaluation use in non-production setups. Please, request trial license [here](https://victoriametrics.com/products/enterprise/trial/)
and then pass it via `-license` or `-licenseFile` command-line flags as described [in these docs](#running-victoriametrics-enterprise).
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
- Production use if you have a valid enterprise contract or valid permit from VictoriaMetrics company.
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Please contact us via [this page](https://victoriametrics.com/products/enterprise/) if you are intereseted in such a contract.
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
- [Managed VictoriaMetrics](https://docs.victoriametrics.com/managed-victoriametrics/) is built on top of VictoriaMetrics Enterprise.
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
See [these docs](#running-victoriametrics-enterprise) for details on how to run VictoriaMetrics enterprise.
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
## VictoriaMetrics enterprise features
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
VictoriaMetrics Enterprise includes [all the features of the community edition](https://docs.victoriametrics.com/#prominent-features),
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
plus the following additional features:
- [Downsampling](https://docs.victoriametrics.com/#downsampling) - this feature allows reducing storage costs
and increasing performance for queries over historical data.
- [Multiple retentions](https://docs.victoriametrics.com/#retention-filters) - this feature allows reducing storage costs
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
by specifying different retentions for different datasets.
app/{vminsert,vmselect}: add support for automatic discovery and update of vmstorage nodes Thanks to @dmitryk-dk for the initial implemenation at https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/pull/446
2022-10-28 10:07:40 +00:00
- [Automatic discovery of vmstorage nodes](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#automatic-vmstorage-discovery) -
this feature allows updating the list of `vmstorage` nodes at `vminsert` and `vmselect` without the need to restart these services.
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
- [Backup automation](https://docs.victoriametrics.com/vmbackupmanager.html).
- [Advanced per-tenant stats](https://docs.victoriametrics.com/PerTenantStatistic.html).
- [Advanced auth and rate limiter](https://docs.victoriametrics.com/vmgateway.html).
- [mTLS for cluster components](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#mtls-protection).
- [Kafka integration](https://docs.victoriametrics.com/vmagent.html#kafka-integration).
- [Multitenant support in vmalert](https://docs.victoriametrics.com/vmalert.html#multitenancy).
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
- [Ability to read alerting and recording rules from Object Storage](https://docs.victoriametrics.com/vmalert.html#reading-rules-from-object-storage).
docs: document IP filters functionality in vmauth Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3491 This is a follow-up for https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/commit/2f08ed3be252354822b7d24cccbb03d76e429b62
2023-05-08 19:12:14 +00:00
- [Ability to filter incoming requests by IP at vmauth](https://docs.victoriametrics.com/vmauth.html#ip-filters).
app/vmalert: follow-up after d3c64aae8768d58781ee7e358bd7f3d8e0eb836d - Document the change at docs/CHANGELOG.md - Add `Reading rules from object storage` section to docs/vmalert.md - Add `s3` prefix to command-line flags related to the configuration of s3 and gcs clients - Explicitly mention that reading rules from object storage is supported only in enterprise version
2023-02-10 01:51:00 +00:00
- [Anomaly Detection Service](https://docs.victoriametrics.com/vmanomaly.html).
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
On top of this, Enterprise package of VictoriaMetrics includes the following important Enterprise features:
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
- First-class consulting and technical support provided by the core VictoriaMetrics dev team.
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
- [Monitoring of monitoring](https://victoriametrics.com/products/mom/) - this feature allows forecasting
and preventing possible issues in VictoriaMetrics setups.
- [Enterprise security compliance](https://victoriametrics.com/security/).
docs/enterprise.md: mention that feature requests from enterprise customers are prioritized
2022-11-01 08:27:35 +00:00
- Prioritizing of feature requests from Enterprise customers.
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 15:00:25 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Contact us via [this page](https://victoriametrics.com/products/enterprise/) if you are interested in VictoriaMetrics Enterprise.
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
## Running VictoriaMetrics Enterprise
VictoriaMetrics Enterprise components are available in the following forms:
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>
2023-10-05 09:05:57 +00:00
- [Binary releases](#binary-releases)
- [Docker images](#docker-images)
- [Helm charts](#helm-charts)
- [Kubernetes operator](#kubernetes-operator)
### Binary releases
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest releases at the top, such as LTS releases or VictoriaLogs releases. So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link, which always redirect to the latest available release of VictoriaMetrics.
2023-10-18 18:06:23 +00:00
Binary releases of VictoriaMetrics Enterprise are available [at the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest).
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
Enterprise binaries and packages have `enterprise` suffix in their names. For example, `victoria-metrics-linux-amd64-v1.95.1-enterprise.tar.gz`.
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
In order to run binary release of VictoriaMetrics Enterprise component, please download the `*-enterprise.tar.gz` archive for your OS and architecture
docs: use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest instead of https://github.com/VictoriaMetrics/VictoriaMetrics/releases link where needed The https://github.com/VictoriaMetrics/VictoriaMetrics/releases link may show non-latest releases at the top, such as LTS releases or VictoriaLogs releases. So it is better to use https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest link, which always redirect to the latest available release of VictoriaMetrics.
2023-10-18 18:06:23 +00:00
from the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and unpack it. Then run the unpacked binary.
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
All the VictoriaMetrics Enterprise components prior `v1.94.0` release require `-eula` command-line flag to be passed to them.
This flag acknowledges that your usage fits one of the cases listed [here](#valid-cases-for-victoriametrics-enterprise).
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
The `-eula` command-line flag is deprecated starting from `v1.94.0` release in favor of new command-line flags:
* `-license` - this flag accepts VictoriaMetrics Enterprise license key, which can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/)
* `-licenseFile` - this flag accepts a path to file with VictoriaMetrics Enterprise license key,
which can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/) . Use either `-license` or `-licenseFile`, but not both.
* `-license.forceOffline` - enables offline verification of VictoriaMetrics Enterprise license key. Contact us via [this page](https://victoriametrics.com/products/enterprise/)
if you need license key, which can be verified offline without the need to connect to VictoriaMetrics license server.
For example, the following command runs VictoriaMetrics Enterprise binary with the Enterprise license
obtained at [this page](https://victoriametrics.com/products/enterprise/trial/):
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>
2023-10-05 09:05:57 +00:00
```console
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
wget https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v1.95.1/victoria-metrics-linux-amd64-v1.95.1-enterprise.tar.gz
tar -xzf victoria-metrics-linux-amd64-v1.95.1-enterprise.tar.gz
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
./victoria-metrics-prod -license=BASE64_ENCODED_LICENSE_KEY
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>
2023-10-05 09:05:57 +00:00
```
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Alternatively, VictoriaMetrics Enterprise license can be stored in the file and then referred via `-licenseFile` command-line flag:
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>
2023-10-05 09:05:57 +00:00
```console
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
./victoria-metrics-prod -licenseFile=/path/to/vm-license
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>
2023-10-05 09:05:57 +00:00
```
### Docker images
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
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).
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
Enterprise docker images have `enterprise` suffix in their names. For example, `victoriametrics/victoria-metrics:v1.95.1-enteprise`.
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
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).
Enterprise license key can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/).
For example, the following command runs VictoriaMetrics Enterprise Docker image with the specified license key:
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>
2023-10-05 09:05:57 +00:00
```console
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
docker run --name=victoria-metrics victoriametrics/victoria-metrics:v1.95.1-enteprise -license=BASE64_ENCODED_LICENSE_KEY
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>
2023-10-05 09:05:57 +00:00
```
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Alternatively, the license code can be stored in the file and then referred via `-licenseFile` command-line flag:
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>
2023-10-05 09:05:57 +00:00
```console
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
docker run --name=victoria-metrics -v /vm-license:/vm-license victoriametrics/victoria-metrics:v1.95.1-enteprise -licenseFile=/path/to/vm-license
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>
2023-10-05 09:05:57 +00:00
```
Example docker-compose configuration:
```yaml
version: "3.5"
services:
victoriametrics:
container_name: victoriametrics
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
image: victoriametrics/victoria-metrics:v1.95.1
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>
2023-10-05 09:05:57 +00:00
ports:
- 8428:8428
volumes:
- vmdata:/storage
- /vm-license:/vm-license
command:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
- "-storageDataPath=/storage"
- "-licenseFile=/vm-license"
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>
2023-10-05 09:05:57 +00:00
volumes:
vmdata: {}
```
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
The example assumes that the license file is stored at `/vm-license` on the host.
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>
2023-10-05 09:05:57 +00:00
### Helm charts
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Helm charts for VictoriaMetrics Enterprise components are available [here](https://github.com/VictoriaMetrics/helm-charts).
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
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 as described [here](#docker-images).
Enterprise license key can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/).
For example, the following `values` file for [VictoriaMetrics single-node chart](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-single)
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>
2023-10-05 09:05:57 +00:00
is used to provide key in plain-text:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +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>
2023-10-05 09:05:57 +00:00
```yaml
server:
image:
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
tag: v1.95.1-enterprise
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>
2023-10-05 09:05:57 +00:00
license:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
key: {BASE64_ENCODED_LICENSE_KEY}
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>
2023-10-05 09:05:57 +00:00
```
In order to provide key via existing secret, the following values file is used:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +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>
2023-10-05 09:05:57 +00:00
```yaml
server:
image:
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
tag: v1.95.1-enterprise
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>
2023-10-05 09:05:57 +00:00
license:
secret:
name: vm-license
key: license
```
Example secret with license key:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +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>
2023-10-05 09:05:57 +00:00
```yaml
apiVersion: v1
kind: Secret
metadata:
name: vm-license
type: Opaque
data:
license: {BASE64_ENCODED_LICENSE_KEY}
```
Or create secret via `kubectl`:
```console
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
kubectl create secret generic vm-license --from-literal=license={BASE64_ENCODED_LICENSE_KEY}
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>
2023-10-05 09:05:57 +00:00
```
### Kubernetes operator
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
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.
Enterprise license key can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/).
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>
2023-10-05 09:05:57 +00:00
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:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +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>
2023-10-05 09:05:57 +00:00
```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: example-vmsingle
spec:
retentionPeriod: "1"
license:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
key: {BASE64_ENCODED_LICENSE_KEY}
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>
2023-10-05 09:05:57 +00:00
image:
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
tag: v1.95.1-enterprise
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>
2023-10-05 09:05:57 +00:00
```
In order to provide key via existing secret, the following custom resource is used:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +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>
2023-10-05 09:05:57 +00:00
```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: example-vmsingle
spec:
retentionPeriod: "1"
license:
keyRef:
name: vm-license
key: license
image:
docs/enterprise.md: update VictoriaMetrics version in examples from v1.95.0 to v1.95.1 See https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.95.1
2023-11-17 14:46:54 +00:00
tag: v1.95.1-enterprise
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>
2023-10-05 09:05:57 +00:00
```
Example secret with license key:
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
```yaml
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>
2023-10-05 09:05:57 +00:00
apiVersion: v1
kind: Secret
metadata:
name: vm-license
type: Opaque
data:
license: {BASE64_ENCODED_LICENSE_KEY}
```
Or create secret via `kubectl`:
```console
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
kubectl create secret generic vm-license --from-literal=license={BASE64_ENCODED_LICENSE_KEY}
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>
2023-10-05 09:05:57 +00:00
```
See full list of CRD specifications [here](https://docs.victoriametrics.com/operator/api.html).
## Monitoring license expiration
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
All the VictoriaMetrics Enterprise components expose the following metrics at the `/metrics` page:
* `vm_license_expires_at` - license expiration date in unix timestamp format
* `vm_license_expires_in_seconds` - the number of seconds left until the license expires
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>
2023-10-05 09:05:57 +00:00
lib/license: cleanups and prettifications for log messages and docs related to licensing - Make more clear the docs at docs/enterprise.md, so readers could figure out faster on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components. - Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag. The `-licenseFile` command-line flag must be used instead. - Improve the description of `-license*` command-line flags, so users could understand faster how to use them. - Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed, so the user could figure out how to switch faster to -license* command-line flags. - Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags. - Disallow running VictoriaMetrics components when -licensFile points to an empty file. - Consistently use the phrase "This flag is available only in Enterprise binaries" across all the enterprise-specific command-line flags. - Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants in order to improve code readability and maintainability. - Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return. - Make sure that the info log message about successful license verification is emitted when the license is verified successfully. Previously the error message could be logged when the license payload is invalid or if it misses some required features.
2023-10-13 11:07:16 +00:00
Example alerts for [vmalert](https://docs.victoriametrics.com/vmalert.html) based on these metrics:
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>
2023-10-05 09:05:57 +00:00
docs/enterprise: fix rendering of example alert (#5137) Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-10-09 14:57:25 +00:00
{% raw %}
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>
2023-10-05 09:05:57 +00:00
```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."
```
docs/enterprise: fix rendering of example alert (#5137) Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-10-09 14:57:25 +00:00
{% endraw %}
Reference in a new issue Copy permalink