From f0a32b5b8f77ce45f4849b03ca61b9a58726512d Mon Sep 17 00:00:00 2001 From: Feruzjon Muyassarov Date: Thu, 12 Oct 2023 00:57:54 +0300 Subject: [PATCH] docs: update charts installation instructions Signed-off-by: Feruzjon Muyassarov --- docs/resource-policy/installation.md | 48 ++++++++++++++++++---------- 1 file changed, 31 insertions(+), 17 deletions(-) diff --git a/docs/resource-policy/installation.md b/docs/resource-policy/installation.md index fe4dd0394..fa2db3c17 100644 --- a/docs/resource-policy/installation.md +++ b/docs/resource-policy/installation.md @@ -26,7 +26,7 @@ following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-r For instance, ```sh - helm install topology-aware --namespace kube-system --set nri.patchRuntimeConfig=true deployment/helm/topology-aware/ + helm install topology-aware nri-plugins/nri-resource-policy-topology-aware --namespace kube-system --set nri.patchRuntimeConfig=true ``` Enabling `nri.patchRuntimeConfig` creates an init container to turn on @@ -41,7 +41,7 @@ following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-r For instance, ```sh - helm install topology-aware --namespace kube-system --set nri.patchRuntimeConfig=true deployment/helm/topology-aware/ + helm install topology-aware nri-plugins/nri-resource-policy-topology-aware --namespace kube-system --set nri.patchRuntimeConfig=true ``` - Kubernetes 1.24+ @@ -49,30 +49,36 @@ following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-r ## Installing the Helm Chart -1. Clone the project to your local machine +1. Add the nri-plugins charts repository so that Helm install can find the actual charts. + ```sh - git clone https://github.com/containers/nri-plugins.git + helm repo add nri-plugins https://containers.github.io/nri-plugins ``` -1. Navigate to the project directory +1. List chart repositories to ensure that nri-plugins repo is added. + ```sh - cd nri-plugins + helm repo list ``` -1. Install the plugin using Helm. Replace release name with the desired name - for your Helm release. In this example, we named it as topology-aware. The - default values for topology-aware resource policy plugin are stored in - values.yaml file. If you wish to provide custom values to the Helm - chart, refer to the [table](#helm-parameters) below, which describes the - available parameters that can be modified before installation. It's important - to note that specifying the namespace (using `--namespace`) is crucial when - installing the Helm chart. If no namespace is specified, the manifests will - be installed in the default namespace. +1. Install the plugin. Replace release version with the desired version. If you wish to + provide custom values to the Helm chart, refer to the [table](#helm-parameters) below, + which describes the available parameters that can be modified before installation. + It's important to note that specifying the namespace (using `--namespace` or `-n`) is + crucial when installing the Helm chart. If no namespace is specified, the manifests + will be installed in the default namespace. ```sh - helm install topology-aware --namespace kube-system deployment/helm/topology-aware/ + helm install topology-aware nri-plugins/nri-resource-policy-topology-aware --namespace kube-system ``` + The helm repository is named `nri-plugins`, and in step 1, you have the + flexibility to choose any name when adding it. However, it's important to + note that `nri-resource-policy-topology-aware`, which serves as the path + to the chart, must accurately reflect the actual name of the chart. You + can find the path to each chart in the [helm parameters table](#helm-parameters). + + 1. Verify the status of the daemonset to ensure that the plugin is running successfully ```bash @@ -89,7 +95,7 @@ That's it! You have now installed the topology-aware NRI resource policy plugin To uninstall plugin chart just deleting it with the release name is enough: ```bash -helm delete topology-aware +helm uninstall topology-aware --namespace kube-system ``` Note: this removes DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-related objects associated with the chart. @@ -101,6 +107,8 @@ along with the default values, for the Topology-aware and Balloons plugins Helm #### Topology-aware +Path to the chart: `nri-resource-policy-topology-aware` + | Name | Default | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | `image.name` | [ghcr.io/containers/nri-plugins/nri-resource-policy-topology-aware](ghcr.io/containers/nri-plugins/nri-resource-policy-topology-aware) | container image name | @@ -117,6 +125,8 @@ along with the default values, for the Topology-aware and Balloons plugins Helm #### Balloons +Path to the chart: `nri-resource-policy-balloons` + | Name | Default | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | `image.name` | [ghcr.io/containers/nri-plugins/nri-resource-policy-balloons](ghcr.io/containers/nri-plugins/nri-resource-policy-balloons) | container image name | @@ -133,6 +143,8 @@ along with the default values, for the Topology-aware and Balloons plugins Helm #### Memtierd +Path to the chart: `nri-memtierd` + | Name | Default | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | `image.name` | [ghcr.io/containers/nri-plugins/nri-memtierd](ghcr.io/containers/nri-plugins/nri-memtierd) | container image name | @@ -149,6 +161,8 @@ along with the default values, for the Topology-aware and Balloons plugins Helm #### Memory-qos +Path to the chart: `nri-memory-qos` + | Name | Default | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | `image.name` | [ghcr.io/containers/nri-plugins/nri-memory-qos](ghcr.io/containers/nri-plugins/nri-memory-qos) | container image name |