Update documentation for devel

Auto-generated from v0.7.1-168-g109d59c0 by 'update-gh-pages.sh'
containers · Dec 17, 2024 · 1590f4a · 1590f4a
1 parent 7bcf1fa
commit 1590f4a
Show file tree

Hide file tree

Showing 38 changed files with 103 additions and 95 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: 0f8f827851a4b37c6c465b16a57ae47e
+config: 0409fecf37ad0d1c7d40e0ad6b7031ba
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/devel/_sources/docs/resource-policy/policy/balloons.md.txt b/devel/_sources/docs/resource-policy/policy/balloons.md.txt
@@ -78,10 +78,11 @@ Balloons policy parameters:
   default is `true`: the container cannot use other CPUs.
 - `pinMemory` controls pinning a container to the memories that are
   closest to the CPUs of its balloon. The default is `true`: allow
-  using memory only from the closest NUMA nodes. Warning: this may
-  cause kernel to kill containers due to out-of-memory error when
-  closest NUMA nodes do not have enough memory. In this situation
-  consider switching this option `false`.
+  using memory only from the closest NUMA nodes. Can be overridden by
+  pinMemory in balloon types. Warning: pinning memory may cause kernel
+  to kill containers due to out-of-memory error when allowed NUMA
+  nodes do not have enough memory. In this situation consider
+  switching this option `false`.
 - `preserve` specifies containers whose resource pinning must not be
   modified by the policy.
   - `matchExpressions` if a container matches an expression in this
@@ -174,10 +175,13 @@ Balloons policy parameters:
   - `cpuClass` specifies the name of the CPU class according to which
     CPUs of balloons are configured. Class properties are defined in
     separate `cpu.classes` objects, see below.
+  - `pinMemory` overrides policy-level `pinMemory` in balloons of this
+    type.
   - `memoryTypes` is a list of allowed memory types for containers in
     a balloon. Supported types are "HBM", "DRAM" and "PMEM". This
     setting can be overridden by a pod/container specific
-    `memory-type` annotation.
+    `memory-type` annotation. Memory types have no when not pinning
+    memory (see `pinMemory`).
   - `preferCloseToDevices`: prefer creating new balloons close to
     listed devices. List of strings
   - `preferCoreType`:  specifies preferences of the core type which

diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'v0.7.1-164-g85025a85',
+    VERSION: 'v0.7.1-168-g109d59c0',
     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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>

diff --git a/devel/docs/contributing.html b/devel/docs/contributing.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
@@ -222,7 +222,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>extra environment variables to inject (string map)</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/85025a85826de3a3ce544c8cb46f6d4d426d3e2a/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/109d59c0f3604dec47da5e3559330bf062cc271d/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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Helm &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>

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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>

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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Memtierd Plugin &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>

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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>

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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Template Policy Plugin &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
@@ -222,7 +222,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>extra environment variables to inject (string map)</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/85025a85826de3a3ce544c8cb46f6d4d426d3e2a/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/109d59c0f3604dec47da5e3559330bf062cc271d/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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
@@ -223,7 +223,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>extra environment variables to inject (string map)</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/85025a85826de3a3ce544c8cb46f6d4d426d3e2a/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/109d59c0f3604dec47da5e3559330bf062cc271d/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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Deployment &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Deployment &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>

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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Operator &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Operator &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>

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="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../../../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>

diff --git a/devel/docs/index.html b/devel/docs/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.7.1-164-g85025a85 documentation</title>
+  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.7.1-168-g109d59c0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../_static/documentation_options.js?v=0dfdadfc"></script>
+        <script src="../_static/documentation_options.js?v=0bd0c60a"></script>
         <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>