metrics/docs/victoriametrics/integrations/OpenShift.md

title, weight, menu

title	weight	menu
OpenShift	10	docs parent weight integrations-vm 10

OpenShift Container Platform (OCP)

OpenShift uses Prometheus as a core monitoring solution. It cannot be replaced without violating the OpenShift support policy. However, OpenShift can be configured to use VictoriaMetrics as a remote write target.

According to remote write configuration in the OpenShift documentation, the following manifest needs to be applied to send platform metrics to VictoriaMetrics:

apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |
    prometheusK8s:
      remoteWrite:
      - url: "https://<victoriametrics_url>/api/v1/write"

This instructs Prometheus to push metrics to VictoriaMetrics instance via Prometheus remote write protocol. This URL may also point to vminsert and contain tenant ID:

apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |
    prometheusK8s:
      remoteWrite:
      - url: "https://<vminsert-addr>/insert/<tenant_id>/prometheus/api/v1/write"

Note, that OpenShift uses two Prometheus replicas for HA configuration. Each replica adds prometheus_replica label to the forwarded metrics. This is excessive on VictoriaMetrics side, so use the following setting to drop this label:

apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |
    prometheusK8s:
      remoteWrite:
      - url: "..."
        writeRelabelConfigs:
        - regex: 'prometheus_replica'
          action: labeldrop

We also recommend setting Prometheus retention to the minimum:

apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |
    prometheusK8s:
      retention: "1h"

In case VictoriaMetrics requires authentication, you can configure it by adding the following lines to the config.yaml file:

apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |
    prometheusK8s:
      remoteWrite:
      - url: "..."
        authorization:
          type: Bearer
          credentials:
            name: config-map-bearer
            key: token

Along with core platform monitoring, OpenShift also supports collecting user workload metrics. See this guide for more information. In order to send user workload metrics to VictoriaMetrics, the following manifest needs to be applied:

apiVersion: v1
kind: ConfigMap
metadata:
  name: user-workload-monitoring-config
  namespace: openshift-user-workload-monitoring
data:
  config.yaml: |
    prometheus:
      remoteWrite:
      - url: "https://<vminsert-addr>/insert/<tenant_id>/prometheus/api/v1/write"
        writeRelabelConfigs:
        - regex: 'prometheus_replica'
          action: labeldrop

Hosted Control Plane

Hosted Control Plane (HCP) is a form factor of OpenShift Container Platform where control plane and data planes are decoupled. The control plane is hosted by using high-level primitives such as deployments and stateful sets that are native to Kubernetes. The data plane is on a separate network domain with a dedicated physical hosting environment.

In order to send control plane metrics to VictoriaMetrics apply the following manifest on the host cluster:

apiVersion: v1
kind: ConfigMap
metadata:
  name: user-workload-monitoring-config
  namespace: openshift-user-workload-monitoring
data:
  config.yaml: |
    prometheus:
      retention: "1h"
      remoteWrite:
      # Host cluster app metrics, not including `cluster-.*` namespaces where control planes are hosted
      - url: "http://<vminsert-addr>/insert/<host cluster infra tenant id>/prometheus/api/v1/write"
        writeRelabelConfigs:
        - regex: 'prometheus_replica'
          action: labeldrop
        - sourceLabels: [ namespace ]
          regex: '^clusters.*$'
          action: drop
      # Guest cluster infra metrics, collected from the dedicated namespace
      - url: "http://<vminsert-addr>/insert/<guest cluster infra tenant id>/prometheus/api/v1/write"
        writeRelabelConfigs:
        - regex: 'prometheus_replica'
          action: labeldrop
        - sourceLabels: [ namespace ]
          regex: '^<guest namespace>.*$'
          action: keep

where <guest namespace> is the namespace where the guest cluster infra metrics are collected (usually clusters-<name>)

This will configure remote write on OpenShift-managed Prometheus to separate host cluster infra metrics from guest cluster infra metrics and send them to separate tenants in VictoriaMetrics.

Guest cluster application metrics can also be sent to a separate tenant by applying the following manifest on the guest cluster:

apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |
    enableUserWorkload: true
    prometheusK8s:
      retention: "1h"
      remoteWrite:
      - url: url: "http://<vminsert-addr>/insert/<guest cluster apps tenant id>/prometheus/api/v1/write"
        writeRelabelConfigs:
        - regex: 'prometheus_replica'
          action: labeldrop

References

• OpenShift Documentation: Core Platform Monitoring
• OpenShift Documentation: User Workload Monitoring
• OpenShift Documentation: Hosted Control Planes Overview