victoriametrics.com

Type: application Version: 0.6.1 Artifact Hub Slack

Victoria Metrics Gateway - Auth & Rate-Limitting proxy for Victoria Metrics

Table of Content

Prerequisites #

  • Install the follow packages: git, kubectl, helm, helm-docs. See this tutorial.
  • PV support on underlying infrastructure

Chart Details #

This chart will do the following:

  • Rollout victoria metrics gateway

How to install #

Access a Kubernetes cluster.

Setup chart repository (can be omitted for OCI repositories) #

Add a chart helm repository with follow commands:

helm repo add vm https://victoriametrics.github.io/helm-charts/

helm repo update

List versions of vm/victoria-metrics-gateway chart available to installation:

helm search repo vm/victoria-metrics-gateway -l

Install victoria-metrics-gateway chart #

Export default values of victoria-metrics-gateway chart to file values.yaml:

  • For HTTPS repository

    helm show values vm/victoria-metrics-gateway > values.yaml

  • For OCI repository

    helm show values oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-gateway > values.yaml

Change the values according to the need of the environment in values.yaml file.

Test the installation with command:

  • For HTTPS repository

    helm install vmg vm/victoria-metrics-gateway -f values.yaml -n NAMESPACE --debug --dry-run

  • For OCI repository

    helm install vmg oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-gateway -f values.yaml -n NAMESPACE --debug --dry-run

Install chart with command:

  • For HTTPS repository

    helm install vmg vm/victoria-metrics-gateway -f values.yaml -n NAMESPACE

  • For OCI repository

    helm install vmg oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-gateway -f values.yaml -n NAMESPACE

Get the pods lists by running this commands:

kubectl get pods -A | grep 'vmg'

Get the application by running this command:

helm list -f vmg -n NAMESPACE

See the history of versions of vmg application with command.

helm history vmg -n NAMESPACE

How to use JWT signature verification

Kubernetes best-practice is to store sensitive configuration parts in secrets. For example, 2 keys will be stored as:

apiVersion: v1
data:
  key: "<<KEY_DATA>>"
kind: Secret
metadata:
  name: key1
---
apiVersion: v1
data:
  key: "<<KEY_DATA>>"
kind: Secret
metadata:
  name: key2

In order to use those secrets it is needed to:

  • mount secrets into pod
  • provide flag pointing to secret on disk

Here is an example values.yml file configuration to achieve this:

auth:
  enable: true

extraVolumes:
  - name: key1
    secret:
      secretName: key1
  - name: key2
    secret:
      secretName: key2

extraVolumeMounts:
  - name: key1
    mountPath: /key1
  - name: key2
    mountPath: /key2

extraArgs:
  envflag.enable: "true"
  envflag.prefix: VM_
  loggerFormat: json
  auth.publicKeyFiles: "/key1/key,/key2/key"

Note that in this configuration all secret keys will be mounted and accessible to pod. Please, refer to this doc to see all available secret source options.

How to uninstall #

Remove application with command.

helm uninstall vmg -n NAMESPACE

Documentation of Helm Chart #

Install helm-docs following the instructions on this tutorial.

Generate docs with helm-docs command.

cd charts/victoria-metrics-gateway

helm-docs

The markdown generation is entirely go template driven. The tool parses metadata from charts and generates a number of sub-templates that can be referenced in a template file (by default README.md.gotmpl). If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.

Parameters #

The following tables lists the configurable parameters of the chart and their default values.

Change the values according to the need of the environment in victoria-metrics-gateway/values.yaml file.

KeyTypeDefaultDescription
affinityobject
{}

Affinity configurations

annotationsobject
{}

Annotations to be added to the deployment

authobject
enabled: false

Access Control configuration. Check here for details

auth.enabledbool
false

Enable/Disable access-control

clusterModebool
false

Specify to True if the source for rate-limiting, reading and writing as a VictoriaMetrics Cluster. Must be true for rate limiting

configMapstring
""

Use existing configmap if specified otherwise .config values will be used. Check here for details

containerWorkingDirstring
/

Container working directory

envlist
[]

Additional environment variables (ex.: secret tokens, flags). Check here for details.

envFromlist
[]

Specify alternative source for env variables

extraArgsobject
envflag.enable: true
envflag.prefix: VM_
httpListenAddr: :8431
loggerFormat: json

Extra command line arguments for container of component

extraContainerslist
[]

Extra containers to run in a pod with vmgateway

extraHostPathMountslist
[]

Additional hostPath mounts

extraLabelsobject
{}

Labels to be added to Deployment

extraVolumeMountslist
[]

Extra Volume Mounts for the container

extraVolumeslist
[]

Extra Volumes for the pod

fullnameOverridestring
""

Override resources fullname

global.cluster.dnsDomainstring
cluster.local.

K8s cluster domain suffix, uses for building storage pods’ FQDN. Details are here

