-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add basic README for each Helm chart on their own directory
This commit adds basic documentation for each Helm chart so that basic information is available to the user who are trying to install any of those plugins via artifacthub.io registry. Signed-off-by: Feruzjon Muyassarov <[email protected]>
- Loading branch information
1 parent
2babf1f
commit d3850b2
Showing
5 changed files
with
185 additions
and
80 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,44 @@ | ||
| # Introduction | ||
|
|
||
| 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. | ||
|
|
||
| # Installing the Chart | ||
|
|
||
| Path to the chart: `nri-resource-policy-balloons` | ||
|
|
||
| ``` | ||
| 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. | ||
|
|
||
| # Uninstalling the Chart | ||
|
|
||
| To uninstall the balloons plugin run the following command: | ||
|
|
||
| ``` | ||
| 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,43 @@ | ||
| # Introduction | ||
|
|
||
| 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. | ||
|
|
||
| # Installing the Chart | ||
|
|
||
| Path to the chart: `nri-memory-qos`. | ||
|
|
||
| ``` | ||
| 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 memtierd NRI plugin on the Kubernetes cluster within the | ||
| `kube-system` namespace with default configuration. | ||
|
|
||
| # Uninstalling the Chart | ||
|
|
||
| To uninstall the memory-qos plugin run the following command: | ||
|
|
||
| ``` | ||
| 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,43 @@ | ||
| # Introduction | ||
|
|
||
| This chart deploys memtierd Node Resource Interface (NRI) plugin. The memtierd NRI plugin enables | ||
| managing workloads with Memtierd in Kubernetes. | ||
|
|
||
| # Installing the Chart | ||
|
|
||
| Path to the chart: `nri-memtierd`. | ||
|
|
||
| ``` | ||
| 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. | ||
|
|
||
| # Uninstalling the Chart | ||
|
|
||
| To uninstall the memtierd plugin run the following command: | ||
|
|
||
| ``` | ||
| 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 | |
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,45 @@ | ||
| # Introduction | ||
|
|
||
| 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. | ||
|
|
||
| # 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. | ||
|
|
||
| # 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](https://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 | | ||
| | `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 | |
Oops, something went wrong.