Update documentation for devel

Auto-generated from v0.7.1-134-g331b1ecb by 'update-gh-pages.sh'
containers · Dec 4, 2024 · a349547 · a349547
1 parent 2046231
commit a349547
Show file tree

Hide file tree

Showing 39 changed files with 110 additions and 90 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: 068f45b98e3eb6b06295c6837d0fa517
+config: ba85490df09414ec3afdf2bc80cb3207
 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
@@ -443,7 +443,7 @@ metadata:
     prefer-reserved-cpus.resource-policy.nri.io/container.special: "false"
 ```
 
-## Allowing or denying mount/device paths via annotations
+## Controlling Topology Hints Via Annotations
 
 User is able mark certain pods and containers to have allowed or denied
 paths for mounts or devices. What this means is that when the system
@@ -486,6 +486,16 @@ metadata:
         - /xy-zy/another-blacklisted-path5
 ```
 
+## Using Pod Resource API for Extra Topology Hints
+
+If access to the `kubelet`'s `Pod Resource API` is enabled in the
+[Node Agent's](../developers-guide/architecture.md#node-agent) configuration,
+it is automatically used to generate per-container topology hints when a
+device with locality to a NUMA node is advertised by the API. Annotated allow
+and deny lists can be used to selectively disable or enable per-resource hints,
+using `podresapi:$RESOURCE_NAME` as the path.
+
+
 ## Container Affinity and Anti-Affinity
 
 ### Introduction

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-130-gb412a058',
+    VERSION: 'v0.7.1-134-g331b1ecb',
     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-130-gb412a058 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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/b412a058bb6dc360ff6648c015c5f5519853168b/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/331b1ecba116206dd59ed36164a310425a327855/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-130-gb412a058 documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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/b412a058bb6dc360ff6648c015c5f5519853168b/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/331b1ecba116206dd59ed36164a310425a327855/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-130-gb412a058 documentation</title>
+  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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/b412a058bb6dc360ff6648c015c5f5519853168b/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/331b1ecba116206dd59ed36164a310425a327855/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-130-gb412a058 documentation</title>
+  <title>Deployment &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>Operator &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../../../_static/documentation_options.js?v=64c2410b"></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-130-gb412a058 documentation</title>
+  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../_static/documentation_options.js?v=64c2410b"></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/introduction.html b/devel/docs/introduction.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>Introduction &mdash; NRI Plugins v0.7.1-130-gb412a058 documentation</title>
+  <title>Introduction &mdash; NRI Plugins v0.7.1-134-g331b1ecb 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=23a049ed"></script>
+        <script src="../_static/documentation_options.js?v=64c2410b"></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>