diff --git a/devel/.buildinfo b/devel/.buildinfo index 356ca8a55..ac57b959a 100644 --- 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: 8bdb313177f75f8e58d3654ade77f87c +config: 0c776194bb1d31f7086cafff51b7ba60 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js index f4e9e8e60..7f5d59f75 100644 --- a/devel/_static/documentation_options.js +++ b/devel/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: 'v0.8.0-12-g1f11ebfc', + VERSION: 'v0.8.0-13-ge1a82ce5', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/devel/deployment/operator/README.html b/devel/deployment/operator/README.html index fbc9d29b8..f8bbf0414 100644 --- a/devel/deployment/operator/README.html +++ b/devel/deployment/operator/README.html @@ -4,7 +4,7 @@ - NRI-Plugins-Operator — NRI Plugins v0.8.0-12-g1f11ebfc documentation + NRI-Plugins-Operator — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/contributing.html b/devel/docs/contributing.html index 01cefcdfb..3d88c4027 100644 --- a/devel/docs/contributing.html +++ b/devel/docs/contributing.html @@ -4,7 +4,7 @@ - Contributing — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Contributing — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/balloons.html b/devel/docs/deployment/helm/balloons.html index 29d33d1a4..6d515db44 100644 --- a/devel/docs/deployment/helm/balloons.html +++ b/devel/docs/deployment/helm/balloons.html @@ -4,7 +4,7 @@ - Balloons Policy Plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Balloons Policy Plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + @@ -222,7 +222,7 @@

Configuration options

extra environment variables to inject (string map)

config

-

see helm chart values for the default configuration

+

see helm chart values for the default configuration

plugin configuration data

configGroupLabel

diff --git a/devel/docs/deployment/helm/index.html b/devel/docs/deployment/helm/index.html index 6f537ad41..2b3963258 100644 --- a/devel/docs/deployment/helm/index.html +++ b/devel/docs/deployment/helm/index.html @@ -4,7 +4,7 @@ - Helm — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Helm — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memory-qos.html b/devel/docs/deployment/helm/memory-qos.html index ba3a76033..5fac261f6 100644 --- a/devel/docs/deployment/helm/memory-qos.html +++ b/devel/docs/deployment/helm/memory-qos.html @@ -4,7 +4,7 @@ - Memory-QoS Plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Memory-QoS Plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memtierd.html b/devel/docs/deployment/helm/memtierd.html index b556014d3..6d458f291 100644 --- a/devel/docs/deployment/helm/memtierd.html +++ b/devel/docs/deployment/helm/memtierd.html @@ -4,7 +4,7 @@ - Memtierd Plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Memtierd Plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/sgx-epc.html b/devel/docs/deployment/helm/sgx-epc.html index 9c5d6f006..8ada7c884 100644 --- a/devel/docs/deployment/helm/sgx-epc.html +++ b/devel/docs/deployment/helm/sgx-epc.html @@ -4,7 +4,7 @@ - SGX EPC Limit Plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + SGX EPC Limit Plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/template.html b/devel/docs/deployment/helm/template.html index d9c52ab34..7b5697d13 100644 --- a/devel/docs/deployment/helm/template.html +++ b/devel/docs/deployment/helm/template.html @@ -4,7 +4,7 @@ - Template Policy Plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Template Policy Plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + @@ -222,7 +222,7 @@

Configuration options

extra environment variables to inject (string map)

config

-

see helm chart values for the default configuration

+

see helm chart values for the default configuration

plugin configuration data

configGroupLabel

diff --git a/devel/docs/deployment/helm/topology-aware.html b/devel/docs/deployment/helm/topology-aware.html index b09acfae5..176657246 100644 --- a/devel/docs/deployment/helm/topology-aware.html +++ b/devel/docs/deployment/helm/topology-aware.html @@ -4,7 +4,7 @@ - Topology-Aware Policy Plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Topology-Aware Policy Plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + @@ -223,7 +223,7 @@

Configuration options

extra environment variables to inject (string map)

config

-

see helm chart values for the default configuration

+

see helm chart values for the default configuration

plugin configuration data

configGroupLabel

