Update documentation for devel

Auto-generated from v0.1.0-43-ge00e6f0 by 'update-gh-pages.sh'

devel/.buildinfo

@@ -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: f3606f1ff981aec6ea39e4cb132632e5
+config: 0f8f1ce1e507ce87ae67bfc2e1bd8a9e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

devel/_sources/docs/resource-policy/installation.md.txt

@@ -19,11 +19,22 @@ following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-r
     - 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](TODO link) detailed instructions.
+        - 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.patchContainerdConfig` parameter.
+          For instance,
+
+          ```sh
+          helm install topology-aware --namespace kube-system --set nri.patchContainerdConfig=true deployment/helm/resource-management-policies/topology-aware/
+          ```
+
+          Enabling `nri.patchContainerdConfig` 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](TODO link) detailed instructions.
+        - Enable NRI feature by following [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) detailed instructions.
 - Kubernetes 1.24+
 - Helm 3.0.0+
 

devel/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.1.0-41-g50d1484',
+    VERSION: '0.1.0-43-ge00e6f0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

devel/docs/contributing.html

@@ -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.1.0-41-g50d1484 documentation</title>
+  <title>Contributing &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/index.html

@@ -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.1.0-41-g50d1484 documentation</title>
+  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/introduction.html

@@ -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.1.0-41-g50d1484 documentation</title>
+  <title>Introduction &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/memory/index.html

@@ -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.1.0-41-g50d1484 documentation</title>
+  <title>Memory plugins &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/memory/memory-qos.html

@@ -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.1.0-41-g50d1484 documentation</title>
+  <title>Memory QoS NRI plugin &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/memory/memtierd.html

@@ -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.1.0-41-g50d1484 documentation</title>
+  <title>Memtierd NRI plugin &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/resource-policy/configuration.html

@@ -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.1.0-41-g50d1484 documentation</title>
+  <title>Dynamic Configuration &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/resource-policy/developers-guide/architecture.html

@@ -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>Architecture &mdash; NRI Plugins 0.1.0-41-g50d1484 documentation</title>
+  <title>Architecture &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>
@@ -130,7 +130,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
 <section id="components">
 <h2>Components<a class="headerlink" href="#components" title="Permalink to this heading"></a></h2>
 <section id="node-agent">
-<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/pkg/resmgr/agent">Node Agent</a><a class="headerlink" href="#node-agent" title="Permalink to this heading"></a></h3>
+<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/pkg/resmgr/agent">Node Agent</a><a class="headerlink" href="#node-agent" title="Permalink to this heading"></a></h3>
 <p>The node agent is a component internal to NRI-RP itself. All interactions
 by NRI-RP with the Kubernetes Control Plane go through the node agent with
 the node agent performing any direct interactions on behalf of NRI-RP.</p>
@@ -145,7 +145,7 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
 <p>The config interface is defined and has its gRPC server running in
 NRI-RP. The agent acts as a gRPC client for this interface. The low-level
 cluster interface is defined and has its gRPC server running in the agent,
-with the <a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/pkg/resmgr/agent">convenience layer</a> defined in NRI-RP.
+with the <a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/pkg/resmgr/agent">convenience layer</a> defined in NRI-RP.
 NRI-RP acts as a gRPC client for the low-level plumbing interface.</p>
 <p>Additionally, the stock node agent that comes with NRI-RP implements schemes
 for:</p>
@@ -155,7 +155,7 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
 </ul>
 </section>
 <section id="resource-manager">
-<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/pkg/resmgr/">Resource Manager</a><a class="headerlink" href="#resource-manager" title="Permalink to this heading"></a></h3>
+<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/pkg/resmgr/">Resource Manager</a><a class="headerlink" href="#resource-manager" title="Permalink to this heading"></a></h3>
 <p>NRI-RP implements an event processing pipeline. In addition to NRI events,
 it processes a set of other events that are not directly related to or the
 result of NRI requests.
@@ -238,7 +238,7 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
 </ul>
 </section>
 <section id="cache">
-<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/pkg/resmgr/cache/">Cache</a><a class="headerlink" href="#cache" title="Permalink to this heading"></a></h3>
+<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/pkg/resmgr/cache/">Cache</a><a class="headerlink" href="#cache" title="Permalink to this heading"></a></h3>
 <p>The cache is a shared internal storage location within NRI-RP. It tracks the
 runtime state of pods and containers known to NRI-RP, as well as the state
 of NRI-RP itself, including the active configuration and the state of the
@@ -267,40 +267,40 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
 the cache properly locked.</p>
 </section>
 <section id="generic-policy-layer">
-<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/50d148427628dc66cc7aff0d1cf7cee16844e75e/pkg/resmgr/policy/policy.go">Generic Policy Layer</a><a class="headerlink" href="#generic-policy-layer" title="Permalink to this heading"></a></h3>
+<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/e00e6f00fb9af788091b4d1d3839e652441c9848/pkg/resmgr/policy/policy.go">Generic Policy Layer</a><a class="headerlink" href="#generic-policy-layer" title="Permalink to this heading"></a></h3>
 <p>The generic policy layer defines the abstract interface the rest of NRI-RP
 uses to interact with policy implementations and takes care of the details
 of activating and dispatching calls through to the configured active policy.</p>
 </section>
 <section id="generic-resource-controller-layer">
-<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/50d148427628dc66cc7aff0d1cf7cee16844e75e/pkg/resmgr/control/control.go">Generic Resource Controller Layer</a><a class="headerlink" href="#generic-resource-controller-layer" title="Permalink to this heading"></a></h3>
+<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/e00e6f00fb9af788091b4d1d3839e652441c9848/pkg/resmgr/control/control.go">Generic Resource Controller Layer</a><a class="headerlink" href="#generic-resource-controller-layer" title="Permalink to this heading"></a></h3>
 <p>The generic resource controller layer defines the abstract interface the rest
 of NRI-RP uses to interact with resource controller implementations and takes
 care of the details of dispatching calls to the controller implementations
 for post-policy enforcment of decisions.</p>
 </section>
 <section id="metrics-collector">
-<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/pkg/metrics/">Metrics Collector</a><a class="headerlink" href="#metrics-collector" title="Permalink to this heading"></a></h3>
+<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/pkg/metrics/">Metrics Collector</a><a class="headerlink" href="#metrics-collector" title="Permalink to this heading"></a></h3>
 <p>The metrics collector gathers a set of runtime metrics about the containers
 running on the node. NRI-RP can be configured to periodically evaluate this
 collected data to determine how optimal the current assignment of container
 resources is and to attempt a rebalancing/reallocation if it is deemed
 both possible and necessary.</p>
 </section>
 <section id="policy-implementations">
-<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/cmd/plugins">Policy Implementations</a><a class="headerlink" href="#policy-implementations" title="Permalink to this heading"></a></h3>
+<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/cmd/plugins">Policy Implementations</a><a class="headerlink" href="#policy-implementations" title="Permalink to this heading"></a></h3>
 <section id="topology-aware">
-<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/cmd/plugins/topology-aware/">Topology Aware</a><a class="headerlink" href="#topology-aware" title="Permalink to this heading"></a></h4>
+<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/cmd/plugins/topology-aware/">Topology Aware</a><a class="headerlink" href="#topology-aware" title="Permalink to this heading"></a></h4>
 <p>A topology-aware policy capable of handling multiple tiers/types of memory,
 typically a DRAM/PMEM combination configured in 2-layer memory mode.</p>
 </section>
 <section id="balloons">
-<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/cmd/plugins/balloons/">Balloons</a><a class="headerlink" href="#balloons" title="Permalink to this heading"></a></h4>
+<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/cmd/plugins/balloons/">Balloons</a><a class="headerlink" href="#balloons" title="Permalink to this heading"></a></h4>
 <p>A balloons policy allows user to define fine grained control how the
 computer resources are distributed to workloads.</p>
 </section>
 <section id="template">
-<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/50d148427628dc66cc7aff0d1cf7cee16844e75e/cmd/plugins/template/">Template</a><a class="headerlink" href="#template" title="Permalink to this heading"></a></h4>
+<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/e00e6f00fb9af788091b4d1d3839e652441c9848/cmd/plugins/template/">Template</a><a class="headerlink" href="#template" title="Permalink to this heading"></a></h4>
 <p>The template policy can be used as a base for developing new policies.
 It provides hooks that the policy developer can fill to define fine grained
 control how the computer resources are distributed to workloads.

devel/docs/resource-policy/developers-guide/cpu-allocator.html

@@ -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>CPU Allocator &mdash; NRI Plugins 0.1.0-41-g50d1484 documentation</title>
+  <title>CPU Allocator &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/resource-policy/developers-guide/e2e-test.html

@@ -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>End-to-End tests &mdash; NRI Plugins 0.1.0-41-g50d1484 documentation</title>
+  <title>End-to-End tests &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/resource-policy/developers-guide/index.html

@@ -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>Developer’s Guide &mdash; NRI Plugins 0.1.0-41-g50d1484 documentation</title>
+  <title>Developer’s Guide &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/resource-policy/developers-guide/testing.html

@@ -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>Testing &mdash; NRI Plugins 0.1.0-41-g50d1484 documentation</title>
+  <title>Testing &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/resource-policy/developers-guide/unit-test.html

@@ -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>Unit tests &mdash; NRI Plugins 0.1.0-41-g50d1484 documentation</title>
+  <title>Unit tests &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>

devel/docs/resource-policy/index.html

@@ -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>Resource Policy Plugins &mdash; NRI Plugins 0.1.0-41-g50d1484 documentation</title>
+  <title>Resource Policy Plugins &mdash; NRI Plugins 0.1.0-43-ge00e6f0 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]>