forked from containers/nri-plugins
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[release-0.2]: cherry-pick doc changes from main branch
This commit cherry-pick changes related to docs that landed in the main branch. Co-authored-by: Krisztian Litkey <krisztian.litkey@intel.com> Co-authored-by: Markus Lehtonen <markus.lehtonen@intel.com> Signed-off-by: Feruzjon Muyassarov <feruzjon.muyassarov@intel.com>
- Loading branch information
3 people
committed
Oct 27, 2023
1 parent
bc777a0
commit b1939c2
Showing
24 changed files
with
727 additions
and
665 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| # Balloons Policy Plugin | ||
|
|
||
| This chart deploys balloons Node Resource Interface (NRI) plugin. The balloons | ||
| NRI resource policy plugin implements workload placement into “balloons” that | ||
| are disjoint CPU pools. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Kubernetes 1.24+ | ||
| - Helm 3.0.0+ | ||
| - Container runtime: | ||
| - 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](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.patchRuntimeConfig` parameter. For instance, | ||
|
|
||
| ```sh | ||
| helm install my-balloons nri-plugins/nri-resource-policy-balloons --set nri.patchRuntimeConfig=true --namespace kube-system | ||
| ``` | ||
|
|
||
| Enabling `nri.patchRuntimeConfig` 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](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) | ||
| detailed instructions. You can optionally enable the NRI in CRI-O using | ||
| the Helm chart during the chart installation simply by setting the | ||
| `nri.patchRuntimeConfig` parameter. For instance, | ||
|
|
||
| ```sh | ||
| helm install my-balloons nri-plugins/nri-resource-policy-balloons --namespace kube-system --set nri.patchRuntimeConfig=true | ||
| ``` | ||
|
|
||
| ## Installing the Chart | ||
|
|
||
| Path to the chart: `nri-resource-policy-balloons` | ||
|
|
||
| ```sh | ||
| helm repo add nri-plugins https://containers.github.io/nri-plugins | ||
| helm install my-balloons nri-plugins/nri-resource-policy-balloons --namespace kube-system | ||
| ``` | ||
|
|
||
| The command above deploys balloons 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](#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: | ||
|
|
||
| ```sh | ||
| # Install the balloons plugin with custom values provided using the --set option | ||
| helm install my-balloons nri-plugins/nri-resource-policy-balloons --namespace kube-system --set nri.patchRuntimeConfig=true | ||
| ``` | ||
|
|
||
| ```sh | ||
| # Install the balloons plugin with custom values specified in a custom values.yaml file | ||
| cat <<EOF > myPath/values.yaml | ||
| nri: | ||
| patchRuntimeConfig: true | ||
| tolerations: | ||
| - key: "node-role.kubernetes.io/control-plane" | ||
| operator: "Exists" | ||
| effect: "NoSchedule" | ||
| EOF | ||
| helm install my-balloons nri-plugins/nri-resource-policy-balloons --namespace kube-system -f myPath/values.yaml | ||
| ``` | ||
|
|
||
| ## Uninstalling the Chart | ||
|
|
||
| To uninstall the balloons plugin run the following command: | ||
|
|
||
| ```sh | ||
| helm delete my-balloons --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-balloons](https://ghcr.io/containers/nri-plugins/nri-resource-policy-balloons) | 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 | | ||
| | `hostPort` | 8891 | metrics port to expose on the host | | ||
| | `config` | <pre><code>ReservedResources:</code><br><code> cpu: 750m</code></pre> | plugin configuration data | | ||
| | `nri.patchRuntimeConfig` | false | enable NRI in containerd or CRI-O | | ||
| | `initImage.name` | [ghcr.io/containers/nri-plugins/config-manager](https://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 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # Memory-QoS Plugin | ||
|
|
||
| This chart deploys memory-qos Node Resource Interface (NRI) plugin. The | ||
| memory-qos NRI plugin adds two methods for controlling cgroups v2 memory.* | ||
| parameters: QoS class and direct memory annotations. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Kubernetes 1.24+ | ||
| - Helm 3.0.0+ | ||
| - Container runtime: | ||
| - 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](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.patchRuntimeConfig` parameter. For instance, | ||
|
|
||
| ```sh | ||
| helm install my-memory-qos nri-plugins/nri-memory-qos --set nri.patchRuntimeConfig=true --namespace kube-system | ||
| ``` | ||
|
|
||
| Enabling `nri.patchRuntimeConfig` 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](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) | ||
| detailed instructions. You can optionally enable the NRI in CRI-O using | ||
| the Helm chart during the chart installation simply by setting the | ||
| `nri.patchRuntimeConfig` parameter. For instance, | ||
|
|
||
| ```sh | ||
| helm install my-memory-qos nri-plugins/nri-memory-qos --namespace kube-system --set nri.patchRuntimeConfig=true | ||
| ``` | ||
|
|
||
| ## Installing the Chart | ||
|
|
||
| Path to the chart: `nri-memory-qos`. | ||
|
|
||
| ```sh | ||
| helm repo add nri-plugins https://containers.github.io/nri-plugins | ||
| helm install my-memory-qos nri-plugins/nri-memory-qos --namespace kube-system | ||
| ``` | ||
|
|
||
| The command above deploys memory-qos 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](#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: | ||
|
|
||
| ```sh | ||
| # Install the memory-qos plugin with custom values provided using the --set option | ||
| helm install my-memory-qos nri-plugins/nri-memory-qos --namespace kube-system --set nri.patchRuntimeConfig=true | ||
| ``` | ||
|
|
||
| ```sh | ||
| # Install the memory-qos plugin with custom values specified in a custom values.yaml file | ||
| cat <<EOF > myPath/values.yaml | ||
| nri: | ||
| patchRuntimeConfig: true | ||
| tolerations: | ||
| - key: "node-role.kubernetes.io/control-plane" | ||
| operator: "Exists" | ||
| effect: "NoSchedule" | ||
| EOF | ||
| helm install my-memory-qos nri-plugins/nri-memory-qos --namespace kube-system -f myPath/values.yaml | ||
| ``` | ||
|
|
||
| ## Uninstalling the Chart | ||
|
|
||
| To uninstall the memory-qos plugin run the following command: | ||
|
|
||
| ```sh | ||
| helm delete my-memory-qos --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-memory-qos](https://ghcr.io/containers/nri-plugins/nri-memory-qos) | 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` | 100Mi | memory qouta for the | | ||
| | `nri.patchRuntimeConfig` | false | enable NRI in containerd or CRI-O | | ||
| | `initImage.name` | [ghcr.io/containers/nri-plugins/config-manager](https://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 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # Memtierd Plugin | ||
|
|
||
| This chart deploys memtierd Node Resource Interface (NRI) plugin. The memtierd | ||
| NRI plugin enables managing workloads with Memtierd in Kubernetes. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Kubernetes 1.24+ | ||
| - Helm 3.0.0+ | ||
| - Container runtime: | ||
| - 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](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.patchRuntimeConfig` parameter. For instance, | ||
|
|
||
| ```sh | ||
| helm install my-memtierd nri-plugins/nri-memtierd --set nri.patchRuntimeConfig=true --namespace kube-system | ||
| ``` | ||
|
|
||
| Enabling `nri.patchRuntimeConfig` 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](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) | ||
| detailed instructions. You can optionally enable the NRI in CRI-O using | ||
| the Helm chart during the chart installation simply by setting the | ||
| `nri.patchRuntimeConfig` parameter. For instance, | ||
|
|
||
| ```sh | ||
| helm install my-memtierd nri-plugins/nri-memtierd --namespace kube-system --set nri.patchRuntimeConfig=true | ||
| ``` | ||
|
|
||
| ## Installing the Chart | ||
|
|
||
| Path to the chart: `nri-memtierd`. | ||
|
|
||
| ```sh | ||
| helm repo add nri-plugins https://containers.github.io/nri-plugins | ||
| helm install my-memtierd nri-plugins/nri-memtierd --namespace kube-system | ||
| ``` | ||
|
|
||
| The command above deploys memtierd 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](#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: | ||
|
|
||
| ```sh | ||
| # Install the memtierd plugin with custom values provided using the --set option | ||
| helm install my-memtierd nri-plugins/nri-memtierd --namespace kube-system --set nri.patchRuntimeConfig=true | ||
| ``` | ||
|
|
||
| ```sh | ||
| # Install the nri-memtierd plugin with custom values specified in a custom values.yaml file | ||
| cat <<EOF > myPath/values.yaml | ||
| nri: | ||
| patchRuntimeConfig: true | ||
| tolerations: | ||
| - key: "node-role.kubernetes.io/control-plane" | ||
| operator: "Exists" | ||
| effect: "NoSchedule" | ||
| EOF | ||
| helm install my-memtierd nri-plugins/nri-memtierd --namespace kube-system -f myPath/values.yaml | ||
| ``` | ||
|
|
||
| ## Uninstalling the Chart | ||
|
|
||
| To uninstall the memtierd plugin run the following command: | ||
|
|
||
| ```sh | ||
| helm delete my-memtierd --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-memtierd](https://ghcr.io/containers/nri-plugins/nri-memtierd) | container image name | | ||
| | `image.tag` | unstable | container image tag | | ||
| | `image.pullPolicy` | Always | image pull policy | | ||
| | `resources.cpu` | 250m | cpu resources for the Pod | | ||
| | `resources.memory` | 100Mi | memory qouta for the | | ||
| | `outputDir` | empty string | host directory for memtierd.output files | | ||
| | `nri.patchRuntimeConfig` | false | enable NRI in containerd or CRI-O | | ||
| | `initImage.name` | [ghcr.io/containers/nri-plugins/config-manager](https://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 | |
Oops, something went wrong.