Skip to content

Commit

Permalink
Update documentation for devel
Browse files Browse the repository at this point in the history
Auto-generated from v0.3.1-62-g516da7f by 'update-gh-pages.sh'
  • Loading branch information
Github committed Feb 14, 2024
1 parent a22a7b7 commit 0c454c6
Show file tree
Hide file tree
Showing 39 changed files with 70 additions and 52 deletions.
2 changes: 1 addition & 1 deletion devel/.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: fb66da901886a0c7e4177448a3f943ff
config: 28b526d6c0e92c3f3791b5efb1bcb423
tags: 645f666f9bcd5a90fca523b33c5a78b7
9 changes: 9 additions & 0 deletions devel/_sources/docs/resource-policy/policy/balloons.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,15 @@ Balloons policy parameters:
- `namespaces` is a list of namespaces (wildcards allowed) whose
pods should be assigned to this balloon type, unless overridden by
pod annotations.
- `matchExpressions` is a list of container match expressions. These
expressions are evaluated for all containers which have not been
assigned otherwise to other balloons. If an expression matches,
IOW it evaluates to true, the container gets assigned to this
balloon type. Container mach expressions have the same syntax and
semantics as the scope and match expressions in container affinity
annotations for the topology-aware policy.
See the [affinity documentation](./topology-aware.md#affinity-semantics)
for a detailed description of expressions.
- `minBalloons` is the minimum number of balloons of this type that
is always present, even if the balloons would not have any
containers. The default is 0: if a balloon has no containers, it
Expand Down
2 changes: 1 addition & 1 deletion devel/_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-57-gfda3d80',
VERSION: 'v0.3.1-62-g516da7f',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion devel/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-57-gfda3d80 documentation</title>
<title>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Contributing &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Balloons Policy Plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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/fda3d80de2b1f98dfd23d036845c014dea046492/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/516da7f5a17388d030bdca57a6d129a6d97bbcb5/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">configGroupLabel</span></code></p></td>
Expand Down
2 changes: 1 addition & 1 deletion devel/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-57-gfda3d80 documentation</title>
<title>Helm &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Memory-QoS Plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Memtierd Plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Template Policy Plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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/fda3d80de2b1f98dfd23d036845c014dea046492/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/516da7f5a17388d030bdca57a6d129a6d97bbcb5/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">configGroupLabel</span></code></p></td>
Expand Down
4 changes: 2 additions & 2 deletions devel/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-57-gfda3d80 documentation</title>
<title>Topology-Aware Policy Plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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/fda3d80de2b1f98dfd23d036845c014dea046492/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/516da7f5a17388d030bdca57a6d129a6d97bbcb5/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">configGroupLabel</span></code></p></td>
Expand Down
2 changes: 1 addition & 1 deletion devel/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-57-gfda3d80 documentation</title>
<title>Deployment &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Operator &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>NRI-Plugins-Operator &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Introduction &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Memory plugins &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Memory QoS NRI plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Memtierd NRI plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>SGX EPC Limit Plugin &mdash; NRI Plugins v0.3.1-62-g516da7f 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 devel/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-57-gfda3d80 documentation</title>
<title>Dynamic Configuration &mdash; NRI Plugins v0.3.1-62-g516da7f 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/fda3d80de2b1f98dfd23d036845c014dea046492/sample-configs/">sample configuration</a> custom resources that
<p>There are <a class="reference external" href="https://github.com/containers/nri-plugins/tree/516da7f5a17388d030bdca57a6d129a6d97bbcb5/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 0c454c6

Please sign in to comment.