Update documentation for devel

Auto-generated from v0.3.1-64-g42457cf by 'update-gh-pages.sh'
containers · Feb 14, 2024 · 5bf26fa · 5bf26fa
1 parent 3f2acf4
commit 5bf26fa
Show file tree

Hide file tree

Showing 39 changed files with 84 additions and 52 deletions.
diff --git a/devel/.buildinfo b/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: 805dd7b288e9143e97fb9848b829c96e
+config: 3b68cc3f25dc8c90f6bfe94432f86add
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/devel/_sources/docs/resource-policy/policy/topology-aware.md.txt b/devel/_sources/docs/resource-policy/policy/topology-aware.md.txt
@@ -310,6 +310,22 @@ defined affinities with implicit co-location requires both careful consideration
 and a thorough understanding of affinity evaluation, or it should be avoided
 altogether.
 
+## Disabling CPU or Memory Pinning of a Container
+
+Some containers may need to run on all CPUs or access all memories
+without restrictions. Annotate these pods and containers to prevent
+the resource policy from touching their CPU or memory pinning.
+
+```yaml
+cpu.preserve.resource-policy.nri.io/container.CONTAINER_NAME: "true"
+cpu.preserve.resource-policy.nri.io/pod: "true"
+cpu.preserve.resource-policy.nri.io: "true"
+
+memory.preserve.resource-policy.nri.io/container.CONTAINER_NAME: "true"
+memory.preserve.resource-policy.nri.io/pod: "true"
+memory.preserve.resource-policy.nri.io: "true"
+```
+
 ## Cold Start
 
 The `topology-aware` policy supports "cold start" functionality. When cold start

diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.3.1-63-g5085371',
+    VERSION: 'v0.3.1-64-g42457cf',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/devel/deployment/operator/README.html b/devel/deployment/operator/README.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>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/contributing.html b/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 v0.3.1-63-g5085371 documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/deployment/helm/balloons.html b/devel/docs/deployment/helm/balloons.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>Balloons Policy Plugin &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>
@@ -224,7 +224,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>metrics port to expose on the host</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">config</span></code></p></td>
-<td><p>see <a class="reference external" href="https://github.com/containers/nri-plugins/tree/5085371877dabfd2e422cb321e3506b76b7dec64/deployment/helm/balloons/values.yaml">helm chart values</a> for the default configuration</p></td>
+<td><p>see <a class="reference external" href="https://github.com/containers/nri-plugins/tree/42457cfedb7cfd89d258ac85698053734ad83195/deployment/helm/balloons/values.yaml">helm chart values</a> for the default configuration</p></td>
 <td><p>plugin configuration data</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">configGroupLabel</span></code></p></td>

diff --git a/devel/docs/deployment/helm/index.html b/devel/docs/deployment/helm/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>Helm &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/deployment/helm/memory-qos.html b/devel/docs/deployment/helm/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 Plugin &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/deployment/helm/memtierd.html b/devel/docs/deployment/helm/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 Plugin &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/deployment/helm/sgx-epc.html b/devel/docs/deployment/helm/sgx-epc.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>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/deployment/helm/template.html b/devel/docs/deployment/helm/template.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>Template Policy Plugin &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>
@@ -224,7 +224,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>metrics port to expose on the host</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">config</span></code></p></td>
-<td><p>see <a class="reference external" href="https://github.com/containers/nri-plugins/tree/5085371877dabfd2e422cb321e3506b76b7dec64/deployment/helm/template/values.yaml">helm chart values</a> for the default configuration</p></td>
+<td><p>see <a class="reference external" href="https://github.com/containers/nri-plugins/tree/42457cfedb7cfd89d258ac85698053734ad83195/deployment/helm/template/values.yaml">helm chart values</a> for the default configuration</p></td>
 <td><p>plugin configuration data</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">configGroupLabel</span></code></p></td>

diff --git a/devel/docs/deployment/helm/topology-aware.html b/devel/docs/deployment/helm/topology-aware.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>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>
@@ -225,7 +225,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>metrics port to expose on the host</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">config</span></code></p></td>
-<td><p>see <a class="reference external" href="https://github.com/containers/nri-plugins/tree/5085371877dabfd2e422cb321e3506b76b7dec64/deployment/helm/topology-aware/values.yaml">helm chart values</a> for the default configuration</p></td>
+<td><p>see <a class="reference external" href="https://github.com/containers/nri-plugins/tree/42457cfedb7cfd89d258ac85698053734ad83195/deployment/helm/topology-aware/values.yaml">helm chart values</a> for the default configuration</p></td>
 <td><p>plugin configuration data</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">configGroupLabel</span></code></p></td>

diff --git a/devel/docs/deployment/index.html b/devel/docs/deployment/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>Deployment &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Deployment &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/deployment/operator/index.html b/devel/docs/deployment/operator/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>Operator &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>Operator &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/deployment/operator/operator.html b/devel/docs/deployment/operator/operator.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>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/index.html b/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 v0.3.1-63-g5085371 documentation</title>
+  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/introduction.html b/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 v0.3.1-63-g5085371 documentation</title>
+  <title>Introduction &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/memory/index.html b/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 v0.3.1-63-g5085371 documentation</title>
+  <title>Memory plugins &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/memory/memory-qos.html b/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 v0.3.1-63-g5085371 documentation</title>
+  <title>Memory QoS NRI plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/memory/memtierd.html b/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 v0.3.1-63-g5085371 documentation</title>
+  <title>Memtierd NRI plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/memory/sgx-epc.html b/devel/docs/memory/sgx-epc.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>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-63-g5085371 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>

diff --git a/devel/docs/resource-policy/configuration.html b/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 v0.3.1-63-g5085371 documentation</title>
+  <title>Dynamic Configuration &mdash; NRI Plugins v0.3.1-64-g42457cf 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]>
@@ -106,7 +106,7 @@ <h1>Dynamic Configuration<a class="headerlink" href="#dynamic-configuration" tit
 <code class="docutils literal notranslate"><span class="pre">config.nri/group</span></code> label on the node to the name of the configuration
 group. You can remove a node from its group by deleting the node group
 label.</p>
-<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/5085371877dabfd2e422cb321e3506b76b7dec64/sample-configs/">sample configuration</a> custom resources that
+<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/42457cfedb7cfd89d258ac85698053734ad83195/sample-configs/">sample configuration</a> custom resources that
 contain contains a node-specific, a group-specific, and a default configuration.
 See <a class="reference internal" href="policy/index.html"><span class="std std-doc">any available policy-specific documentation</span></a>
 for more information on the policy configurations.</p>