From 6afb25fd082f86f8ed6f2509c81f3e6ec1880987 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Thu, 7 May 2020 12:54:48 +0300 Subject: [PATCH] docs/{vmagent,vmauth}: small clarifications in the docs --- app/vmagent/README.md | 2 +- app/vmauth/README.md | 19 +++++++++++++++---- docs/vmagent.md | 2 +- docs/vmauth.md | 19 +++++++++++++++---- 4 files changed, 32 insertions(+), 10 deletions(-) diff --git a/app/vmagent/README.md b/app/vmagent/README.md index e2f39fdc4..26dd05f56 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -57,7 +57,7 @@ If you need collecting only Influx data, then the following command line would b Then send Influx data to `http://vmagent-host:8429`. See [these docs](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) for more details. -`vmagent` is also available in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/). +`vmagent` is also available in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags). Pass `-help` to `vmagent` in order to see the full list of supported command-line flags with their descriptions. diff --git a/app/vmauth/README.md b/app/vmauth/README.md index 3af9c72f1..5e6cd8c53 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -1,8 +1,8 @@ ## vmauth `vmauth` is a simple auth proxy and router for [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics). -It reads username and password from [Basic Auth headers](https://en.wikipedia.org/wiki/Basic_access_authentication) -and matches them against configs pointed by `-auth.config` command-line flag and proxies incoming HTTP requests to the configured per-user `url_prefix` on successful match. +It reads username and password from [Basic Auth headers](https://en.wikipedia.org/wiki/Basic_access_authentication), +matches them against configs pointed by `-auth.config` command-line flag and proxies incoming HTTP requests to the configured per-user `url_prefix` on successful match. ### Quick start @@ -19,6 +19,8 @@ The port can be modified via `-httpListenAddr` command-line flag. The auth config can be reloaded by passing `SIGHUP` signal to `vmauth`. +Docker images for `vmauth` are available at [https://hub.docker.com/r/victoriametrics/vmauth/tags]. + Pass `-help` to `vmauth` in order to see all the supported command-line flags with their descriptions. Feel free [contacting us](mailto:info@victoriametrics.com) if you need customized auth proxy for VictoriaMetrics with the support of LDAP, SSO, RBAC, accounting, limits, etc. @@ -35,22 +37,31 @@ Auth config is represented in the following simple `yml` format: users: - # The user for querying local single-node VictoriaMetrics + # The user for querying local single-node VictoriaMetrics. + # All the requests to http://vmauth:8427 with the given Basic Auth (username:password) + # will be routed to http://localhost:8428 . + # For example, http://vmauth:8427/api/v1/query is routed to http://localhost:8428/api/v1/query - username: "local-single-node" password: "***" url_prefix: "http://localhost:8428" # The user for querying account 123 in VictoriaMetrics cluster # See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/cluster/README.md#url-format + # All the requests to http://vmauth:8427 with the given Basic Auth (username:password) + # will be routed to http://vmselect:8481/select/123/prometheus . + # For example, http://vmauth:8427/api/v1/query is routed to http://vmselect:8481/select/123/prometheus/api/v1/select - username: "cluster-select-account-123" password: "***" url_prefix: "http://vmselect:8481/select/123/prometheus" # The user for inserting Prometheus data into VictoriaMetrics cluster under account 42 # See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/cluster/README.md#url-format + # All the reuqests to http://vmauth:8427 with the given Basic Auth (username:password) + # will be routed to http://vminsert:8480/insert/42/prometheus . + # For example, http://vmauth:8427/api/v1/write is routed to http://vminsert:8480/insert/42/prometheus/api/v1/write - username: "cluster-insert-account-42" password: "***" - url_prefix: "http://localhost:8480/insert/42/prometheus" + url_prefix: "http://vminsert:8480/insert/42/prometheus" ``` diff --git a/docs/vmagent.md b/docs/vmagent.md index e2f39fdc4..26dd05f56 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -57,7 +57,7 @@ If you need collecting only Influx data, then the following command line would b Then send Influx data to `http://vmagent-host:8429`. See [these docs](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) for more details. -`vmagent` is also available in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/). +`vmagent` is also available in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags). Pass `-help` to `vmagent` in order to see the full list of supported command-line flags with their descriptions. diff --git a/docs/vmauth.md b/docs/vmauth.md index 3af9c72f1..5e6cd8c53 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -1,8 +1,8 @@ ## vmauth `vmauth` is a simple auth proxy and router for [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics). -It reads username and password from [Basic Auth headers](https://en.wikipedia.org/wiki/Basic_access_authentication) -and matches them against configs pointed by `-auth.config` command-line flag and proxies incoming HTTP requests to the configured per-user `url_prefix` on successful match. +It reads username and password from [Basic Auth headers](https://en.wikipedia.org/wiki/Basic_access_authentication), +matches them against configs pointed by `-auth.config` command-line flag and proxies incoming HTTP requests to the configured per-user `url_prefix` on successful match. ### Quick start @@ -19,6 +19,8 @@ The port can be modified via `-httpListenAddr` command-line flag. The auth config can be reloaded by passing `SIGHUP` signal to `vmauth`. +Docker images for `vmauth` are available at [https://hub.docker.com/r/victoriametrics/vmauth/tags]. + Pass `-help` to `vmauth` in order to see all the supported command-line flags with their descriptions. Feel free [contacting us](mailto:info@victoriametrics.com) if you need customized auth proxy for VictoriaMetrics with the support of LDAP, SSO, RBAC, accounting, limits, etc. @@ -35,22 +37,31 @@ Auth config is represented in the following simple `yml` format: users: - # The user for querying local single-node VictoriaMetrics + # The user for querying local single-node VictoriaMetrics. + # All the requests to http://vmauth:8427 with the given Basic Auth (username:password) + # will be routed to http://localhost:8428 . + # For example, http://vmauth:8427/api/v1/query is routed to http://localhost:8428/api/v1/query - username: "local-single-node" password: "***" url_prefix: "http://localhost:8428" # The user for querying account 123 in VictoriaMetrics cluster # See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/cluster/README.md#url-format + # All the requests to http://vmauth:8427 with the given Basic Auth (username:password) + # will be routed to http://vmselect:8481/select/123/prometheus . + # For example, http://vmauth:8427/api/v1/query is routed to http://vmselect:8481/select/123/prometheus/api/v1/select - username: "cluster-select-account-123" password: "***" url_prefix: "http://vmselect:8481/select/123/prometheus" # The user for inserting Prometheus data into VictoriaMetrics cluster under account 42 # See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/cluster/README.md#url-format + # All the reuqests to http://vmauth:8427 with the given Basic Auth (username:password) + # will be routed to http://vminsert:8480/insert/42/prometheus . + # For example, http://vmauth:8427/api/v1/write is routed to http://vminsert:8480/insert/42/prometheus/api/v1/write - username: "cluster-insert-account-42" password: "***" - url_prefix: "http://localhost:8480/insert/42/prometheus" + url_prefix: "http://vminsert:8480/insert/42/prometheus" ```