Update documentation for devel

Auto-generated from v0.4.0-31-g8e4c550 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: fc9df42858e89840f80dacc9e631ba72
+config: 3dc1f47fae4ff7e4d488a275d78d72ab
 tags: 645f666f9bcd5a90fca523b33c5a78b7

devel/_sources/docs/resource-policy/developers-guide/cpu-allocator.md.txt

@@ -17,7 +17,8 @@ The CPU allocator also does automatic CPU prioritization by detecting CPU
 features and their configuration parameters. Currently, NRI Resource Policy
 supports CPU priority detection based on the `intel_pstate` scaling
 driver in the Linux CPUFreq subsystem, and, Intel Speed Select Technology
-(SST).
+(SST), or based on the detected core types on hybrid CPU architecture
+systems.
 
 CPUs are divided into three priority classes, i.e. *high*, *normal* and *low*.
 Policies utilizing the CPU allocator may choose to prefer certain priority
@@ -59,3 +60,10 @@ correspondingly.
 
 CPU cores with high EPP priority (relative to the other cores in the system)
 will be marked as high priority cores.
+
+### Hybrid CPU Architecture
+
+On systems with a hybrid CPU architecture, where some cores are optimized for
+performance and others for power consumption, performance optimized cores are
+classified as high priority CPUs while energy efficient cores as low priority
+CPUs.

devel/_sources/docs/resource-policy/policy/topology-aware.md.txt

@@ -139,6 +139,12 @@ behavior. These options can be supplied as part of the effective
 - `colocateNamespaces`
   - whether try to allocate containers in a namespace to the same or close by
     topology pools
+- `defaultCPUPriority`
+  - is the default CPU prioritization, used when a container has not been
+    annotated with any other CPU preferences. The possible values are: `high`,
+    `normal`, `low`, and `none`. Currently this option only affects exclusive
+    CPU allocations. For a more detailed discussion of CPU prioritization see
+    the [cpu allocator](../developers-guide/cpu-allocator.md) documentation.
 
 ## Policy CPU Allocation Preferences
 
@@ -225,7 +231,7 @@ preferences the policy would otherwise apply to them. These Pod annotations
 can be given both with per pod and per container resolution. If for any
 container both of these exist, the container-specific one takes precedence.
 
-### Shared, Exclusive, and Isolated CPU Preference
+### Shared, Exclusive, and Isolated CPU Preference, CPU Priorities
 
 A container can opt in to or opt out from shared CPU allocation using the
 following Pod annotation.
@@ -239,6 +245,9 @@ metadata:
     prefer-shared-cpus.resource-policy.nri.io/pod: "true"
     # selectively opt out container C2 from shared CPU core allocation
     prefer-shared-cpus.resource-policy.nri.io/container.C2: "false"
