Skip to content

Commit

Permalink
Update documentation for v0.5
Browse files Browse the repository at this point in the history
Auto-generated from v0.5.1-5-g1297d0c9 by 'update-gh-pages.sh'
  • Loading branch information
Github committed Apr 9, 2024
1 parent 349c0cf commit 13dbbf3
Show file tree
Hide file tree
Showing 36 changed files with 57 additions and 57 deletions.
2 changes: 1 addition & 1 deletion v0.5/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: ddbfa848e5ff51ab9b0b0ef806bb014e
config: ecc9c76d66212ce6e3e62b3ce5d31761
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion v0.5/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: 'v0.5.1-3-g94253c8d',
VERSION: 'v0.5.1-5-g1297d0c9',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion v0.5/deployment/operator/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>NRI-Plugins-Operator &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Contributing &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
6 changes: 3 additions & 3 deletions v0.5/docs/deployment/helm/balloons.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Balloons Policy Plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down Expand Up @@ -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/94253c8d5b47382ca57174b1dc57ae3c426738b0/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/1297d0c91912888762b1ea96c041b8f7551ec04b/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>
Expand Down Expand Up @@ -262,7 +262,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
<td><p>specify node selector labels</p></td>
</tr>
<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>true</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>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/deployment/helm/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Helm &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
4 changes: 2 additions & 2 deletions v0.5/docs/deployment/helm/memory-qos.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Memory-QoS Plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down Expand Up @@ -246,7 +246,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
<td><p>specify node selector labels</p></td>
</tr>
<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>true</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>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions v0.5/docs/deployment/helm/memtierd.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Memtierd Plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down Expand Up @@ -249,7 +249,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
<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>
<td><p>false</p></td>
<td><p>true</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>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions v0.5/docs/deployment/helm/sgx-epc.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down Expand Up @@ -246,7 +246,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
<td><p>specify node selector labels</p></td>
</tr>
<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>true</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>
</tbody>
Expand Down
6 changes: 3 additions & 3 deletions v0.5/docs/deployment/helm/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Template Policy Plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down Expand Up @@ -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/94253c8d5b47382ca57174b1dc57ae3c426738b0/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/1297d0c91912888762b1ea96c041b8f7551ec04b/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>
Expand Down Expand Up @@ -254,7 +254,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
<td><p>specify taint toleration key, operator and effect</p></td>
</tr>
<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>true</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>
</tbody>
Expand Down
6 changes: 3 additions & 3 deletions v0.5/docs/deployment/helm/topology-aware.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down Expand Up @@ -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/94253c8d5b47382ca57174b1dc57ae3c426738b0/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/1297d0c91912888762b1ea96c041b8f7551ec04b/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>
Expand Down Expand Up @@ -263,7 +263,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
<td><p>specify node selector labels</p></td>
</tr>
<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>true</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>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/deployment/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Deployment &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/deployment/operator/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>Operator &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/deployment/operator/operator.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>NRI-Plugins-Operator &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.1-3-g94253c8d documentation</title>
<title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.1-3-g94253c8d documentation</title>
<title>Introduction &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/memory/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.1-3-g94253c8d documentation</title>
<title>Memory plugins &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/memory/memory-qos.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.1-3-g94253c8d documentation</title>
<title>Memory QoS NRI plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/memory/memtierd.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.1-3-g94253c8d documentation</title>
<title>Memtierd NRI plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
2 changes: 1 addition & 1 deletion v0.5/docs/memory/sgx-epc.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.1-3-g94253c8d documentation</title>
<title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down
4 changes: 2 additions & 2 deletions v0.5/docs/resource-policy/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.1-3-g94253c8d documentation</title>
<title>Dynamic Configuration &mdash; NRI Plugins v0.5.1-5-g1297d0c9 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]>
Expand Down Expand Up @@ -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/94253c8d5b47382ca57174b1dc57ae3c426738b0/sample-configs/">sample configuration</a> custom resources that
<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/1297d0c91912888762b1ea96c041b8f7551ec04b/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>
Expand Down
Loading

0 comments on commit 13dbbf3

Please sign in to comment.