Update documentation for devel

Auto-generated from v0.7.1-78-ga6de9ed5 by 'update-gh-pages.sh'
containers · Nov 8, 2024 · 39997fe · 39997fe
1 parent d36b46d
commit 39997fe
Show file tree

Hide file tree

Showing 39 changed files with 109 additions and 55 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: f7168aaa4bd8023aa82aff76bc0706dc
+config: dcd93af737a1d5a4469aef4782121b44
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/devel/_sources/docs/resource-policy/policy/balloons.md.txt b/devel/_sources/docs/resource-policy/policy/balloons.md.txt
@@ -174,6 +174,10 @@ 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.
+  - `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.
   - `preferCloseToDevices`: prefer creating new balloons close to
     listed devices. List of strings
   - `preferCoreType`:  specifies preferences of the core type which
@@ -329,7 +333,9 @@ assigned to the `default` balloon type. Parameters for this balloon
 type can be defined explicitly among other balloon types. If they are
 not defined, a built-in `default` balloon type is used.
 
-## Disabling CPU or Memory Pinning of a Container
+## Pod and Container Overrides to CPU and Memory Pinning
+
+### Disabling CPU or Memory Pinning of a Container
 
 Some containers may need to run on all CPUs or access all memories
 without restrictions. There are two alternatives to achieve this:
@@ -375,6 +381,28 @@ The `hide-hyperthreads` pod annotation overrides the
 `hideHyperthreads` balloon type parameter value for selected
 containers in the pod.
 
+### Memory Type
+
+If a container must be pinned to specific memory types that may differ
+from its balloon's `memoryTypes`, container-specific types can be
+given in the `memory-type` pod annotations:
+
+```yaml
+memory-type.resource-policy.nri.io/container.CONTAINER_NAME: <COMMA-SEPARATED-TYPES>
+memory-type.resource-policy.nri.io/pod: <COMMA-SEPARATED-TYPES>
+memory-type.resource-policy.nri.io: <COMMA-SEPARATED-TYPES>
+```
+
+The first sets the memory type for a single container in the pod, the
+latter two for other containers in the pod. Supported types are "HBM",
+"DRAM" and "PMEM". Example:
+
+```yaml
+metadata:
+  annotations:
+    memory-type.resource-policy.nri.io/container.LLM: HBM,DRAM
+```
+
 ## Metrics and Debugging
 
 In order to enable more verbose logging and metrics exporting from the

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.7.1-73-g6ec261f8',
+    VERSION: 'v0.7.1-78-ga6de9ed5',
     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.7.1-73-g6ec261f8 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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-odd"><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/6ec261f8fd828a69c13fef1affec619b37e79ecc/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/a6de9ed5011d45ffd715a7bca6c023d12e5c3a83/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-even"><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.7.1-73-g6ec261f8 documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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-odd"><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/6ec261f8fd828a69c13fef1affec619b37e79ecc/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/a6de9ed5011d45ffd715a7bca6c023d12e5c3a83/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-even"><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.7.1-73-g6ec261f8 documentation</title>
+  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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]>
@@ -226,7 +226,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-odd"><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/6ec261f8fd828a69c13fef1affec619b37e79ecc/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/a6de9ed5011d45ffd715a7bca6c023d12e5c3a83/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-even"><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.7.1-73-g6ec261f8 documentation</title>
+  <title>Deployment &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Operator &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Introduction &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Memory plugins &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Memory QoS NRI plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Memtierd NRI plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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.7.1-73-g6ec261f8 documentation</title>
+  <title>Dynamic Configuration &mdash; NRI Plugins v0.7.1-78-ga6de9ed5 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/6ec261f8fd828a69c13fef1affec619b37e79ecc/sample-configs/">sample configuration</a> custom resources that
+<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/a6de9ed5011d45ffd715a7bca6c023d12e5c3a83/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>