Skip to content

Commit

Permalink
Update documentation for v0.2
Browse files Browse the repository at this point in the history
Auto-generated from v0.2.0-4-g1da8f6c by 'update-gh-pages.sh'
  • Loading branch information
Github committed Oct 12, 2023
1 parent cb0eb76 commit dcf8764
Show file tree
Hide file tree
Showing 26 changed files with 90 additions and 70 deletions.
2 changes: 1 addition & 1 deletion v0.2/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 15d9322d87e2a508dbafde4cac852d6b
config: 8fe6733bb25fb6c8a56a36b781987278
tags: 645f666f9bcd5a90fca523b33c5a78b7
48 changes: 31 additions & 17 deletions v0.2/_sources/docs/resource-policy/installation.md.txt
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
2 changes: 1 addition & 1 deletion v0.2/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.2.0-2-g7055ec6',
VERSION: '0.2.0-4-g1da8f6c',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion v0.2/docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; NRI Plugins 0.2.0-2-g7055ec6 documentation</title>
<title>Contributing &mdash; NRI Plugins 0.2.0-4-g1da8f6c documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
2 changes: 1 addition & 1 deletion v0.2/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to NRI Plugins documentation &mdash; NRI Plugins 0.2.0-2-g7055ec6 documentation</title>
<title>Welcome to NRI Plugins documentation &mdash; NRI Plugins 0.2.0-4-g1da8f6c documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
2 changes: 1 addition & 1 deletion v0.2/docs/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Introduction &mdash; NRI Plugins 0.2.0-2-g7055ec6 documentation</title>
<title>Introduction &mdash; NRI Plugins 0.2.0-4-g1da8f6c documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
2 changes: 1 addition & 1 deletion v0.2/docs/memory/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Memory plugins &mdash; NRI Plugins 0.2.0-2-g7055ec6 documentation</title>
<title>Memory plugins &mdash; NRI Plugins 0.2.0-4-g1da8f6c documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
2 changes: 1 addition & 1 deletion v0.2/docs/memory/memory-qos.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Memory QoS NRI plugin &mdash; NRI Plugins 0.2.0-2-g7055ec6 documentation</title>
<title>Memory QoS NRI plugin &mdash; NRI Plugins 0.2.0-4-g1da8f6c documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
2 changes: 1 addition & 1 deletion v0.2/docs/memory/memtierd.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Memtierd NRI plugin &mdash; NRI Plugins 0.2.0-2-g7055ec6 documentation</title>
<title>Memtierd NRI plugin &mdash; NRI Plugins 0.2.0-4-g1da8f6c documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
2 changes: 1 addition & 1 deletion v0.2/docs/resource-policy/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamic Configuration &mdash; NRI Plugins 0.2.0-2-g7055ec6 documentation</title>
<title>Dynamic Configuration &mdash; NRI Plugins 0.2.0-4-g1da8f6c documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down
Loading

0 comments on commit dcf8764

Please sign in to comment.