Patch containerd to enable NRI before deploying NRI plugin

This commit adds an init container to enable NRI in containerd
configuration file. Users installing plugin via Helm have an
option to opt in for using that init container to enable the
NRI before running plugin. By default, this option is disabled.

Signed-off-by: Feruzjon Muyassarov <[email protected]>

deployment/helm/resource-management-policies/balloons/templates/configmap_enable_nri.yaml

@@ -0,0 +1,36 @@
+{{- if .Values.nri.enable }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: patch-containerd-config
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- include "balloons-plugin.labels" . | nindent 4 }}
+data:
+  patch_nri.sh: |
+   #!/bin/bash
+
+   config_file="/home/config.toml"
+   plugin="[plugins.\"io.containerd.nri.v1.nri\"]"
+   switch="disable = false"
+   
+   cp /etc/containerd/config.toml "$config_file"
+
+   # Check if the nri entry exists in the config file
+   if grep -q "$plugin" "$config_file"; then
+     # Check if the nri is already enabled
+     if grep -q "disable = false" "$config_file"; then
+       echo "NRI is already enabled..."
+     else
+       # Enable the NRI plugin
+       sed -i "s/disable = true/$switch/" "$config_file"
+       cp -f "$config_file" /etc/containerd/config.toml
+       echo "Restarting containerd...."
+       nsenter -t 1 -m bash
+       systemctl restart containerd
+       echo "NRI has been enabled..."
+     fi
+   else
+     echo "NRI entry doesn't exist in the config file."
+   fi
+{{- end }}

deployment/helm/resource-management-policies/balloons/templates/daemonset.yaml

@@ -17,6 +17,20 @@ spec:
       serviceAccount: nri-resource-policy-balloons
       nodeSelector:
         kubernetes.io/os: "linux"
+      {{- if .Values.nri.enable }}
+      hostPID: true
+      initContainers:
+      - name: patch-containerd
+        image: ubuntu:22.04
+        command: ["/tmp/patch_nri.sh"]
+        volumeMounts:
+        - name: patch-containerd-config
+          mountPath: /tmp
+        - name: containerd-config
+          mountPath: /etc/containerd/config.toml
+        securityContext:
+          privileged: true
+      {{- end }}
       containers:
         - name: nri-resource-policy-balloons
           args:
@@ -78,3 +92,13 @@ spec:
         hostPath:
           path: /var/run/nri
           type: Directory
+      {{- if .Values.nri.enable }}
+      - name: patch-containerd-config
+        configMap:
+          name: patch-containerd-config
+          defaultMode: 0777
+      - name: containerd-config
+        hostPath:
+          path: /etc/containerd/config.toml
+          type: File
+      {{- end }}

deployment/helm/resource-management-policies/balloons/values.yaml

@@ -17,3 +17,6 @@ hostPort: 8891
 resources:
   cpu: 500m
   memory: 512Mi
+
+nri:
+  enable: false

deployment/helm/resource-management-policies/topology-aware/templates/configmap_emable_nri.yaml

@@ -0,0 +1,36 @@
+{{- if .Values.nri.enable }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: patch-containerd-config
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- include "topology-aware-plugin.labels" . | nindent 4 }}
+data:
+  patch_nri.sh: |
+   #!/bin/bash
+
+   config_file="/home/config.toml"
+   plugin="[plugins.\"io.containerd.nri.v1.nri\"]"
+   switch="disable = false"
+   
+   cp /etc/containerd/config.toml "$config_file"
+
+   # Check if the nri entry exists in the config file
+   if grep -q "$plugin" "$config_file"; then
+     # Check if the nri is already enabled
+     if grep -q "disable = false" "$config_file"; then
+       echo "NRI is already enabled..."
+     else
+       # Enable the NRI plugin
+       sed -i "s/disable = true/$switch/" "$config_file"
+       cp -f "$config_file" /etc/containerd/config.toml
+       echo "Restarting containerd...."
+       nsenter -t 1 -m bash
+       systemctl restart containerd
+       echo "NRI has been enabled..."
+     fi
+   else
+     echo "NRI entry doesn't exist in the config file."
+   fi
+{{- end }}

deployment/helm/resource-management-policies/topology-aware/templates/daemonset.yaml

@@ -17,6 +17,20 @@ spec:
       serviceAccount: nri-resource-policy-topology-aware
       nodeSelector:
         kubernetes.io/os: "linux"
+      {{- if .Values.nri.enable }}
+      hostPID: true
+      initContainers:
+      - name: patch-containerd
+        image: ubuntu:22.04
+        command: ["/tmp/patch_nri.sh"]
+        volumeMounts:
+        - name: patch-containerd-config
+          mountPath: /tmp
+        - name: containerd-config
+          mountPath: /etc/containerd/config.toml
+        securityContext:
+          privileged: true
+      {{- end }}
       containers:
         - name: nri-resource-policy-topology-aware
           args:
@@ -78,3 +92,13 @@ spec:
         hostPath:
           path: /var/run/nri
           type: Directory
+      {{- if .Values.nri.enable }}
+      - name: patch-containerd-config
+        configMap:
+          name: patch-nri-config
+          defaultMode: 0777
+      - name: containerd-config
+        hostPath:
+          path: /etc/containerd/config.toml
+          type: File
+      {{- end }}

deployment/helm/resource-management-policies/topology-aware/values.yaml

@@ -17,3 +17,6 @@ hostPort: 8891
 resources:
   cpu: 500m
   memory: 512Mi
+
+nri:
+  enable: false

docs/resource-policy/installation.md

@@ -102,6 +102,7 @@ along with the default values, for the Topology-aware and Balloons plugins Helm
 | `resources.memory` | 512Mi                                                                                                                         | memory qouta for the Pod                             | 
 | `hostPort`         | 8891                                                                                                                          | metrics port to expose on the host                   |
 | `config`           | <pre><code>ReservedResources:</code><br><code>  cpu: 750m</code></pre>                                                        | plugin configuration data                            |
+| `nri.enable`       | false                                                                                                                         | enable/disbale NRI in containerd                     |
 
 ## Manual installation