Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update charts installation instructions #147

Merged
merged 1 commit into from
Oct 12, 2023
Merged

docs: update charts installation instructions #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 31 additions & 17 deletions docs/resource-policy/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -41,38 +41,44 @@ 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+
- Helm 3.0.0+

## 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
Expand All @@ -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.
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand Down