| weight | 3 | ||||||
|---|---|---|---|---|---|---|---|
| title | Security | ||||||
| menu |
|
||||||
| aliases |
|
||||||
| tags |
|
To run in a cluster the operator needs certain permissions, you can see them in this directory:
role.yamlfile - basic set of cluster roles for launching an operator.leader_election_role.yamlfile - set of roles with permissions to do leader election (is necessary to run the operator in several replicas for high availability).
Also, you can use single-namespace mode with minimal permissions, see this section for details.
VMAgent uses Kubernetes service discovery for scrape targets, so its ServiceAccount needs read-only access to Kubernetes discovery objects.
The example vmagent_rbac.yaml file creates a ClusterRole with these permissions:
get,list, andwatchfornodes,nodes/metrics,services,endpoints,endpointslices,pods, andingressesin core,networking.k8s.io,extensions, anddiscovery.k8s.ioAPI groups. These permissions allow vmagent to discover scrape targets across the cluster.getfornamespacesandconfigmaps. These permissions allow namespace metadata lookups and config map reads needed by discovery configuration.getfor non-resource URLs/metrics,/metrics/resources, and/metrics/slis. These permissions allow scraping Kubernetes API server metrics endpoints when configured.getfor OpenShift'srouters/metricsandregistry/metricsresources inroute.openshift.ioandimage.openshift.ioAPI groups. These permissions allow scraping OpenShift router and registry metrics when configured.
VMSingle can use the same Kubernetes service discovery as VMAgent when it scrapes targets directly.
When spec.ingestOnlyMode is disabled, operator creates the same cluster-wide discovery ClusterRole and ClusterRoleBinding for VMSingle.
When spec.ingestOnlyMode is enabled, VMSingle doesn't need service discovery permissions and operator doesn't add these cluster-wide rules.
VLAgent can collect Kubernetes logs by watching pods, nodes, and namespaces.
When cluster-wide access is allowed, operator creates a ClusterRole with get, list, and watch permissions for nodes, pods, and namespaces in the core API group.
When the operator runs in namespaced mode, operator skips the VLAgent ClusterRole and ClusterRoleBinding; configure namespaced RBAC manually if VLAgent still needs Kubernetes API access.
VMAuth and VMAlertmanager don't need cluster-wide RBAC for their own runtime configuration reload.
Operator creates namespaced Role and RoleBinding objects with get, list, and watch permissions for secrets in their own namespace, so the config-reloader can watch generated configuration secrets.
For example, this VMSingle needs scrape discovery RBAC because it scrapes targets directly:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: scrape
namespace: monitoring
spec:
ingestOnlyMode: false
selectAllByDefault: trueThis VMSingle doesn't need scrape discovery RBAC, because it only receives ingested data:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: ingest
namespace: monitoring
spec:
ingestOnlyMode: trueThis VLAgent needs Kubernetes API access for pod metadata and log target discovery:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VLAgent
metadata:
name: logs
namespace: monitoring
spec:
remoteWrite:
- url: http://vlinsert-vlogs.monitoring.svc:9428/insert/jsonlineWith cluster-wide operator access, it gets a ClusterRole similar to:
rules:
- apiGroups: [""]
resources: ["nodes", "pods", "namespaces"]
verbs: ["get", "list", "watch"]VMAuth and VMAlertmanager get namespace-scoped secret access similar to:
rules:
- apiGroups: [""]
resources: ["secrets"]
verbs: ["get", "list", "watch"]Cluster-wide discovery roles are created because Kubernetes service discovery can discover targets in multiple namespaces and cluster-scoped resources such as nodes.
To reduce API access scope, run the operator in namespaced mode with the WATCH_NAMESPACE environment variable.
When WATCH_NAMESPACE is set, operator avoids cluster-wide watches and limits object selection to the configured namespace list.
For VMAgent and VMSingle, operator creates namespaced Role and RoleBinding objects in watched namespaces so service discovery can work there without granting a cluster-wide ClusterRole for namespaced resources.
Their config and credential secrets access stays namespace-scoped even in cluster-wide mode.
Cluster-scoped discovery, such as nodes and nodes/metrics, still requires cluster-level permissions if enabled in scrape configuration.
For example, this operator watches only two namespaces:
env:
- name: WATCH_NAMESPACE
value: team-a,team-bIn this mode, operator creates namespaced discovery Role and RoleBinding objects for VMAgent and VMSingle in team-a and team-b instead of cluster-wide discovery RBAC for namespaced resources.
enforcedNamespaceLabel allows enforcing the namespace of the user-created operator object on metrics, alerting rules, and alert routing configuration.
It is useful for building isolated environments where users manage monitoring objects in their own namespaces, while platform administrators run shared monitoring infrastructure. When the team creates VMServiceScrape, VMRule, or VMAlertmanagerConfig in namespace team-a, operator automatically adds or matches tenant="team-a" label, so metrics, rules, and alerts stay logically (not physically) isolated from other teams.
The field can be configured on these objects:
VMAgentandVMSingleenforce the namespace label for metrics collected fromVMServiceScrape,VMPodScrape,VMNodeScrape,VMStaticScrape,VMProbe, andVMScrapeConfigobjects.VMAlertenforces the namespace label for rules loaded fromVMRuleobjects.VMAlertmanageruses the configured label name as the top-level route matcher forVMAlertmanagerConfigobjects. If the field is not configured, the route matcher uses thenamespacelabel.
For scrape objects, the operator appends the enforced namespace relabeling as the final relabel_configs rule.
This prevents users from overriding the enforced label with custom target relabeling.
The operator also ignores metric_relabel_configs rules that try to write into the enforced label.
For example, this VMAgent selects user scrape objects from all namespaces but always writes the source CRD namespace into the tenant label:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAgent
metadata:
name: shared
namespace: monitoring-system
spec:
enforcedNamespaceLabel: tenant
selectAllByDefault: true
remoteWrite:
- url: http://vminsert-vmcluster.monitoring-system.svc:8480/insert/0/prometheus/api/v1/writeIf user team-a creates a VMServiceScrape in namespace team-a, all metrics collected through this object get tenant="team-a".
If user team-b creates scrape objects in namespace team-b, their metrics get tenant="team-b".
Users cannot change this label through scrape relabeling or metric relabeling in their scrape objects.
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMServiceScrape
metadata:
name: app
namespace: team-a
spec:
selector:
matchLabels:
app: app
endpoints:
- port: httpVMAlert can use the same enforced label for rules:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAlert
metadata:
name: shared
namespace: monitoring-system
spec:
enforcedNamespaceLabel: tenant
selectAllByDefault: true
datasource:
url: http://vmselect-vmcluster.monitoring-system.svc:8481/select/0/prometheus
notifier:
url: http://vmalertmanager-shared.monitoring-system.svc:9093If user team-a creates a VMRule in namespace team-a, operator adds tenant="team-a" to every generated alerting and recording rule from this object.
VMAlertmanager can use the same label to isolate alert routing configuration:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAlertmanager
metadata:
name: shared
namespace: monitoring-system
spec:
enforcedNamespaceLabel: tenant
selectAllByDefault: trueWith this configuration, a VMAlertmanagerConfig from namespace team-a is converted into Alertmanager routes that match only alerts with tenant="team-a".
Routes from namespace team-b match only tenant="team-b" alerts.
This allows teams to manage their own receivers and routes without receiving alerts from other namespaces.
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAlertmanagerConfig
metadata:
name: team-routing
namespace: team-a
spec:
route:
receiver: team-a
receivers:
- name: team-a
slackConfigs:
- apiURL:
key: url
name: team-a-slack
channel: '#team-a-alerts'Use this pattern to build a managed monitoring service:
- Platform administrators deploy shared
VMAgent,VMAlert,VMAlertmanager, and VictoriaMetrics storage in an infrastructure namespace. - Administrators set the same
enforcedNamespaceLabelvalue, such astenant, on shared collection, rule evaluation, and alert routing objects. - Users receive Kubernetes RBAC permissions to create only namespaced CRDs, such as
VMServiceScrape,VMPodScrape,VMRule, andVMAlertmanagerConfig, in their own namespaces. - Shared components select user objects with
selectAllByDefaultor explicit namespace and label selectors. - Dashboards, alerts, and optional query gateways filter by the enforced label, for example
tenant="team-a".
This pattern gives every namespace isolated monitoring configuration while reusing one operator-managed backend.
Note that the separation is logical, not physical - so it additionally needs to be enforced by RBAC and query authentication via vmauth or another query gateway.
enforcedNamespaceLabel can be combined with ignoreNamespaceSelectors: true on VMAgent or VMSingle to restrict scrape objects from discovering targets in other namespaces. In this mode, scrape objects can discover endpoints only within their own namespace.
VictoriaMetrics operator provides several security features. First of all, it's built-in hardening configuration.
Environment variable VM_ENABLESTRICTSECURITY=true applies generic security options to the all created resources.
Such as PodSecurityContext and SecurityContext per Container
securityContext:
// '65534' refers to 'nobody' in all the used default images like alpine, busybox.
fsGroup: 65534
fsGroupChangePolicy: OnRootMismatch
runAsGroup: 65534
runAsNonRoot: true
runAsUser: 65534
seccompProfile:
type: RuntimeDefaultIt's also possible to config strict security on resource basis:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: strict-security
namespace: monitoring-system
spec:
retentionPeriod: "2"
removePvcAfterDelete: true
useStrictSecurity: true
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 25GiIn addition, operator supports more granular per resource security configuration with spec.securityContext and ContainerSecurityContext
-
RunAsNonRoot: true
-
RunAsUser/RunAsGroup/FSGroup: 65534
'65534' refers to 'nobody' in all the used default images like alpine, busybox.
If you're using customize image, please make sure '65534' is a valid uid in there or specify SecurityContext.
-
FSGroupChangePolicy: &onRootMismatch
If KubeVersion>=1.20, use
FSGroupChangePolicy="onRootMismatch"to skip the recursive permission change when the root of the volume already has the correct permissions -
SeccompProfile: {type: RuntimeDefault}
Use
RuntimeDefaultseccomp profile by default, which is defined by the container runtime, instead of using the Unconfined (seccomp disabled) mode.
- AllowPrivilegeEscalation: false
- ReadOnlyRootFilesystem: true
- Capabilities: {drop: [all]}
Also SecurityContext can be configured with spec setting. It may be useful for mounted volumes, with VMSingle for example:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: vmsingle-f
namespace: monitoring-system
spec:
retentionPeriod: "2"
removePvcAfterDelete: true
securityContext:
runAsUser: 1000
fsGroup: 1000
runAsGroup: 1000
extraArgs:
dedup.minScrapeInterval: 10s
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 25Gi
resources:
requests:
cpu: "0.5"
memory: "512Mi"
limits:
cpu: "1"
memory: "1512Mi"By default, operator configures Kubernetes API Access for all managed components with own ServiceAccount.
This behaviour can be altered with object configuration - spec.disableAutomountServiceAccountToken: true {{% available_from "v0.54.0" "operator" %}}. See the
following Kubernetes doc for details.
Consider the following example for VMAgent:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAgent
metadata:
name: example
namespace: default
spec:
remoteWrite:
- url: http://vmsingle-vms-victoria-metrics-k8s-stack.default.svc:8428/api/v1/write
replicaCount: 1
selectAllByDefault: true
statefulMode: trueKubernetes controller-manager creates the following Pod definition and attaches volumes and volumeMounts with serviceAccount token:
apiVersion: v1
kind: Pod
metadata:
name: vmagent-example-0
namespace: default
spec:
containers:
- args:
...
name: config-reloader
volumeMounts:
...
- mountPath: /var/run/secrets/kubernetes.io/serviceaccount
name: kube-api-access-q44gh
readOnly: true
- args:
...
name: vmagent
volumeMounts:
...
- mountPath: /var/run/secrets/kubernetes.io/serviceaccount
name: kube-api-access-q44gh
readOnly: true
dnsPolicy: ClusterFirst
enableServiceLinks: true
hostname: vmagent-example-0
initContainers:
- args:
...
name: config-init
volumeMounts:
...
- mountPath: /var/run/secrets/kubernetes.io/serviceaccount
name: kube-api-access-q44gh
readOnly: true
serviceAccount: vmagent-example
serviceAccountName: vmagent-example
volumes:
...
- emptyDir: {}
name: persistent-queue-data
- name: kube-api-access-q44gh
projected:
defaultMode: 420
sources:
- serviceAccountToken:
expirationSeconds: 3607
path: token
- configMap:
items:
- key: ca.crt
path: ca.crt
name: kube-root-ca.crt
- downwardAPI:
items:
- fieldRef:
apiVersion: v1
fieldPath: metadata.namespace
path: namespaceIf disableAutomountServiceAccountToken: true is set. Operator adds volumes and volumeMounts only if application explicitly requires access to Kubernetes API:
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAgent
metadata:
name: example
namespace: default
spec:
disableAutomountServiceAccountToken: true
remoteWrite:
- url: http://vmsingle-vms-victoria-metrics-k8s-stack.default.svc:8428/api/v1/write
replicaCount: 1
selectAllByDefault: true
statefulMode: trueAnd Pod definition no longer has volumeMounts with serviceAccountToken for config-reloader container:
apiVersion: v1
kind: Pod
metadata:
name: vmagent-example-0
namespace: default
spec:
automountServiceAccountToken: false
containers:
- args:
name: config-reloader
volumeMounts:
- mountPath: /etc/vmagent/config_out
name: config-out
- mountPath: /etc/vmagent/config
name: config
- args:
name: vmagent
terminationMessagePath: /dev/termination-log
terminationMessagePolicy: FallbackToLogsOnError
volumeMounts:
- mountPath: /vmagent_pq/vmagent-remotewrite-data
name: persistent-queue-data
...
- mountPath: /var/run/secrets/kubernetes.io/serviceaccount
name: kube-api-access
readOnly: true
dnsPolicy: ClusterFirst
enableServiceLinks: true
hostname: vmagent-example-0
initContainers:
- args:
name: config-init
volumeMounts:
- mountPath: /etc/vmagent/config
name: config
- mountPath: /etc/vmagent/config_out
name: config-out
serviceAccount: vmagent-example
serviceAccountName: vmagent-example
volumes:
...
- name: kube-api-access
projected:
defaultMode: 420
sources:
- serviceAccountToken:
expirationSeconds: 3600
path: token
- configMap:
name: kube-root-ca.crt
- downwardAPI:
items:
- fieldRef:
apiVersion: v1
fieldPath: metadata.namespace
path: namespace
- emptyDir: {}
name: persistent-queue-dataThe following containers needs access to Kubernetes API server:
- vmagent uses Kubernetes service-discovery for scrapping target metrics.
- config-reloader watches configuration secret and triggers application state config reload on change.
It's also possible to mount serviceAccountToken manually to any component.
Consider the following example:
# add Role and Rolebinding for `vmsingle-with-sidecar` ServiceAccount
# or provide specific serviceAccount via: `spec.serviceAccountName`
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMSingle
metadata:
name: with-sidecar
namespace: default
spec:
retentionPeriod: 1
disableAutomountServiceAccountToken: true
containers:
- name: side-car-with-api-access
image: busybox
command: ["/bin/sh"]
args: ["-c", "tail -f /dev/stdout"]
volumeMounts:
- name: kube-api-access
mountPath: /var/run/secrets/kubernetes.io/serviceaccount
volumes:
- name: kube-api-access
projected:
defaultMode: 420
sources:
- serviceAccountToken:
expirationSeconds: 3600
path: token
- configMap:
name: kube-root-ca.crt
- downwardAPI:
items:
- fieldRef:
apiVersion: v1
fieldPath: metadata.namespace
path: namespace