diff --git a/devel/docs/deployment/index.html b/devel/docs/deployment/index.html index 453ddc09d..635ba0df2 100644 --- a/devel/docs/deployment/index.html +++ b/devel/docs/deployment/index.html @@ -4,7 +4,7 @@ - Deployment — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Deployment — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/index.html b/devel/docs/deployment/operator/index.html index 82d537215..bb7b8474a 100644 --- a/devel/docs/deployment/operator/index.html +++ b/devel/docs/deployment/operator/index.html @@ -4,7 +4,7 @@ - Operator — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Operator — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/operator.html b/devel/docs/deployment/operator/operator.html index 994645bf6..35eefadb0 100644 --- a/devel/docs/deployment/operator/operator.html +++ b/devel/docs/deployment/operator/operator.html @@ -4,7 +4,7 @@ - NRI-Plugins-Operator — NRI Plugins v0.8.0-12-g1f11ebfc documentation + NRI-Plugins-Operator — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/index.html b/devel/docs/index.html index 4dceb2b9a..b4920f563 100644 --- a/devel/docs/index.html +++ b/devel/docs/index.html @@ -4,7 +4,7 @@ - Welcome to NRI Plugins documentation — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Welcome to NRI Plugins documentation — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/introduction.html b/devel/docs/introduction.html index 31cad11a8..39a57eaae 100644 --- a/devel/docs/introduction.html +++ b/devel/docs/introduction.html @@ -4,7 +4,7 @@ - Introduction — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Introduction — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/index.html b/devel/docs/memory/index.html index 72547f8f5..3f9785806 100644 --- a/devel/docs/memory/index.html +++ b/devel/docs/memory/index.html @@ -4,7 +4,7 @@ - Memory plugins — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Memory plugins — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memory-qos.html b/devel/docs/memory/memory-qos.html index 8c3529816..66c32868a 100644 --- a/devel/docs/memory/memory-qos.html +++ b/devel/docs/memory/memory-qos.html @@ -4,7 +4,7 @@ - Memory QoS NRI plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Memory QoS NRI plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memtierd.html b/devel/docs/memory/memtierd.html index 785071654..4f8b4dcd4 100644 --- a/devel/docs/memory/memtierd.html +++ b/devel/docs/memory/memtierd.html @@ -4,7 +4,7 @@ - Memtierd NRI plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Memtierd NRI plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/sgx-epc.html b/devel/docs/memory/sgx-epc.html index 3e7c18376..1ee00a44d 100644 --- a/devel/docs/memory/sgx-epc.html +++ b/devel/docs/memory/sgx-epc.html @@ -4,7 +4,7 @@ - SGX EPC Limit Plugin — NRI Plugins v0.8.0-12-g1f11ebfc documentation + SGX EPC Limit Plugin — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/configuration.html b/devel/docs/resource-policy/configuration.html index ee31cfa4c..634c36868 100644 --- a/devel/docs/resource-policy/configuration.html +++ b/devel/docs/resource-policy/configuration.html @@ -4,7 +4,7 @@ - Dynamic Configuration — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Dynamic Configuration — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + @@ -107,7 +107,7 @@

Dynamic Configurationconfig.nri/group 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.

-

There are sample configuration custom resources that +

There are sample configuration custom resources that contain contains a node-specific, a group-specific, and a default configuration. See any available policy-specific documentation for more information on the policy configurations.

diff --git a/devel/docs/resource-policy/developers-guide/architecture.html b/devel/docs/resource-policy/developers-guide/architecture.html index 8e8796b19..a7e303827 100644 --- a/devel/docs/resource-policy/developers-guide/architecture.html +++ b/devel/docs/resource-policy/developers-guide/architecture.html @@ -4,7 +4,7 @@ - Architecture — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Architecture — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + @@ -131,7 +131,7 @@

Overview

Components

-

Node Agent

+

Node Agent

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.

@@ -146,7 +146,7 @@

convenience layer defined in NRI-RP. +with the convenience layer defined in NRI-RP. NRI-RP acts as a gRPC client for the low-level plumbing interface.

Additionally, the stock node agent that comes with NRI-RP implements schemes for:

@@ -156,7 +156,7 @@

-

Resource Manager

+

Resource Manager

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 @@ -222,7 +222,7 @@

-

Cache

+

Cache

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 @@ -251,20 +251,20 @@

-

Generic Policy Layer

+

Generic Policy Layer

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.

-

Generic Resource Controller Layer

+

Generic Resource Controller Layer

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 enforcement of decisions.

-

Metrics Collector

+

Metrics Collector

The metrics collector gathers a set of runtime metrics about system resources, containers running on the node, and policy-specific resource assignments and expose these as Prometheus metrics. This data can be externally evaluated and @@ -272,19 +272,19 @@

-

Policy Implementations

+

Policy Implementations

-

Topology Aware

+

Topology Aware

A topology-aware policy capable of handling multiple tiers/types of memory, typically a DRAM/PMEM combination configured in 2-layer memory mode.

-

Balloons

+

Balloons

A balloons policy allows user to define fine grained control how the computer resources are distributed to workloads.

-

Template

+

