From 0accdecd78cf8f3be733456ba9f39864933faf16 Mon Sep 17 00:00:00 2001 From: Feruzjon Muyassarov Date: Thu, 28 Sep 2023 11:46:07 +0300 Subject: [PATCH] docs: improve plugins installation instructions Give an example how to drop a Helm flag to opt in for enabling NRI in containerd automatically. Signed-off-by: Feruzjon Muyassarov --- docs/resource-policy/installation.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/resource-policy/installation.md b/docs/resource-policy/installation.md index 93f3ff4d6..85bdc006d 100644 --- a/docs/resource-policy/installation.md +++ b/docs/resource-policy/installation.md @@ -19,11 +19,22 @@ following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-r - containerD: - At least [containerd 1.7.0](https://github.com/containerd/containerd/releases/tag/v1.7.0) release version to use the NRI feature - - Enable NRI feature by following [these](TODO link) detailed instructions. + - Enable NRI feature by following [these](https://github.com/containerd/containerd/blob/main/docs/NRI.md#enabling-nri-support-in-containerd) + detailed instructions. You can optionally enable the NRI in containerd using the Helm chart + during the chart installation simply by setting the `nri.patchContainerdConfig` parameter. + For instance, + + ```sh + helm install topology-aware --namespace kube-system --set nri.patchContainerdConfig=true deployment/helm/resource-management-policies/topology-aware/ + ``` + + Enabling `nri.patchContainerdConfig` 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](https://github.com/cri-o/cri-o/releases/tag/v1.26.0) release version to use the NRI feature - - Enable NRI feature by following [these](TODO link) detailed instructions. + - Enable NRI feature by following [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) detailed instructions. - Kubernetes 1.24+ - Helm 3.0.0+