Resctrl-Mon Plugin

This chart deploys the resctrl-mon Node Resource Interface (NRI) plugin. The resctrl-mon NRI plugin creates per-pod resctrl monitoring groups (mon_groups) to support Application Energy Telemetry (AET) via Kepler passive mode.

Prerequisites

  • Kubernetes 1.24+

  • Helm 3.0.0+

  • Intel CPU with RDT monitoring support (CMT/MBM and/or AET)

  • resctrl filesystem mounted at /sys/fs/resctrl

  • Container runtime:

    • containerd:

      • At least containerd 1.7.0 release version to use the NRI feature.

      • Enable NRI feature by following these detailed instructions. You can optionally enable the NRI in containerd using the Helm chart during the chart installation simply by setting the nri.runtime.patchConfig parameter. For instance,

        helm install my-resctrl-mon nri-plugins/nri-resctrl-mon --set nri.runtime.patchConfig=true --namespace kube-system

        Enabling nri.runtime.patchConfig creates an init container to turn on NRI feature in containerd and only after that proceed the plugin installation.

    • CRI-O

      • At least v1.36.0 release version. CRI-O >= 1.36 is required because earlier versions do not provide container PIDs via NRI, which prevents the plugin from assigning tasks to monitoring groups.

      • Enable NRI feature by following these detailed instructions. You can optionally enable the NRI in CRI-O using the Helm chart during the chart installation simply by setting the nri.runtime.patchConfig parameter. For instance,

        helm install my-resctrl-mon nri-plugins/nri-resctrl-mon --namespace kube-system --set nri.runtime.patchConfig=true

Installing the Chart

Path to the chart: nri-resctrl-mon.

helm repo add nri-plugins https://containers.github.io/nri-plugins
helm install my-resctrl-mon nri-plugins/nri-resctrl-mon --namespace kube-system

The command above deploys resctrl-mon NRI plugin on the Kubernetes cluster within the kube-system namespace with default configuration. To customize the available parameters as described in the Configuration options below, you have two options: you can use the --set flag or create a custom values.yaml file and provide it using the -f flag. For example:

# Install the resctrl-mon plugin with custom values provided using the --set option
helm install my-resctrl-mon nri-plugins/nri-resctrl-mon --namespace kube-system --set nri.runtime.patchConfig=true

# Install the resctrl-mon plugin with custom values specified in a custom values.yaml file
cat <<EOF > myPath/values.yaml
nri:
  runtime:
    patchConfig: true
  plugin:
    index: 90

tolerations:
- key: "node-role.kubernetes.io/control-plane"
  operator: "Exists"
  effect: "NoSchedule"
EOF

helm install my-resctrl-mon nri-plugins/nri-resctrl-mon --namespace kube-system -f myPath/values.yaml

Uninstalling the Chart

To uninstall the resctrl-mon plugin run the following command:

helm delete my-resctrl-mon --namespace kube-system

Security

The DaemonSet runs with hostPID: true because the plugin must write host-namespace PIDs into resctrl tasks files. Without host PID visibility the kernel rejects the write (ESRCH). The container also requires SYS_ADMIN and DAC_OVERRIDE capabilities to manage resctrl mon_group directories.

Configuration options

The tables below present an overview of the parameters available for users to customize with their own values, along with the default values.

Name

Default

Description

image.name

ghcr.io/containers/nri-plugins/nri-resctrl-mon

container image name

image.tag

unstable

container image tag

image.pullPolicy

Always

image pull policy

resources.cpu

10m

cpu resources for the Pod

resources.memory

50Mi

memory quota for the Pod

nri.runtime.config.pluginRegistrationTimeout

“”

set NRI plugin registration timeout in NRI config of containerd or CRI-O

nri.runtime.config.pluginRequestTimeout

“”

set NRI plugin request timeout in NRI config of containerd or CRI-O

nri.runtime.patchConfig

false

patch NRI configuration in containerd or CRI-O

nri.plugin.index

90

NRI plugin index to register with

initContainerImage.name

ghcr.io/containers/nri-plugins/nri-config-manager

init container image name

initContainerImage.tag

unstable

init container image tag

initContainerImage.pullPolicy

Always

init container image pull policy

tolerations

[]

specify taint toleration key, operator and effect

affinity

[]

specify node affinity

nodeSelector

[]

specify node selector labels

podPriorityClassNodeCritical

true

enable marking Pod as node critical