Template

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. diff --git a/devel/docs/resource-policy/developers-guide/cpu-allocator.html b/devel/docs/resource-policy/developers-guide/cpu-allocator.html index aebbb34e3..208552202 100644 --- a/devel/docs/resource-policy/developers-guide/cpu-allocator.html +++ b/devel/docs/resource-policy/developers-guide/cpu-allocator.html @@ -4,7 +4,7 @@ - CPU Allocator — NRI Plugins v0.8.0-12-g1f11ebfc documentation + CPU Allocator — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/developers-guide/e2e-test.html b/devel/docs/resource-policy/developers-guide/e2e-test.html index 2fc6d6861..bfddfa605 100644 --- a/devel/docs/resource-policy/developers-guide/e2e-test.html +++ b/devel/docs/resource-policy/developers-guide/e2e-test.html @@ -4,7 +4,7 @@ - End-to-End tests — NRI Plugins v0.8.0-12-g1f11ebfc documentation + End-to-End tests — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/developers-guide/index.html b/devel/docs/resource-policy/developers-guide/index.html index d3bf5030a..f8aa73626 100644 --- a/devel/docs/resource-policy/developers-guide/index.html +++ b/devel/docs/resource-policy/developers-guide/index.html @@ -4,7 +4,7 @@ - Developer’s Guide — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Developer’s Guide — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/developers-guide/testing.html b/devel/docs/resource-policy/developers-guide/testing.html index ca0ef361c..31b3c7e5e 100644 --- a/devel/docs/resource-policy/developers-guide/testing.html +++ b/devel/docs/resource-policy/developers-guide/testing.html @@ -4,7 +4,7 @@ - Testing — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Testing — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/developers-guide/unit-test.html b/devel/docs/resource-policy/developers-guide/unit-test.html index 97c56eb59..2fba96590 100644 --- a/devel/docs/resource-policy/developers-guide/unit-test.html +++ b/devel/docs/resource-policy/developers-guide/unit-test.html @@ -4,7 +4,7 @@ - Unit tests — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Unit tests — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/index.html b/devel/docs/resource-policy/index.html index 9c24001bb..9db0dcdeb 100644 --- a/devel/docs/resource-policy/index.html +++ b/devel/docs/resource-policy/index.html @@ -4,7 +4,7 @@ - Resource Policy Plugins — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Resource Policy Plugins — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/introduction.html b/devel/docs/resource-policy/introduction.html index 3c6d9dae8..ee4bac976 100644 --- a/devel/docs/resource-policy/introduction.html +++ b/devel/docs/resource-policy/introduction.html @@ -4,7 +4,7 @@ - Introduction — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Introduction — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/balloons.html b/devel/docs/resource-policy/policy/balloons.html index 796535881..015037a60 100644 --- a/devel/docs/resource-policy/policy/balloons.html +++ b/devel/docs/resource-policy/policy/balloons.html @@ -4,7 +4,7 @@ - Balloons Policy — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Balloons Policy — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/index.html b/devel/docs/resource-policy/policy/index.html index ad6820077..a0a0548a7 100644 --- a/devel/docs/resource-policy/policy/index.html +++ b/devel/docs/resource-policy/policy/index.html @@ -4,7 +4,7 @@ - Policies — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Policies — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/template.html b/devel/docs/resource-policy/policy/template.html index 3846eedd2..9c436bc78 100644 --- a/devel/docs/resource-policy/policy/template.html +++ b/devel/docs/resource-policy/policy/template.html @@ -4,7 +4,7 @@ - Template Policy — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Template Policy — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/topology-aware.html b/devel/docs/resource-policy/policy/topology-aware.html index 922db0f0b..3d935e299 100644 --- a/devel/docs/resource-policy/policy/topology-aware.html +++ b/devel/docs/resource-policy/policy/topology-aware.html @@ -4,7 +4,7 @@ - Topology-Aware Policy — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Topology-Aware Policy — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/setup.html b/devel/docs/resource-policy/setup.html index 10125cfc2..39d0c8ee2 100644 --- a/devel/docs/resource-policy/setup.html +++ b/devel/docs/resource-policy/setup.html @@ -4,7 +4,7 @@ - Setup and Usage — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Setup and Usage — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/genindex.html b/devel/genindex.html index 26bc056f9..1842f2463 100644 --- a/devel/genindex.html +++ b/devel/genindex.html @@ -3,7 +3,7 @@ - Index — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Index — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -14,7 +14,7 @@ - + diff --git a/devel/search.html b/devel/search.html index 9cbf8c11b..d0fb8a67b 100644 --- a/devel/search.html +++ b/devel/search.html @@ -3,7 +3,7 @@ - Search — NRI Plugins v0.8.0-12-g1f11ebfc documentation + Search — NRI Plugins v0.8.0-13-ge1a82ce5 documentation @@ -15,7 +15,7 @@ - + diff --git a/releases/.doctrees/environment.pickle b/releases/.doctrees/environment.pickle index a23035b3b..30ec17fe3 100644 Binary files a/releases/.doctrees/environment.pickle and b/releases/.doctrees/environment.pickle differ