From e104a048dd15fe56b6ec6f88922ba2eefb4dfe5f Mon Sep 17 00:00:00 2001 From: Github Date: Wed, 11 Dec 2024 07:20:17 +0000 Subject: [PATCH] Update documentation for devel Auto-generated from v0.7.1-148-g26aa513a 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 9ccbe64cd..9251ef616 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: ee3da7d5b4d98f0a8b1edf817cf2bedb +config: 35cdddc11ce6331e0d2b769226756d17 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js index 259e3700f..241a3fded 100644 --- a/devel/_static/documentation_options.js +++ b/devel/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: 'v0.7.1-147-g8af4c2e7', + VERSION: 'v0.7.1-148-g26aa513a', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/devel/deployment/operator/README.html b/devel/deployment/operator/README.html index 8cd7f3d6a..ff5b0bbcf 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-147-g8af4c2e7 documentation + NRI-Plugins-Operator — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/contributing.html b/devel/docs/contributing.html index 735b3819a..e2f6111a6 100644 --- a/devel/docs/contributing.html +++ b/devel/docs/contributing.html @@ -4,7 +4,7 @@ - Contributing — NRI Plugins v0.7.1-147-g8af4c2e7 documentation + Contributing — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/balloons.html b/devel/docs/deployment/helm/balloons.html index ecf00189e..f7502e787 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-147-g8af4c2e7 documentation + Balloons Policy Plugin — NRI Plugins v0.7.1-148-g26aa513a 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 a3d6810ed..27441cc83 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-147-g8af4c2e7 documentation + Helm — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memory-qos.html b/devel/docs/deployment/helm/memory-qos.html index e62935d21..601ab0e66 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-147-g8af4c2e7 documentation + Memory-QoS Plugin — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memtierd.html b/devel/docs/deployment/helm/memtierd.html index 7231fd549..4321afe8c 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-147-g8af4c2e7 documentation + Memtierd Plugin — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/sgx-epc.html b/devel/docs/deployment/helm/sgx-epc.html index 14cbf0a9c..17fcd9b98 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-147-g8af4c2e7 documentation + SGX EPC Limit Plugin — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/template.html b/devel/docs/deployment/helm/template.html index 6bf600bfe..b09c971e4 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-147-g8af4c2e7 documentation + Template Policy Plugin — NRI Plugins v0.7.1-148-g26aa513a 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 1b8d7e5b6..290c8b5ad 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-147-g8af4c2e7 documentation + Topology-Aware Policy Plugin — NRI Plugins v0.7.1-148-g26aa513a 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 c138ef9c4..b97c69184 100644 --- a/devel/docs/deployment/index.html +++ b/devel/docs/deployment/index.html @@ -4,7 +4,7 @@ - Deployment — NRI Plugins v0.7.1-147-g8af4c2e7 documentation + Deployment — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/index.html b/devel/docs/deployment/operator/index.html index ede3ae084..19c4e7a04 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-147-g8af4c2e7 documentation + Operator — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/operator.html b/devel/docs/deployment/operator/operator.html index d74fba3a3..4526ca1d4 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-147-g8af4c2e7 documentation + NRI-Plugins-Operator — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/index.html b/devel/docs/index.html index 143441fed..94853fbe4 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-147-g8af4c2e7 documentation + Welcome to NRI Plugins documentation — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/introduction.html b/devel/docs/introduction.html index 6d8cc9f89..7dce7d85b 100644 --- a/devel/docs/introduction.html +++ b/devel/docs/introduction.html @@ -4,7 +4,7 @@ - Introduction — NRI Plugins v0.7.1-147-g8af4c2e7 documentation + Introduction — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/index.html b/devel/docs/memory/index.html index 79ed82beb..9984fb0da 100644 --- a/devel/docs/memory/index.html +++ b/devel/docs/memory/index.html @@ -4,7 +4,7 @@ - Memory plugins — NRI Plugins v0.7.1-147-g8af4c2e7 documentation + Memory plugins — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memory-qos.html b/devel/docs/memory/memory-qos.html index a5814f163..33e224bc2 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-147-g8af4c2e7 documentation + Memory QoS NRI plugin — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memtierd.html b/devel/docs/memory/memtierd.html index 67cffdb3f..5eae31148 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-147-g8af4c2e7 documentation + Memtierd NRI plugin — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/sgx-epc.html b/devel/docs/memory/sgx-epc.html index cee1c0c75..f188303f0 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-147-g8af4c2e7 documentation + SGX EPC Limit Plugin — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/configuration.html b/devel/docs/resource-policy/configuration.html index 7fad48189..249271120 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-147-g8af4c2e7 documentation + Dynamic Configuration — NRI Plugins v0.7.1-148-g26aa513a 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 5679215ff..6dacb2695 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-147-g8af4c2e7 documentation + Architecture — NRI Plugins v0.7.1-148-g26aa513a 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 e2de81d55..ae7ebc00a 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-147-g8af4c2e7 documentation + CPU Allocator — NRI Plugins v0.7.1-148-g26aa513a 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 8fc4cd0ff..0e62c810c 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-147-g8af4c2e7 documentation + End-to-End tests — NRI Plugins v0.7.1-148-g26aa513a 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 ad4483b39..deee36d7e 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-147-g8af4c2e7 documentation + Developer’s Guide — NRI Plugins v0.7.1-148-g26aa513a 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 bd4fe4839..ea737cce0 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-147-g8af4c2e7 documentation + Testing — NRI Plugins v0.7.1-148-g26aa513a 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 c214c5865..338e7b5bd 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-147-g8af4c2e7 documentation + Unit tests — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/index.html b/devel/docs/resource-policy/index.html index 87d9c5657..22fc78a46 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-147-g8af4c2e7 documentation + Resource Policy Plugins — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/introduction.html b/devel/docs/resource-policy/introduction.html index a55446c12..65f5cf057 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-147-g8af4c2e7 documentation + Introduction — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/balloons.html b/devel/docs/resource-policy/policy/balloons.html index f8623903f..e43808860 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-147-g8af4c2e7 documentation + Balloons Policy — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/index.html b/devel/docs/resource-policy/policy/index.html index b44d83d8c..c3a0a0d21 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-147-g8af4c2e7 documentation + Policies — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/template.html b/devel/docs/resource-policy/policy/template.html index dc3525c97..796d41768 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-147-g8af4c2e7 documentation + Template Policy — NRI Plugins v0.7.1-148-g26aa513a 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 09892d7ff..a091f0ba5 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-147-g8af4c2e7 documentation + Topology-Aware Policy — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/setup.html b/devel/docs/resource-policy/setup.html index c28c277f0..cbd222239 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-147-g8af4c2e7 documentation + Setup and Usage — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/genindex.html b/devel/genindex.html index b71e724a7..c4973eab9 100644 --- a/devel/genindex.html +++ b/devel/genindex.html @@ -3,7 +3,7 @@ - Index — NRI Plugins v0.7.1-147-g8af4c2e7 documentation + Index — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -14,7 +14,7 @@ - + diff --git a/devel/search.html b/devel/search.html index 1f05d7bde..af2ae65d1 100644 --- a/devel/search.html +++ b/devel/search.html @@ -3,7 +3,7 @@ - Search — NRI Plugins v0.7.1-147-g8af4c2e7 documentation + Search — NRI Plugins v0.7.1-148-g26aa513a documentation @@ -15,7 +15,7 @@ - + diff --git a/releases/.doctrees/environment.pickle b/releases/.doctrees/environment.pickle index d595cdc33a109a5cd98a6a0c5c73e84e1643b0b5..ee0756b1f5686d43abd54b6436f4b3fd7b4e557c 100644 GIT binary patch delta 17 ZcmZoHYb@JvSDR(tvG=)~A8IS`0{~C@2w4CC delta 17 YcmZoHYb@JvSDPibD>7^ILv00q07x|lQvd(}