Update documentation for devel

Auto-generated from v0.1.0-202-g0241c49 by 'update-gh-pages.sh'
containers · Dec 22, 2023 · d9f0f69 · d9f0f69
1 parent da9ad37
commit d9f0f69
Show file tree

Hide file tree

Showing 40 changed files with 99 additions and 56 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: 46a2f2240cb6c767e57cce28a8aca501
+config: c09cb067f8c2b4b02786117795aaec61
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/devel/_sources/docs/deployment/helm/index.md.txt b/devel/_sources/docs/deployment/helm/index.md.txt
@@ -1,5 +1,24 @@
 # Helm
 
+All the available charts can be found in [artifacthub.io](https://artifacthub.io/packages/search?ts_query_web=nri&verified_publisher=true&official=true&sort=relevance&page=1).
+
+**NOTE:** NRI-plugins Helm installation has been successfully verified in both local clusters and major Cloud Providers' managed clusters, including:
+
+   -  AWS EKS
+        - kubernetes version: 1.28.x
+        - containerd version: 1.7
+        - node image: Amazon Linux 2, Ubuntu 20.04, 
+   - Google GKE
+        - kubernetes version: 1.28.x
+        - containerd version: 1.7
+        - node image: Container-Optimized OS from Google (COS), Ubuntu 22.04 
+   -  Azure AKS
+        - kubernetes version: 1.28.x
+        - containerd version: 1.7
+        - node image: Azure Linux Container Host, Ubuntu 20.04
+
+While Ubuntu 20.04/22.04 was used across all three CSP environments, it's worth noting that node images are not limited to Ubuntu 20.04/22.04 only. The majority of widely recognized Linux distributions should be suitable for use.
+
 ```{toctree}
 ---
 maxdepth: 2

diff --git a/devel/_sources/docs/deployment/index.md.txt b/devel/_sources/docs/deployment/index.md.txt
@@ -1,7 +1,6 @@
 # Deployment
 
-The only supported installation method of the NRI plugins at the moment is
-through Helm.
+Currently supported installation methods of the NRI plugins are Helm and Operator.
 
 ```{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.1.0-201-g61b0d6d',
+    VERSION: 'v0.1.0-202-g0241c49',
     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.1.0-201-g61b0d6d documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Contributing &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Balloons Policy Plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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]>
@@ -224,7 +224,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-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/61b0d6db7aea01bbd29dfd8b86cf88ca59ce76c1/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/0241c4998c3dce5f85a109519f7e26b95de14219/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">nri.patchRuntimeConfig</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.1.0-201-g61b0d6d documentation</title>
+  <title>Helm &mdash; NRI Plugins v0.1.0-202-g0241c49 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]>
@@ -95,6 +95,32 @@
 
   <section id="helm">
 <h1>Helm<a class="headerlink" href="#helm" title="Permalink to this heading"></a></h1>
+<p>All the available charts can be found in <a class="reference external" href="https://artifacthub.io/packages/search?ts_query_web=nri&amp;amp;verified_publisher=true&amp;amp;official=true&amp;amp;sort=relevance&amp;amp;page=1">artifacthub.io</a>.</p>
+<p><strong>NOTE:</strong> NRI-plugins Helm installation has been successfully verified in both local clusters and major Cloud Providers’ managed clusters, including:</p>
+<ul class="simple">
+<li><p>AWS EKS</p>
+<ul>
+<li><p>kubernetes version: 1.28.x</p></li>
+<li><p>containerd version: 1.7</p></li>
+<li><p>node image: Amazon Linux 2, Ubuntu 20.04,</p></li>
+</ul>
+</li>
+<li><p>Google GKE</p>
+<ul>
+<li><p>kubernetes version: 1.28.x</p></li>
+<li><p>containerd version: 1.7</p></li>
+<li><p>node image: Container-Optimized OS from Google (COS), Ubuntu 22.04</p></li>
+</ul>
+</li>
+<li><p>Azure AKS</p>
+<ul>
+<li><p>kubernetes version: 1.28.x</p></li>
+<li><p>containerd version: 1.7</p></li>
+<li><p>node image: Azure Linux Container Host, Ubuntu 20.04</p></li>
+</ul>
+</li>
+</ul>
+<p>While Ubuntu 20.04/22.04 was used across all three CSP environments, it’s worth noting that node images are not limited to Ubuntu 20.04/22.04 only. The majority of widely recognized Linux distributions should be suitable for use.</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.1.0-201-g61b0d6d documentation</title>
+  <title>Memory-QoS Plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Memtierd Plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Template Policy Plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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]>
@@ -224,7 +224,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-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/61b0d6db7aea01bbd29dfd8b86cf88ca59ce76c1/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/0241c4998c3dce5f85a109519f7e26b95de14219/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">nri.patchRuntimeConfig</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.1.0-201-g61b0d6d documentation</title>
+  <title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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-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/61b0d6db7aea01bbd29dfd8b86cf88ca59ce76c1/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/0241c4998c3dce5f85a109519f7e26b95de14219/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">nri.patchRuntimeConfig</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.1.0-201-g61b0d6d documentation</title>
+  <title>Deployment &mdash; NRI Plugins v0.1.0-202-g0241c49 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]>
@@ -86,8 +86,7 @@
 
   <section id="deployment">
 <h1>Deployment<a class="headerlink" href="#deployment" title="Permalink to this heading"></a></h1>
-<p>The only supported installation method of the NRI plugins at the moment is
-through Helm.</p>
+<p>Currently supported installation methods of the NRI plugins are Helm and Operator.</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/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.1.0-201-g61b0d6d documentation</title>
+  <title>Operator &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>NRI-Plugins-Operator &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Introduction &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Memory plugins &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Memory QoS NRI plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Memtierd NRI plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.1.0-202-g0241c49 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.1.0-201-g61b0d6d documentation</title>
+  <title>Dynamic Configuration &mdash; NRI Plugins v0.1.0-202-g0241c49 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">group.config.nri</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/61b0d6db7aea01bbd29dfd8b86cf88ca59ce76c1/sample-configs/">sample configuration</a> custom resources that
+<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/0241c4998c3dce5f85a109519f7e26b95de14219/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>