+    # prefer low-prio CPUs for all others except the 'pump' container
+    prefer-cpu-priority.resource-policy.nri.io/pod: low
+    prefer-cpu-priority.resource-policy.nri.io/container.pump: high
 ```
 
 Opting in to exclusive allocation happens by opting out from shared allocation,

devel/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.4.0-24-g1144de7',
+    VERSION: 'v0.4.0-31-g8e4c550',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

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.4.0-24-g1144de7 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.4.0-31-g8e4c550 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/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.4.0-24-g1144de7 documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.4.0-31-g8e4c550 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/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.4.0-24-g1144de7 documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.4.0-31-g8e4c550 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]>
@@ -219,51 +219,55 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>512Mi</p></td>
 <td><p>memory qouta for the Pod</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">hostPort</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">extraEnv</span></code></p></td>
+<td><p>{}</p></td>
+<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">hostPort</span></code></p></td>
 <td><p>8891</p></td>
 <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/1144de7fce00a7b5e4bafc131eb18e76683ac8a4/deployment/helm/balloons/values.yaml">helm chart values</a> for the default configuration</p></td>
+<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/8e4c5509a633fc4c3f61e8e90a6ecf2663e48ff6/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>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">configGroupLabel</span></code></p></td>
 <td><p>config.nri/group</p></td>
 <td><p>node label for grouping configuration</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">nri.patchRuntimeConfig</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">nri.patchRuntimeConfig</span></code></p></td>
 <td><p>false</p></td>
 <td><p>enable NRI in containerd or CRI-O</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">nri.pluginIndex</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">nri.pluginIndex</span></code></p></td>
 <td><p>90</p></td>
 <td><p>NRI plugin index to register with</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.name</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.name</span></code></p></td>
 <td><p><a class="reference external" href="https://ghcr.io/containers/nri-plugins/config-manager">ghcr.io/containers/nri-plugins/config-manager</a></p></td>
 <td><p>init container image name</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.tag</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.tag</span></code></p></td>
 <td><p>unstable</p></td>
 <td><p>init container image tag</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.pullPolicy</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.pullPolicy</span></code></p></td>
 <td><p>Always</p></td>
 <td><p>init container image pull policy</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">tolerations</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">tolerations</span></code></p></td>
 <td><p>[]</p></td>
 <td><p>specify taint toleration key, operator and effect</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">affinity</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">affinity</span></code></p></td>
 <td><p>[]</p></td>
 <td><p>specify node affinity</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">nodeSelector</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">nodeSelector</span></code></p></td>
 <td><p>[]</p></td>
 <td><p>specify node selector labels</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">podPriorityClassNodeCritical</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">podPriorityClassNodeCritical</span></code></p></td>
 <td><p>false</p></td>
 <td><p>enable <a class="reference external" href="https://kubernetes.io/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods/#marking-pod-as-critical">marking Pod as node critical</a></p></td>
 </tr>

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.4.0-24-g1144de7 documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.4.0-31-g8e4c550 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/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.4.0-24-g1144de7 documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.4.0-31-g8e4c550 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/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.4.0-24-g1144de7 documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.4.0-31-g8e4c550 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/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.4.0-24-g1144de7 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.4.0-31-g8e4c550 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/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.4.0-24-g1144de7 documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.4.0-31-g8e4c550 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]>
@@ -219,43 +219,47 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
 <td><p>512Mi</p></td>
 <td><p>memory qouta for the Pod</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">hostPort</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">extraEnv</span></code></p></td>
+<td><p>{}</p></td>
+<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">hostPort</span></code></p></td>
 <td><p>8891</p></td>
 <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/1144de7fce00a7b5e4bafc131eb18e76683ac8a4/deployment/helm/template/values.yaml">helm chart values</a> for the default configuration</p></td>
+<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/8e4c5509a633fc4c3f61e8e90a6ecf2663e48ff6/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>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">configGroupLabel</span></code></p></td>
 <td><p>config.nri/group</p></td>
 <td><p>node label for grouping configuration</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">nri.patchRuntimeConfig</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">nri.patchRuntimeConfig</span></code></p></td>
 <td><p>false</p></td>
 <td><p>enable NRI in containerd or CRI-O</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">nri.pluginIndex</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">nri.pluginIndex</span></code></p></td>
 <td><p>90</p></td>
 <td><p>NRI plugin index to register with</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.name</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.name</span></code></p></td>
 <td><p><a class="reference external" href="https://ghcr.io/containers/nri-plugins/config-manager">ghcr.io/containers/nri-plugins/config-manager</a></p></td>
 <td><p>init container image name</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.tag</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.tag</span></code></p></td>
 <td><p>unstable</p></td>
 <td><p>init container image tag</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.pullPolicy</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">initImage.pullPolicy</span></code></p></td>
 <td><p>Always</p></td>
 <td><p>init container image pull policy</p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">tolerations</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">tolerations</span></code></p></td>
 <td><p>[]</p></td>
 <td><p>specify taint toleration key, operator and effect</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">podPriorityClassNodeCritical</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">podPriorityClassNodeCritical</span></code></p></td>
 <td><p>false</p></td>
 <td><p>enable <a class="reference external" href="https://kubernetes.io/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods/#marking-pod-as-critical">marking Pod as node critical</a></p></td>
 </tr>