Update documentation for devel

Auto-generated from v0.4.0-36-g07d6d46 by 'update-gh-pages.sh'
containers · Mar 28, 2024 · 3628ab9 · 3628ab9
1 parent a045b21
commit 3628ab9
Show file tree

Hide file tree

Showing 39 changed files with 58 additions and 58 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: 2a2daaa406a8251ab2c637246162ac45
+config: e138d55edd77c7d10528d754467d254d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/devel/_sources/docs/deployment/helm/index.md.txt b/devel/_sources/docs/deployment/helm/index.md.txt
@@ -32,14 +32,14 @@ are stored alongside plugin images in the OCI image registry.
 Unstable charts can be discovered using [skopeo](https://github.com/containers/skopeo).
 For instance, one can list the available charts for the balloons plugin using this
 skopeo command:
-`skopeo list-tags docker://ghcr.io/containers/nri-plugins/nri-resource-policy-balloons`
+`skopeo list-tags docker://ghcr.io/containers/nri-plugins/helm-charts/nri-resource-policy-balloons`
 
 ### Using Unstable Helm Charts
 
 Once discovered, unstable Helm charts can be used like any other. For instance, to use
-the `$X.$Y-unstable` version of the chart to install the development version of the
+the `v$X.$Y-unstable` version of the chart to install the development version of the
 balloons plugin one can use this command:
-`helm install --devel -n kube-system test oci://ghcr.io/containers/nri-plugins/nri-resource-policy-balloons --version $X.$Y-unstable --set image.tag=unstable --set image.pullPolicy=Always`
+`helm install --devel -n kube-system test oci://ghcr.io/containers/nri-plugins/helm-charts/nri-resource-policy-balloons --version v$X.$Y-unstable --set image.tag=unstable --set image.pullPolicy=Always`
 
 ```{toctree}
 ---

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.4.0-34-g1a3bf05',
+    VERSION: 'v0.4.0-36-g07d6d46',
     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.4.0-34-g1a3bf05 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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]>
@@ -222,7 +222,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/1a3bf05f0e4234dd9c1437cd279b93ee5edda8e6/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/07d6d46d0a1ec818faecf21301298f7a2bfc720a/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.4.0-34-g1a3bf05 documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.4.0-36-g07d6d46 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]>
@@ -134,14 +134,14 @@ <h3>Discovering Unstable Helm Charts<a class="headerlink" href="#discovering-uns
 <p>Unstable charts can be discovered using <a class="reference external" href="https://github.com/containers/skopeo">skopeo</a>.
 For instance, one can list the available charts for the balloons plugin using this
 skopeo command:
-<code class="docutils literal notranslate"><span class="pre">skopeo</span> <span class="pre">list-tags</span> <span class="pre">docker://ghcr.io/containers/nri-plugins/nri-resource-policy-balloons</span></code></p>
+<code class="docutils literal notranslate"><span class="pre">skopeo</span> <span class="pre">list-tags</span> <span class="pre">docker://ghcr.io/containers/nri-plugins/helm-charts/nri-resource-policy-balloons</span></code></p>
 </section>
 <section id="using-unstable-helm-charts">
 <h3>Using Unstable Helm Charts<a class="headerlink" href="#using-unstable-helm-charts" title="Permalink to this heading"></a></h3>
 <p>Once discovered, unstable Helm charts can be used like any other. For instance, to use
-the <code class="docutils literal notranslate"><span class="pre">$X.$Y-unstable</span></code> version of the chart to install the development version of the
+the <code class="docutils literal notranslate"><span class="pre">v$X.$Y-unstable</span></code> version of the chart to install the development version of the
 balloons plugin one can use this command:
-<code class="docutils literal notranslate"><span class="pre">helm</span> <span class="pre">install</span> <span class="pre">--devel</span> <span class="pre">-n</span> <span class="pre">kube-system</span> <span class="pre">test</span> <span class="pre">oci://ghcr.io/containers/nri-plugins/nri-resource-policy-balloons</span> <span class="pre">--version</span> <span class="pre">$X.$Y-unstable</span> <span class="pre">--set</span> <span class="pre">image.tag=unstable</span> <span class="pre">--set</span> <span class="pre">image.pullPolicy=Always</span></code></p>
+<code class="docutils literal notranslate"><span class="pre">helm</span> <span class="pre">install</span> <span class="pre">--devel</span> <span class="pre">-n</span> <span class="pre">kube-system</span> <span class="pre">test</span> <span class="pre">oci://ghcr.io/containers/nri-plugins/helm-charts/nri-resource-policy-balloons</span> <span class="pre">--version</span> <span class="pre">v$X.$Y-unstable</span> <span class="pre">--set</span> <span class="pre">image.tag=unstable</span> <span class="pre">--set</span> <span class="pre">image.pullPolicy=Always</span></code></p>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>

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.4.0-34-g1a3bf05 documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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]>
@@ -222,7 +222,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/1a3bf05f0e4234dd9c1437cd279b93ee5edda8e6/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/07d6d46d0a1ec818faecf21301298f7a2bfc720a/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.4.0-34-g1a3bf05 documentation</title>
+  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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]>
@@ -223,7 +223,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/1a3bf05f0e4234dd9c1437cd279b93ee5edda8e6/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/07d6d46d0a1ec818faecf21301298f7a2bfc720a/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.4.0-34-g1a3bf05 documentation</title>
+  <title>Deployment &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Operator &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Introduction &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Memory plugins &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Memory QoS NRI plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Memtierd NRI plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.4.0-36-g07d6d46 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.4.0-34-g1a3bf05 documentation</title>
+  <title>Dynamic Configuration &mdash; NRI Plugins v0.4.0-36-g07d6d46 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/1a3bf05f0e4234dd9c1437cd279b93ee5edda8e6/sample-configs/">sample configuration</a> custom resources that
+<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/07d6d46d0a1ec818faecf21301298f7a2bfc720a/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>