Topology-Aware Policy Plugin

This chart deploys topology-aware Node Resource Interface (NRI) plugin. Topology-aware NRI resource policy plugin is a NRI plugin that will apply hardware-aware resource allocation policies to the containers running in the system.

Prerequisites

Kubernetes 1.24+
Helm 3.0.0+
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-topology-aware nri-plugins/nri-resource-policy-topology-aware --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.26.0 release version to use the NRI feature
  - 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-topology-aware nri-plugins/nri-resource-policy-topology-aware --namespace kube-system --set nri.runtime.patchConfig=true

Installing the Chart

Path to the chart: nri-resource-policy-topology-aware.

helm repo add nri-plugins https://containers.github.io/nri-plugins
helm install my-topology-aware nri-plugins/nri-resource-policy-topology-aware --namespace kube-system

The command above deploys topology-aware 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 topology-aware plugin with custom values provided using the --set option
helm install my-topology-aware nri-plugins/nri-resource-policy-topology-aware --namespace kube-system --set nri.runtime.patchConfig=true

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

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

helm install my-topology-aware nri-plugins/nri-resource-policy-topology-aware --namespace kube-system -f myPath/values.yaml

Uninstalling the Chart

To uninstall the topology-aware plugin run the following command:

helm delete my-topology-aware --namespace kube-system

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-resource-policy-topology-aware	container image name
`image.tag`	unstable	container image tag
`image.pullPolicy`	Always	image pull policy
`resources.cpu`	500m	cpu resources for the Pod
`resources.memory`	512Mi	memory qouta for the Pod
`extraEnv`	{}	extra environment variables to inject (string map)
`config`	see helm chart values for the default configuration	plugin configuration data
`configGroupLabel`	config.nri/group	node label for grouping configuration
`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
`nri.plugin.annotations`	{}	extra annotations for the plugin’s pod
`initImage.name`	ghcr.io/containers/nri-plugins/config-manager	init container image name
`initImage.tag`	unstable	init container image tag
`initImage.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
`ports`	[]	extra ports to expose to the host