Update documentation for devel

Auto-generated from v0.5.0-21-g49aad00e 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: cc58e19d597d096f57cfa7c34105c02c
+config: 35079265fc399ff736eac199dd8cdcdf
 tags: 645f666f9bcd5a90fca523b33c5a78b7

devel/_sources/deployment/operator/README.md.txt

@@ -40,12 +40,12 @@ spec:
   values:
     nri:
       plugin:
-        index: 90
+        index: 90                       # optional
       runtime:
-        patchConfig: true
-#       config:
-#         pluginRegistrationTimeout: 5s
-#         pluginRequestTimeout: 2s
+        patchConfig: true               # optional
+        config:                         # optional
+          pluginRegistrationTimeout: 5s
+          pluginRequestTimeout: 2s
     tolerations:
       - key: "node-role.kubernetes.io/control-plane"
         operator: "Exists"
@@ -71,5 +71,14 @@ spec:
 - `spec.state`: Determines whether to install (`present`) or uninstall (`absent`) the plugin.
 - `spec.values`: Allows users to provide custom values for manipulating Helm chart values. This field is immutable, 
   requiring users to recreate the object to pass new values.
+- `spec.values.nri.plugin.index`: A plugin index to register to NRI. The plugin index is used by NRI to determine in
+  which order the plugin is hooked into pod and container lifecycle event processing with respect to any other.
+- `spec.values.nri.runtime.patchConfig`: Enable/Disable NRI on the current runtime.
+- `spec.values.nri.runtime.config.pluginRegistrationTimeout`: Timeout for a plugin to register itself with NRI. Ensure
+  that both timeouts are either left unspecified or specified together, and `patchConfig` must be set to true to update
+  the timeouts. Timeouts will have no effect if `patchConfig` is set to false.
+- `spec.values.nri.runtime.config.pluginRequestTimeout`: Timeout for a plugin to handle an event/request. Timeout for
+  a plugin to register itself with NRI. Ensure that both timeouts are either left unspecified or specified together, and `patchConfig` must be set to true to update
+  the timeouts. Timeouts will have no effect if `patchConfig` is set to false.
 - `spec.status`: Tracks the basic state of the resource and includes basic messages in case the operator encounters 
   issues while reconciling the object.

devel/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.5.0-19-g72cefbcd',
+    VERSION: 'v0.5.0-21-g49aad00e',
     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.5.0-19-g72cefbcd documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.5.0-21-g49aad00e 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]>
@@ -117,12 +117,12 @@ <h2>Operator CRD<a class="headerlink" href="#operator-crd" title="Permalink to t
 <span class="w">  </span><span class="nt">values</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">nri</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">plugin</span><span class="p">:</span>
-<span class="w">        </span><span class="nt">index</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">90</span>
+<span class="w">        </span><span class="nt">index</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">90</span><span class="w">                       </span><span class="c1"># optional</span>
 <span class="w">      </span><span class="nt">runtime</span><span class="p">:</span>
-<span class="w">        </span><span class="nt">patchConfig</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<span class="c1">#       config:</span>
-<span class="c1">#         pluginRegistrationTimeout: 5s</span>
-<span class="c1">#         pluginRequestTimeout: 2s</span>
+<span class="w">        </span><span class="nt">patchConfig</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">               </span><span class="c1"># optional</span>
+<span class="w">        </span><span class="nt">config</span><span class="p">:</span><span class="w">                         </span><span class="c1"># optional</span>
+<span class="w">          </span><span class="nt">pluginRegistrationTimeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5s</span>
+<span class="w">          </span><span class="nt">pluginRequestTimeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2s</span>
 <span class="w">    </span><span class="nt">tolerations</span><span class="p">:</span>
 <span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;node-role.kubernetes.io/control-plane&quot;</span>
 <span class="w">        </span><span class="nt">operator</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Exists&quot;</span>
@@ -149,6 +149,15 @@ <h2>Operator CRD<a class="headerlink" href="#operator-crd" title="Permalink to t
 <li><p><code class="docutils literal notranslate"><span class="pre">spec.state</span></code>: Determines whether to install (<code class="docutils literal notranslate"><span class="pre">present</span></code>) or uninstall (<code class="docutils literal notranslate"><span class="pre">absent</span></code>) the plugin.</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">spec.values</span></code>: Allows users to provide custom values for manipulating Helm chart values. This field is immutable,
 requiring users to recreate the object to pass new values.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">spec.values.nri.plugin.index</span></code>: A plugin index to register to NRI. The plugin index is used by NRI to determine in
+which order the plugin is hooked into pod and container lifecycle event processing with respect to any other.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">spec.values.nri.runtime.patchConfig</span></code>: Enable/Disable NRI on the current runtime.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">spec.values.nri.runtime.config.pluginRegistrationTimeout</span></code>: Timeout for a plugin to register itself with NRI. Ensure
+that both timeouts are either left unspecified or specified together, and <code class="docutils literal notranslate"><span class="pre">patchConfig</span></code> must be set to true to update
+the timeouts. Timeouts will have no effect if <code class="docutils literal notranslate"><span class="pre">patchConfig</span></code> is set to false.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">spec.values.nri.runtime.config.pluginRequestTimeout</span></code>: Timeout for a plugin to handle an event/request. Timeout for
+a plugin to register itself with NRI. Ensure that both timeouts are either left unspecified or specified together, and <code class="docutils literal notranslate"><span class="pre">patchConfig</span></code> must be set to true to update
+the timeouts. Timeouts will have no effect if <code class="docutils literal notranslate"><span class="pre">patchConfig</span></code> is set to false.</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">spec.status</span></code>: Tracks the basic state of the resource and includes basic messages in case the operator encounters
 issues while reconciling the object.</p></li>
 </ul>

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.5.0-19-g72cefbcd documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.5.0-21-g49aad00e 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.5.0-19-g72cefbcd documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.5.0-21-g49aad00e 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/72cefbcd0dd2d6963b293fa393e3e8fadb9c1a7f/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/49aad00eb72b2f79c4d8f97273f4eb0a1a5cd7b3/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>

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.5.0-19-g72cefbcd documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.5.0-21-g49aad00e 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.5.0-19-g72cefbcd documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.5.0-21-g49aad00e 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.5.0-19-g72cefbcd documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.5.0-21-g49aad00e 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.5.0-19-g72cefbcd documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.5.0-21-g49aad00e 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.5.0-19-g72cefbcd documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.5.0-21-g49aad00e 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/72cefbcd0dd2d6963b293fa393e3e8fadb9c1a7f/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/49aad00eb72b2f79c4d8f97273f4eb0a1a5cd7b3/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>

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.5.0-19-g72cefbcd documentation</title>
+  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.5.0-21-g49aad00e 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/72cefbcd0dd2d6963b293fa393e3e8fadb9c1a7f/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/49aad00eb72b2f79c4d8f97273f4eb0a1a5cd7b3/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>

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.5.0-19-g72cefbcd documentation</title>
+  <title>Deployment &mdash; NRI Plugins v0.5.0-21-g49aad00e 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/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.5.0-19-g72cefbcd documentation</title>
+  <title>Operator &mdash; NRI Plugins v0.5.0-21-g49aad00e 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]>