global.compatibilityobject
openshift:
    adaptSecurityContext: auto

Openshift security context compatibility configuration

global.image.registrystring
""

Image registry, that can be shared across multiple helm charts

global.imagePullSecretslist
[]

Image pull secrets, that can be shared across multiple helm charts

image.pullPolicystring
IfNotPresent

Pull policy of Docker image

image.registrystring
""

Victoria Metrics gateway Docker registry

image.repositorystring
victoriametrics/vmgateway

Victoria Metrics gateway Docker repository and image name

image.tagstring
""

Tag of Docker image override Chart.AppVersion

image.variantstring
""

Variant of the image to use. e.g. enterprise, enterprise-scratch

imagePullSecretslist
[]

Image pull secrets

ingress.annotationsobject
{}

Ingress annotations

ingress.enabledbool
false

Enable deployment of ingress for server component

ingress.extraLabelsobject
{}

Ingress extra labels

ingress.hostslist
- name: vmgateway.local
  path:
    - /
  port: http

Array of host objects

ingress.ingressClassNamestring
""

Ingress controller class name

ingress.pathTypestring
Prefix

Ingress path type

ingress.tlslist
[]

Array of TLS objects

initContainerslist
[]

Init containers for vmgateway

licenseobject
key: ""
secret:
    key: ""
    name: ""

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Check docs here, for more information, visit site. Request a trial license here Supported starting from VictoriaMetrics v1.94.0

license.keystring
""

License key

license.secretobject
key: ""
name: ""

Use existing secret with license key

license.secret.keystring
""

Key in secret with license key

license.secret.namestring
""

Existing secret name

nameOverridestring
""

Override chart name

nodeSelectorobject
{}

NodeSelector configurations. Check here for details

podAnnotationsobject
{}

Annotations to be added to pod

podDisruptionBudgetobject
enabled: false
labels: {}

See kubectl explain poddisruptionbudget.spec for more. Check here for details

podLabelsobject
{}

Labels to be added to pod

podSecurityContextobject
enabled: true

Pod’s security context. Details are here

probe.livenessobject
initialDelaySeconds: 5
periodSeconds: 15
tcpSocket: {}
timeoutSeconds: 5

Liveness probe

probe.readinessobject
httpGet: {}
initialDelaySeconds: 5
periodSeconds: 15

Readiness probe

probe.startupobject
{}

Startup probe

rateLimiterobject
config: {}
datasource:
    url: ""
enabled: false

Rate limiter configuration. Docs are here

rateLimiter.datasource.urlstring
""

Datasource VictoriaMetrics or vmselects. Required. Example http://victoroametrics:8428 or http://vmselect:8481/select/0/prometheus

rateLimiter.enabledbool
false

Enable/Disable rate-limiting

read.urlstring
""

Read endpoint without suffixes, victoriametrics or vmselect. Example http://victoroametrics:8428 or http://vmselect:8481

replicaCountint
1

Number of replicas of vmgateway

resourcesobject
{}

We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after ‘resources:’.

securityContextobject
enabled: true
runAsGroup: 1000
runAsNonRoot: true
runAsUser: 1000

Pod security context. Check here for details

service.annotationsobject
{}

Service annotations

service.clusterIPstring
""

Service ClusterIP

service.enabledbool
true

Enabled vmgateway service

service.externalIPslist
[]

Service external IPs. Check here for details

service.externalTrafficPolicystring
""

Service external traffic policy. Check here for details

service.extraLabelsobject
{}

Service labels

service.healthCheckNodePortstring
""

Health check node port for a service. Check here for details

service.ipFamilieslist
[]

List of service IP families. Check here for details.

service.ipFamilyPolicystring
""

Service IP family policy. Check here for details.

service.loadBalancerIPstring
""

Service load balancer IP

service.loadBalancerSourceRangeslist
[]

Load balancer source range

service.servicePortint
8431

Service port

service.typestring
ClusterIP

Service type

serviceAccount.annotationsobject
{}

Annotations to add to the service account

serviceAccount.createbool
true

Specifies whether a service account should be created

serviceAccount.namestring
null

The name of the service account to use. If not set and create is true, a name is generated using the fullname template

serviceMonitor.annotationsobject
{}

Service Monitor annotations

serviceMonitor.basicAuthobject
{}

Basic auth params for Service Monitor

serviceMonitor.enabledbool
false

Enable deployment of Service Monitor for server component. This is Prometheus operator object

serviceMonitor.extraLabelsobject
{}

Service Monitor labels

serviceMonitor.metricRelabelingslist
[]

Service Monitor metricRelabelings

serviceMonitor.relabelingslist
[]

Service Monitor relabelings

tolerationslist
[]

Tolerations configurations. Check here for details

write.urlstring
""

Write endpoint without suffixes, victoriametrics or vminsert. Example http://victoroametrics:8428 or http://vminsert:8480

Content

Back to Page