Skip to content

Commit

Permalink
Update documentation for v0.2
Browse files Browse the repository at this point in the history
Auto-generated from v0.2.1-11-g95e1402 by 'update-gh-pages.sh'
  • Loading branch information
Github committed Oct 25, 2023
1 parent 75d5f07 commit deb7580
Show file tree
Hide file tree
Showing 24 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion v0.2/.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: 2577ff869433f860fa12108aee55aae6
config: 247c0ef779baf29b2b41649ebb8b4138
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion v0.2/_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.2.1-9-g6c72153',
VERSION: 'v0.2.1-11-g95e1402',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
2 changes: 1 addition & 1 deletion v0.2/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.2.1-9-g6c72153 documentation</title>
<title>Contributing &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/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.2.1-9-g6c72153 documentation</title>
<title>Welcome to NRI Plugins documentation &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/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.2.1-9-g6c72153 documentation</title>
<title>Introduction &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/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.2.1-9-g6c72153 documentation</title>
<title>Memory plugins &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/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.2.1-9-g6c72153 documentation</title>
<title>Memory QoS NRI plugin &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/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.2.1-9-g6c72153 documentation</title>
<title>Memtierd NRI plugin &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/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.2.1-9-g6c72153 documentation</title>
<title>Dynamic Configuration &mdash; NRI Plugins v0.2.1-11-g95e1402 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
24 changes: 12 additions & 12 deletions v0.2/docs/resource-policy/developers-guide/architecture.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>Architecture &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Architecture &mdash; NRI Plugins v0.2.1-11-g95e1402 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 @@ -130,7 +130,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
<section id="components">
<h2>Components<a class="headerlink" href="#components" title="Permalink to this heading"></a></h2>
<section id="node-agent">
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/pkg/resmgr/agent">Node Agent</a><a class="headerlink" href="#node-agent" title="Permalink to this heading"></a></h3>
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/pkg/resmgr/agent">Node Agent</a><a class="headerlink" href="#node-agent" title="Permalink to this heading"></a></h3>
<p>The node agent is a component internal to NRI-RP itself. All interactions
by NRI-RP with the Kubernetes Control Plane go through the node agent with
the node agent performing any direct interactions on behalf of NRI-RP.</p>
Expand All @@ -145,7 +145,7 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
<p>The config interface is defined and has its gRPC server running in
NRI-RP. The agent acts as a gRPC client for this interface. The low-level
cluster interface is defined and has its gRPC server running in the agent,
with the <a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/pkg/resmgr/agent">convenience layer</a> defined in NRI-RP.
with the <a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/pkg/resmgr/agent">convenience layer</a> defined in NRI-RP.
NRI-RP acts as a gRPC client for the low-level plumbing interface.</p>
<p>Additionally, the stock node agent that comes with NRI-RP implements schemes
for:</p>
Expand All @@ -155,7 +155,7 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
</ul>
</section>
<section id="resource-manager">
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/pkg/resmgr/">Resource Manager</a><a class="headerlink" href="#resource-manager" title="Permalink to this heading"></a></h3>
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/pkg/resmgr/">Resource Manager</a><a class="headerlink" href="#resource-manager" title="Permalink to this heading"></a></h3>
<p>NRI-RP implements an event processing pipeline. In addition to NRI events,
it processes a set of other events that are not directly related to or the
result of NRI requests. These events are typically internally generated within
Expand Down Expand Up @@ -217,7 +217,7 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
</ul>
</section>
<section id="cache">
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/pkg/resmgr/cache/">Cache</a><a class="headerlink" href="#cache" title="Permalink to this heading"></a></h3>
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/pkg/resmgr/cache/">Cache</a><a class="headerlink" href="#cache" title="Permalink to this heading"></a></h3>
<p>The cache is a shared internal storage location within NRI-RP. It tracks the
runtime state of pods and containers known to NRI-RP, as well as the state
of NRI-RP itself, including the active configuration and the state of the
Expand Down Expand Up @@ -246,40 +246,40 @@ <h3><a class="reference external" href="https://github.com/containers/nri-plugin
the cache properly locked.</p>
</section>
<section id="generic-policy-layer">
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/6c7215312206918d9cd40501d1bc33e90829921b/pkg/resmgr/policy/policy.go">Generic Policy Layer</a><a class="headerlink" href="#generic-policy-layer" title="Permalink to this heading"></a></h3>
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/95e1402fce2a3df2a257835ec37e2a17afc9a98f/pkg/resmgr/policy/policy.go">Generic Policy Layer</a><a class="headerlink" href="#generic-policy-layer" title="Permalink to this heading"></a></h3>
<p>The generic policy layer defines the abstract interface the rest of NRI-RP
uses to interact with policy implementations and takes care of the details
of activating and dispatching calls through to the configured active policy.</p>
</section>
<section id="generic-resource-controller-layer">
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/6c7215312206918d9cd40501d1bc33e90829921b/pkg/resmgr/control/control.go">Generic Resource Controller Layer</a><a class="headerlink" href="#generic-resource-controller-layer" title="Permalink to this heading"></a></h3>
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/blob/95e1402fce2a3df2a257835ec37e2a17afc9a98f/pkg/resmgr/control/control.go">Generic Resource Controller Layer</a><a class="headerlink" href="#generic-resource-controller-layer" title="Permalink to this heading"></a></h3>
<p>The generic resource controller layer defines the abstract interface the rest
of NRI-RP uses to interact with resource controller implementations and takes
care of the details of dispatching calls to the controller implementations
for post-policy enforcment of decisions.</p>
</section>
<section id="metrics-collector">
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/pkg/metrics/">Metrics Collector</a><a class="headerlink" href="#metrics-collector" title="Permalink to this heading"></a></h3>
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/pkg/metrics/">Metrics Collector</a><a class="headerlink" href="#metrics-collector" title="Permalink to this heading"></a></h3>
<p>The metrics collector gathers a set of runtime metrics about the containers
running on the node. NRI-RP can be configured to periodically evaluate this
collected data to determine how optimal the current assignment of container
resources is and to attempt a rebalancing/reallocation if it is deemed
both possible and necessary.</p>
</section>
<section id="policy-implementations">
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/cmd/plugins">Policy Implementations</a><a class="headerlink" href="#policy-implementations" title="Permalink to this heading"></a></h3>
<h3><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/cmd/plugins">Policy Implementations</a><a class="headerlink" href="#policy-implementations" title="Permalink to this heading"></a></h3>
<section id="topology-aware">
<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/cmd/plugins/topology-aware/">Topology Aware</a><a class="headerlink" href="#topology-aware" title="Permalink to this heading"></a></h4>
<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/cmd/plugins/topology-aware/">Topology Aware</a><a class="headerlink" href="#topology-aware" title="Permalink to this heading"></a></h4>
<p>A topology-aware policy capable of handling multiple tiers/types of memory,
typically a DRAM/PMEM combination configured in 2-layer memory mode.</p>
</section>
<section id="balloons">
<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/cmd/plugins/balloons/">Balloons</a><a class="headerlink" href="#balloons" title="Permalink to this heading"></a></h4>
<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/cmd/plugins/balloons/">Balloons</a><a class="headerlink" href="#balloons" title="Permalink to this heading"></a></h4>
<p>A balloons policy allows user to define fine grained control how the
computer resources are distributed to workloads.</p>
</section>
<section id="template">
<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/6c7215312206918d9cd40501d1bc33e90829921b/cmd/plugins/template/">Template</a><a class="headerlink" href="#template" title="Permalink to this heading"></a></h4>
<h4><a class="reference external" href="https://github.com/containers/nri-plugins/tree/95e1402fce2a3df2a257835ec37e2a17afc9a98f/cmd/plugins/template/">Template</a><a class="headerlink" href="#template" title="Permalink to this heading"></a></h4>
<p>The template policy can be used as a base for developing new policies.
It provides hooks that the policy developer can fill to define fine grained
control how the computer resources are distributed to workloads.
Expand Down
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>CPU Allocator &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>CPU Allocator &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/developers-guide/e2e-test.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>End-to-End tests &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>End-to-End tests &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/developers-guide/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>Developer’s Guide &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Developer’s Guide &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/developers-guide/testing.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>Testing &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Testing &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/developers-guide/unit-test.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>Unit tests &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Unit tests &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/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>Resource Policy Plugins &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Resource Policy Plugins &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/installation.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>Installation &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Installation &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/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.2.1-9-g6c72153 documentation</title>
<title>Introduction &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/policy/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 &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Balloons Policy &mdash; NRI Plugins v0.2.1-11-g95e1402 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.2/docs/resource-policy/policy/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>Policies &mdash; NRI Plugins v0.2.1-9-g6c72153 documentation</title>
<title>Policies &mdash; NRI Plugins v0.2.1-11-g95e1402 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
Loading

0 comments on commit deb7580

Please sign in to comment.