vmauth is a simple auth proxy and router for VictoriaMetrics.
It reads username and password from Basic Auth headers,
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.
vmutils-* archive from releases page, unpack it
and pass the following flag to
vmauth binary in order to start authorizing and routing requests:
vmauth starts accepting HTTP requests on port
8427 and routing them according to the provided -auth.config.
The port can be modified via
-httpListenAddr command-line flag.
The auth config can be reloaded by passing
SIGHUP signal to
Docker images for
vmauth are available here.
vmauth in order to see all the supported command-line flags with their descriptions.
Feel free contacting us if you need customized auth proxy for VictoriaMetrics with the support of LDAP, SSO, RBAC, SAML, accounting, limits, etc.
Auth config is represented in the following simple
# Arbitrary number of usernames may be put here. # Usernames must be unique. users: # 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://vminsert:8480/insert/42/prometheus"
Do not transfer Basic Auth headers in plaintext over untrusted networks. Enable https. This can be done by passing the following
-tls* command-line flags to
-tls Whether to enable TLS (aka HTTPS) for incoming requests. -tlsCertFile and -tlsKeyFile must be set if -tls is set -tlsCertFile string Path to file with TLS certificate. Used only if -tls is set. Prefer ECDSA certs instead of RSA certs, since RSA certs are slow -tlsKeyFile string Path to file with TLS key. Used only if -tls is set
Alternatively, https termination proxy may be put in front of
vmauth exports various metrics in Prometheus exposition format at
http://vmauth-host:8427/metrics page. It is recommended setting up regular scraping of this page
either via vmagent or via Prometheus, so the exported metrics could be analyzed later.
How to build from sources
It is recommended using binary releases -
vmauth is located in
vmutils-* archives there.
- Install Go. The minimum supported version is Go 1.13.
make vmauthfrom the root folder of the repository. It builds
vmauthbinary and puts it into the
- Install docker.
make vmauth-prodfrom the root folder of the repository. It builds
vmauth-prodbinary and puts it into the
Building docker images
make package-vmauth. It builds
victoriametrics/vmauth:<PKG_TAG> docker image locally.
<PKG_TAG> is auto-generated image tag, which depends on source code in the repository.
<PKG_TAG> may be manually set via
PKG_TAG=foobar make package-vmauth.
By default the image is built on top of alpine image. It is possible to build the package on top of any other base image
by setting it via
<ROOT_IMAGE> environment variable. For example, the following command builds the image on top of scratch image:
ROOT_IMAGE=scratch make package-vmauth
vmauth provides handlers for collecting the following Go profiles:
- Memory profile. It can be collected with the following command:
curl -s http://<vmauth-host>:8427/debug/pprof/heap > mem.pprof
- CPU profile. It can be collected with the following command:
curl -s http://<vmauth-host>:8427/debug/pprof/profile > cpu.pprof
The command for collecting CPU profile waits for 30 seconds before returning.
The collected profiles may be analyzed with go tool pprof.