mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-15 16:30:55 +01:00
docs/Cluster-VictoriaMetrics.md: update docs about env vars usage in command-line flags
This is a follow-up for 02096e06d0
This commit is contained in:
parent
36b92f07f7
commit
c92d1fdf8e
@ -180,7 +180,12 @@ It is possible manualy setting up a toy cluster on a single host. In this case e
|
|||||||
|
|
||||||
### Environment variables
|
### Environment variables
|
||||||
|
|
||||||
Each flag values can be set through environment variables by following these rules:
|
All the VictoriaMetrics components allow referring environment variables in command-line flags via `${ENV_VAR}` syntax.
|
||||||
|
For example, `-metricsAuthKey=%{METRICS_AUTH_KEY}` is automatically expanded to `-metricsAuthKey=top-secret`
|
||||||
|
if `METRICS_AUTH_KEY=top-secret` environment variable exists at VictoriaMetrics startup.
|
||||||
|
This expansion doesn't need any special shell - it is performed by VictoriaMetrics itself.
|
||||||
|
|
||||||
|
Additionally, all the VictoriaMetrics components allow setting flag values via environment variables according to these rules:
|
||||||
|
|
||||||
- The `-envflag.enable` flag must be set
|
- The `-envflag.enable` flag must be set
|
||||||
- Each `.` in flag names must be substituted by `_` (for example `-insert.maxQueueDuration <duration>` will translate to `insert_maxQueueDuration=<duration>`)
|
- Each `.` in flag names must be substituted by `_` (for example `-insert.maxQueueDuration <duration>` will translate to `insert_maxQueueDuration=<duration>`)
|
||||||
|
@ -184,7 +184,12 @@ It is possible manualy setting up a toy cluster on a single host. In this case e
|
|||||||
|
|
||||||
### Environment variables
|
### Environment variables
|
||||||
|
|
||||||
Each flag values can be set through environment variables by following these rules:
|
All the VictoriaMetrics components allow referring environment variables in command-line flags via `${ENV_VAR}` syntax.
|
||||||
|
For example, `-metricsAuthKey=%{METRICS_AUTH_KEY}` is automatically expanded to `-metricsAuthKey=top-secret`
|
||||||
|
if `METRICS_AUTH_KEY=top-secret` environment variable exists at VictoriaMetrics startup.
|
||||||
|
This expansion doesn't need any special shell - it is performed by VictoriaMetrics itself.
|
||||||
|
|
||||||
|
Additionally, all the VictoriaMetrics components allow setting flag values via environment variables according to these rules:
|
||||||
|
|
||||||
- The `-envflag.enable` flag must be set
|
- The `-envflag.enable` flag must be set
|
||||||
- Each `.` in flag names must be substituted by `_` (for example `-insert.maxQueueDuration <duration>` will translate to `insert_maxQueueDuration=<duration>`)
|
- Each `.` in flag names must be substituted by `_` (for example `-insert.maxQueueDuration <duration>` will translate to `insert_maxQueueDuration=<duration>`)
|
||||||
|
Loading…
Reference in New Issue
Block a user