From 69fd7d8d6c91bee77721efc0738b1f7fdb0844d3 Mon Sep 17 00:00:00 2001 From: Github Date: Wed, 18 Dec 2024 08:06:31 +0000 Subject: [PATCH] Update documentation for devel Auto-generated from v0.8.0-2-g4037edc5 by 'update-gh-pages.sh' --- devel/.buildinfo | 2 +- devel/_static/documentation_options.js | 2 +- devel/deployment/operator/README.html | 4 +-- devel/docs/contributing.html | 4 +-- devel/docs/deployment/helm/balloons.html | 6 ++-- devel/docs/deployment/helm/index.html | 4 +-- devel/docs/deployment/helm/memory-qos.html | 4 +-- devel/docs/deployment/helm/memtierd.html | 4 +-- devel/docs/deployment/helm/sgx-epc.html | 4 +-- devel/docs/deployment/helm/template.html | 6 ++-- .../docs/deployment/helm/topology-aware.html | 6 ++-- devel/docs/deployment/index.html | 4 +-- devel/docs/deployment/operator/index.html | 4 +-- devel/docs/deployment/operator/operator.html | 4 +-- devel/docs/index.html | 4 +-- devel/docs/introduction.html | 4 +-- devel/docs/memory/index.html | 4 +-- devel/docs/memory/memory-qos.html | 4 +-- devel/docs/memory/memtierd.html | 4 +-- devel/docs/memory/sgx-epc.html | 4 +-- devel/docs/resource-policy/configuration.html | 6 ++-- .../developers-guide/architecture.html | 26 +++++++++--------- .../developers-guide/cpu-allocator.html | 4 +-- .../developers-guide/e2e-test.html | 4 +-- .../developers-guide/index.html | 4 +-- .../developers-guide/testing.html | 4 +-- .../developers-guide/unit-test.html | 4 +-- devel/docs/resource-policy/index.html | 4 +-- devel/docs/resource-policy/introduction.html | 4 +-- .../docs/resource-policy/policy/balloons.html | 4 +-- devel/docs/resource-policy/policy/index.html | 4 +-- .../docs/resource-policy/policy/template.html | 4 +-- .../policy/topology-aware.html | 4 +-- devel/docs/resource-policy/setup.html | 4 +-- devel/genindex.html | 4 +-- devel/search.html | 4 +-- releases/.doctrees/environment.pickle | Bin 15105 -> 15105 bytes 37 files changed, 85 insertions(+), 85 deletions(-) diff --git a/devel/.buildinfo b/devel/.buildinfo index 50a7ff794..2f9a56912 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: 9b9df521ba03997ef96b02e03bf85c37 +config: 154ce4744d8e376cff369fa0e00e19f0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js index 69dba4e50..e21225443 100644 --- a/devel/_static/documentation_options.js +++ b/devel/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: 'v0.7.1-170-g00c77b69', + VERSION: 'v0.8.0-2-g4037edc5', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/devel/deployment/operator/README.html b/devel/deployment/operator/README.html index 2de721f6f..5ddf5428b 100644 --- a/devel/deployment/operator/README.html +++ b/devel/deployment/operator/README.html @@ -4,7 +4,7 @@ - NRI-Plugins-Operator — NRI Plugins v0.7.1-170-g00c77b69 documentation + NRI-Plugins-Operator — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/contributing.html b/devel/docs/contributing.html index 4f3ea6cda..2d8ff0be9 100644 --- a/devel/docs/contributing.html +++ b/devel/docs/contributing.html @@ -4,7 +4,7 @@ - Contributing — NRI Plugins v0.7.1-170-g00c77b69 documentation + Contributing — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/balloons.html b/devel/docs/deployment/helm/balloons.html index 13adb7b3c..a15e2c8b8 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.7.1-170-g00c77b69 documentation + Balloons Policy Plugin — NRI Plugins v0.8.0-2-g4037edc5 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 9796dc84d..7eae4d94b 100644 --- a/devel/docs/deployment/helm/index.html +++ b/devel/docs/deployment/helm/index.html @@ -4,7 +4,7 @@ - Helm — NRI Plugins v0.7.1-170-g00c77b69 documentation + Helm — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memory-qos.html b/devel/docs/deployment/helm/memory-qos.html index 27310fda3..fb783fd28 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.7.1-170-g00c77b69 documentation + Memory-QoS Plugin — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memtierd.html b/devel/docs/deployment/helm/memtierd.html index fa12ed5f5..97a0d06ce 100644 --- a/devel/docs/deployment/helm/memtierd.html +++ b/devel/docs/deployment/helm/memtierd.html @@ -4,7 +4,7 @@ - Memtierd Plugin — NRI Plugins v0.7.1-170-g00c77b69 documentation + Memtierd Plugin — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/sgx-epc.html b/devel/docs/deployment/helm/sgx-epc.html index 00c926d9a..84171c66e 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.7.1-170-g00c77b69 documentation + SGX EPC Limit Plugin — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/template.html b/devel/docs/deployment/helm/template.html index 1f28ecb7b..9fafbe946 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.7.1-170-g00c77b69 documentation + Template Policy Plugin — NRI Plugins v0.8.0-2-g4037edc5 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 361c0ac3e..bf6acd01c 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.7.1-170-g00c77b69 documentation + Topology-Aware Policy Plugin — NRI Plugins v0.8.0-2-g4037edc5 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 80a951435..96e6cd035 100644 --- a/devel/docs/deployment/index.html +++ b/devel/docs/deployment/index.html @@ -4,7 +4,7 @@ - Deployment — NRI Plugins v0.7.1-170-g00c77b69 documentation + Deployment — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/index.html b/devel/docs/deployment/operator/index.html index 58639a699..050e81d43 100644 --- a/devel/docs/deployment/operator/index.html +++ b/devel/docs/deployment/operator/index.html @@ -4,7 +4,7 @@ - Operator — NRI Plugins v0.7.1-170-g00c77b69 documentation + Operator — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/operator.html b/devel/docs/deployment/operator/operator.html index cd2cdc5e8..69aab489a 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.7.1-170-g00c77b69 documentation + NRI-Plugins-Operator — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/index.html b/devel/docs/index.html index 48f7b0324..363786019 100644 --- a/devel/docs/index.html +++ b/devel/docs/index.html @@ -4,7 +4,7 @@ - Welcome to NRI Plugins documentation — NRI Plugins v0.7.1-170-g00c77b69 documentation + Welcome to NRI Plugins documentation — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/introduction.html b/devel/docs/introduction.html index 9515aba0b..c0a3bffa2 100644 --- a/devel/docs/introduction.html +++ b/devel/docs/introduction.html @@ -4,7 +4,7 @@ - Introduction — NRI Plugins v0.7.1-170-g00c77b69 documentation + Introduction — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/index.html b/devel/docs/memory/index.html index b74423ca3..58ce2b465 100644 --- a/devel/docs/memory/index.html +++ b/devel/docs/memory/index.html @@ -4,7 +4,7 @@ - Memory plugins — NRI Plugins v0.7.1-170-g00c77b69 documentation + Memory plugins — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memory-qos.html b/devel/docs/memory/memory-qos.html index f6dd521fd..94c443a46 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.7.1-170-g00c77b69 documentation + Memory QoS NRI plugin — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memtierd.html b/devel/docs/memory/memtierd.html index 22d71e382..cbe20a53d 100644 --- a/devel/docs/memory/memtierd.html +++ b/devel/docs/memory/memtierd.html @@ -4,7 +4,7 @@ - Memtierd NRI plugin — NRI Plugins v0.7.1-170-g00c77b69 documentation + Memtierd NRI plugin — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/sgx-epc.html b/devel/docs/memory/sgx-epc.html index 3a05d62da..800349fc8 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.7.1-170-g00c77b69 documentation + SGX EPC Limit Plugin — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/configuration.html b/devel/docs/resource-policy/configuration.html index aab33ebe6..2ba70c6e5 100644 --- a/devel/docs/resource-policy/configuration.html +++ b/devel/docs/resource-policy/configuration.html @@ -4,7 +4,7 @@ - Dynamic Configuration — NRI Plugins v0.7.1-170-g00c77b69 documentation + Dynamic Configuration — NRI Plugins v0.8.0-2-g4037edc5 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 47eb4c61b..0c57b4f91 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.7.1-170-g00c77b69 documentation + Architecture — NRI Plugins v0.8.0-2-g4037edc5 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 caa8ca268..ff58c5f7a 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.7.1-170-g00c77b69 documentation + CPU Allocator — NRI Plugins v0.8.0-2-g4037edc5 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 f94345851..45e0f7a47 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.7.1-170-g00c77b69 documentation + End-to-End tests — NRI Plugins v0.8.0-2-g4037edc5 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 193276744..b90e17b12 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.7.1-170-g00c77b69 documentation + Developer’s Guide — NRI Plugins v0.8.0-2-g4037edc5 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 d23c00301..d7875fb8b 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.7.1-170-g00c77b69 documentation + Testing — NRI Plugins v0.8.0-2-g4037edc5 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 e8e984564..6a58bd495 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.7.1-170-g00c77b69 documentation + Unit tests — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/index.html b/devel/docs/resource-policy/index.html index 30feefaba..8aabb5a1c 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.7.1-170-g00c77b69 documentation + Resource Policy Plugins — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/introduction.html b/devel/docs/resource-policy/introduction.html index 284711ac9..e06e9b5b6 100644 --- a/devel/docs/resource-policy/introduction.html +++ b/devel/docs/resource-policy/introduction.html @@ -4,7 +4,7 @@ - Introduction — NRI Plugins v0.7.1-170-g00c77b69 documentation + Introduction — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/balloons.html b/devel/docs/resource-policy/policy/balloons.html index c1caa591c..4e2822b15 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.7.1-170-g00c77b69 documentation + Balloons Policy — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/index.html b/devel/docs/resource-policy/policy/index.html index 1519b1eda..f8ceac206 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.7.1-170-g00c77b69 documentation + Policies — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/template.html b/devel/docs/resource-policy/policy/template.html index 597db934c..f1da89537 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.7.1-170-g00c77b69 documentation + Template Policy — NRI Plugins v0.8.0-2-g4037edc5 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 dfed62ab6..d4e159436 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.7.1-170-g00c77b69 documentation + Topology-Aware Policy — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/setup.html b/devel/docs/resource-policy/setup.html index d75153ab1..5e0724f77 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.7.1-170-g00c77b69 documentation + Setup and Usage — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/genindex.html b/devel/genindex.html index a2b3d3fc8..db82556a9 100644 --- a/devel/genindex.html +++ b/devel/genindex.html @@ -3,7 +3,7 @@ - Index — NRI Plugins v0.7.1-170-g00c77b69 documentation + Index — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -14,7 +14,7 @@ - + diff --git a/devel/search.html b/devel/search.html index 2a51098df..c133662f1 100644 --- a/devel/search.html +++ b/devel/search.html @@ -3,7 +3,7 @@ - Search — NRI Plugins v0.7.1-170-g00c77b69 documentation + Search — NRI Plugins v0.8.0-2-g4037edc5 documentation @@ -15,7 +15,7 @@ - + diff --git a/releases/.doctrees/environment.pickle b/releases/.doctrees/environment.pickle index 4a08fcf770b2b588ef4215f203d69c32fad75c70..96cfd30853d50617524bab0020a0fcf266173b15 100644 GIT binary patch delta 18 acmZoHYb@JvSDW?6S@S1tn;&V*^8)}{+6e#v delta 18 ZcmZoHYb@JvSDSUKh=FtI=11D{`~Xb02TK3|