Skip to content

Commit

Permalink
Update documentation for v0.3
Browse files Browse the repository at this point in the history
Auto-generated from v0.3.1-3-g7a0bf5e by 'update-gh-pages.sh'
  • Loading branch information
Github committed Dec 29, 2023
1 parent 84a9876 commit 6302be7
Show file tree
Hide file tree
Showing 36 changed files with 51 additions and 51 deletions.
2 changes: 1 addition & 1 deletion v0.3/.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: f7b27a05dc592576e0d90818d7dbd683
config: 8df1deff42f16e1c65af01cdf666b867
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion v0.3/_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.3.1',
VERSION: 'v0.3.1-3-g7a0bf5e',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion v0.3/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.3.1 documentation</title>
<title>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Contributing &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Balloons Policy Plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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 @@ -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/398fdf5ebe03c8a05a3f353520d1b6df353bf85a/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/7a0bf5e5f68b4359c9a8a6a4748faf63aa2518b5/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>
Expand Down
2 changes: 1 addition & 1 deletion v0.3/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.3.1 documentation</title>
<title>Helm &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Memory-QoS Plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Memtierd Plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Template Policy Plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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 @@ -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/398fdf5ebe03c8a05a3f353520d1b6df353bf85a/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/7a0bf5e5f68b4359c9a8a6a4748faf63aa2518b5/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>
Expand Down
4 changes: 2 additions & 2 deletions v0.3/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.3.1 documentation</title>
<title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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 @@ -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/398fdf5ebe03c8a05a3f353520d1b6df353bf85a/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/7a0bf5e5f68b4359c9a8a6a4748faf63aa2518b5/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>
Expand Down
2 changes: 1 addition & 1 deletion v0.3/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.3.1 documentation</title>
<title>Deployment &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Operator &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Introduction &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Memory plugins &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Memory QoS NRI plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Memtierd NRI plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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.3/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.3.1 documentation</title>
<title>Dynamic Configuration &mdash; NRI Plugins v0.3.1-3-g7a0bf5e 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">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/398fdf5ebe03c8a05a3f353520d1b6df353bf85a/sample-configs/">sample configuration</a> custom resources that
<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/7a0bf5e5f68b4359c9a8a6a4748faf63aa2518b5/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 6302be7

Please sign in to comment.