Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana Agent Grafana Agent Flow Reference Components mimir.rules.kubernetes

mimir.rules.kubernetes

BETA: This is a beta component. Beta components are subject to breaking changes, and may be replaced with equivalent functionality that cover the same use case.

mimir.rules.kubernetes discovers PrometheusRule Kubernetes resources and loads them into a Mimir instance.

• Multiple mimir.rules.kubernetes components can be specified by giving them different labels.
• Kubernetes label selectors can be used to limit the Namespace and PrometheusRule resources considered during reconciliation.
• Compatible with the Ruler APIs of Grafana Mimir, Grafana Cloud, and Grafana Enterprise Metrics.
• Compatible with the PrometheusRule CRD from the prometheus-operator.
• This component accesses the Kubernetes REST API from within a Pod.

NOTE: This component requires Role-based access control (RBAC) to be setup in Kubernetes in order for the Agent to access it via the Kubernetes REST API. For an example RBAC configuration please click here.

Usage

river Copy

mimir.rules.kubernetes "LABEL" {
  address = MIMIR_RULER_URL
}

Arguments

mimir.rules.kubernetes supports the following arguments:

At most one of the following can be provided:

• bearer_token argument.
• bearer_token_file argument.
• basic_auth block.
• authorization block.
• oauth2 block.

If no tenant_id is provided, the component assumes that the Mimir instance at address is running in single-tenant mode and no X-Scope-OrgID header is sent.

The sync_interval argument determines how often Mimir’s ruler API is accessed to reload the current state of rules. Interaction with the Kubernetes API works differently. Updates are processed as events from the Kubernetes API server according to the informer pattern.

The mimir_namespace_prefix argument can be used to separate the rules managed by multiple agent deployments across your infrastructure. It should be set to a unique value for each deployment.

Blocks

The following blocks are supported inside the definition of mimir.rules.kubernetes:

The > symbol indicates deeper levels of nesting. For example, oauth2 > tls_config refers to a tls_config block defined inside an oauth2 block.

label_selector block

The label_selector block describes a Kubernetes label selector for rule or namespace discovery.

The following arguments are supported:

When the match_labels argument is empty, all resources will be matched.

match_expression block

The match_expression block describes a Kubernetes label match expression for rule or namespace discovery.

The following arguments are supported:

The operator argument should be one of the following strings:

• "in"
• "notin"
• "exists"

basic_auth block

password and password_file are mututally exclusive and only one can be provided inside of a basic_auth block.

authorization block

credential and credentials_file are mutually exclusive and only one can be provided inside of an authorization block.

oauth2 block

client_secret and client_secret_file are mututally exclusive and only one can be provided inside of an oauth2 block.

The oauth2 block may also contain its own separate tls_config sub-block.

tls_config block

When min_version is not provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

• "TLS10" (TLS 1.0)
• "TLS11" (TLS 1.1)
• "TLS12" (TLS 1.2)
• "TLS13" (TLS 1.3)

Exported fields

mimir.rules.kubernetes does not export any fields.

Component health

mimir.rules.kubernetes is reported as unhealthy if given an invalid configuration or an error occurs during reconciliation.

Debug information

mimir.rules.kubernetes exposes resource-level debug information.

The following are exposed per discovered PrometheusRule resource:

• The Kubernetes namespace.
• The resource name.
• The resource uid.
• The number of rule groups.

The following are exposed per discovered Mimir rule namespace resource:

• The namespace name.
• The number of rule groups.

Only resources managed by the component are exposed - regardless of how many actually exist.

Debug metrics

Example

This example creates a mimir.rules.kubernetes component that loads discovered rules to a local Mimir instance under the team-a tenant. Only namespaces and rules with the agent label set to yes are included.

river Copy

mimir.rules.kubernetes "local" {
    address = "mimir:8080"
    tenant_id = "team-a"

    rule_namespace_selector {
        match_labels = {
            agent = "yes",
        }
    }

    rule_selector {
        match_labels = {
            agent = "yes",
        }
    }
}

This example creates a mimir.rules.kubernetes component that loads discovered rules to Grafana Cloud.

river Copy

mimir.rules.kubernetes "default" {
    address = "GRAFANA_CLOUD_METRICS_URL"
    basic_auth {
        username = "GRAFANA_CLOUD_USER"
        password = "GRAFANA_CLOUD_API_KEY"
        // Alternatively, load the password from a file:
        // password_file = "GRAFANA_CLOUD_API_KEY_PATH"
    }
}

The following example is an RBAC configuration for Kubernetes. It authorizes the Agent to query the Kubernetes REST API:

yaml Copy

apiVersion: v1
kind: ServiceAccount
metadata:
  name: grafana-agent
  namespace: default
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: grafana-agent
rules:
- apiGroups: [""]
  resources: ["namespaces"]
  verbs: ["get", "list", "watch"]
- apiGroups: ["monitoring.coreos.com"]
  resources: ["prometheusrules"]
  verbs: ["get", "list", "watch"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: grafana-agent
subjects:
- kind: ServiceAccount
  name: grafana-agent
  namespace: default
roleRef:
  kind: ClusterRole
  name: grafana-agent
  apiGroup: rbac.authorization.k8s.io