From 1590f4a2b0ad33012f9bb339bc8fdcc85df6929e Mon Sep 17 00:00:00 2001 From: Github Date: Tue, 17 Dec 2024 10:42:30 +0000 Subject: [PATCH] Update documentation for devel Auto-generated from v0.7.1-168-g109d59c0 by 'update-gh-pages.sh' --- devel/.buildinfo | 2 +- .../resource-policy/policy/balloons.md.txt | 14 ++++++---- 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 | 18 +++++++----- 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 38 files changed, 103 insertions(+), 95 deletions(-) diff --git a/devel/.buildinfo b/devel/.buildinfo index 4430bc0f7..001d5c307 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: 0f8f827851a4b37c6c465b16a57ae47e +config: 0409fecf37ad0d1c7d40e0ad6b7031ba tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/devel/_sources/docs/resource-policy/policy/balloons.md.txt b/devel/_sources/docs/resource-policy/policy/balloons.md.txt index 7b9f0a564..f3a7776eb 100644 --- a/devel/_sources/docs/resource-policy/policy/balloons.md.txt +++ b/devel/_sources/docs/resource-policy/policy/balloons.md.txt @@ -78,10 +78,11 @@ Balloons policy parameters: default is `true`: the container cannot use other CPUs. - `pinMemory` controls pinning a container to the memories that are closest to the CPUs of its balloon. The default is `true`: allow - using memory only from the closest NUMA nodes. Warning: this may - cause kernel to kill containers due to out-of-memory error when - closest NUMA nodes do not have enough memory. In this situation - consider switching this option `false`. + using memory only from the closest NUMA nodes. Can be overridden by + pinMemory in balloon types. Warning: pinning memory may cause kernel + to kill containers due to out-of-memory error when allowed NUMA + nodes do not have enough memory. In this situation consider + switching this option `false`. - `preserve` specifies containers whose resource pinning must not be modified by the policy. - `matchExpressions` if a container matches an expression in this @@ -174,10 +175,13 @@ Balloons policy parameters: - `cpuClass` specifies the name of the CPU class according to which CPUs of balloons are configured. Class properties are defined in separate `cpu.classes` objects, see below. + - `pinMemory` overrides policy-level `pinMemory` in balloons of this + type. - `memoryTypes` is a list of allowed memory types for containers in a balloon. Supported types are "HBM", "DRAM" and "PMEM". This setting can be overridden by a pod/container specific - `memory-type` annotation. + `memory-type` annotation. Memory types have no when not pinning + memory (see `pinMemory`). - `preferCloseToDevices`: prefer creating new balloons close to listed devices. List of strings - `preferCoreType`: specifies preferences of the core type which diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js index 794958647..bdd300161 100644 --- a/devel/_static/documentation_options.js +++ b/devel/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: 'v0.7.1-164-g85025a85', + VERSION: 'v0.7.1-168-g109d59c0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/devel/deployment/operator/README.html b/devel/deployment/operator/README.html index 5418b3d4c..af9f34096 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-164-g85025a85 documentation + NRI-Plugins-Operator — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/contributing.html b/devel/docs/contributing.html index 58104f5fe..1c2d70f34 100644 --- a/devel/docs/contributing.html +++ b/devel/docs/contributing.html @@ -4,7 +4,7 @@ - Contributing — NRI Plugins v0.7.1-164-g85025a85 documentation + Contributing — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/balloons.html b/devel/docs/deployment/helm/balloons.html index c1b5d86ae..3d96024dc 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-164-g85025a85 documentation + Balloons Policy Plugin — NRI Plugins v0.7.1-168-g109d59c0 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 40b0efbee..09a24aa5b 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-164-g85025a85 documentation + Helm — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memory-qos.html b/devel/docs/deployment/helm/memory-qos.html index 55dd0f0ef..db82b9c26 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-164-g85025a85 documentation + Memory-QoS Plugin — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/memtierd.html b/devel/docs/deployment/helm/memtierd.html index b72cd9df3..359336a53 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-164-g85025a85 documentation + Memtierd Plugin — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/sgx-epc.html b/devel/docs/deployment/helm/sgx-epc.html index e7d8520a6..ba462bf67 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-164-g85025a85 documentation + SGX EPC Limit Plugin — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/helm/template.html b/devel/docs/deployment/helm/template.html index 82c66d7dd..072b9e34f 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-164-g85025a85 documentation + Template Policy Plugin — NRI Plugins v0.7.1-168-g109d59c0 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 f1f95f831..0b93e0360 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-164-g85025a85 documentation + Topology-Aware Policy Plugin — NRI Plugins v0.7.1-168-g109d59c0 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 a087fac2d..3d624c917 100644 --- a/devel/docs/deployment/index.html +++ b/devel/docs/deployment/index.html @@ -4,7 +4,7 @@ - Deployment — NRI Plugins v0.7.1-164-g85025a85 documentation + Deployment — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/index.html b/devel/docs/deployment/operator/index.html index 30532ef55..6d2eb704f 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-164-g85025a85 documentation + Operator — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/deployment/operator/operator.html b/devel/docs/deployment/operator/operator.html index d8bd4b1fd..57e6bb6f7 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-164-g85025a85 documentation + NRI-Plugins-Operator — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/index.html b/devel/docs/index.html index 131beb392..35b054ad2 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-164-g85025a85 documentation + Welcome to NRI Plugins documentation — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/introduction.html b/devel/docs/introduction.html index 004bb8753..f93437df5 100644 --- a/devel/docs/introduction.html +++ b/devel/docs/introduction.html @@ -4,7 +4,7 @@ - Introduction — NRI Plugins v0.7.1-164-g85025a85 documentation + Introduction — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/index.html b/devel/docs/memory/index.html index cbb923a23..6609e71d9 100644 --- a/devel/docs/memory/index.html +++ b/devel/docs/memory/index.html @@ -4,7 +4,7 @@ - Memory plugins — NRI Plugins v0.7.1-164-g85025a85 documentation + Memory plugins — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memory-qos.html b/devel/docs/memory/memory-qos.html index 3878d16a8..72e0ad75d 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-164-g85025a85 documentation + Memory QoS NRI plugin — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/memtierd.html b/devel/docs/memory/memtierd.html index bcb3469db..439d7efee 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-164-g85025a85 documentation + Memtierd NRI plugin — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/memory/sgx-epc.html b/devel/docs/memory/sgx-epc.html index 03c615780..3096356b5 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-164-g85025a85 documentation + SGX EPC Limit Plugin — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/configuration.html b/devel/docs/resource-policy/configuration.html index 49c14267c..9671fd3b8 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-164-g85025a85 documentation + Dynamic Configuration — NRI Plugins v0.7.1-168-g109d59c0 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 1a2f594df..59015d82a 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-164-g85025a85 documentation + Architecture — NRI Plugins v0.7.1-168-g109d59c0 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 fca79abb3..7c0bc8ef0 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-164-g85025a85 documentation + CPU Allocator — NRI Plugins v0.7.1-168-g109d59c0 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 cd19b0c05..9cf43277f 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-164-g85025a85 documentation + End-to-End tests — NRI Plugins v0.7.1-168-g109d59c0 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 2668d8017..785e2fd20 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-164-g85025a85 documentation + Developer’s Guide — NRI Plugins v0.7.1-168-g109d59c0 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 f1cb50c55..83355adb5 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-164-g85025a85 documentation + Testing — NRI Plugins v0.7.1-168-g109d59c0 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 c1232a20c..35ed566e8 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-164-g85025a85 documentation + Unit tests — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/index.html b/devel/docs/resource-policy/index.html index d7b9bb63b..6d01837d8 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-164-g85025a85 documentation + Resource Policy Plugins — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/introduction.html b/devel/docs/resource-policy/introduction.html index 1fdfbc449..06541427f 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-164-g85025a85 documentation + Introduction — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + diff --git a/devel/docs/resource-policy/policy/balloons.html b/devel/docs/resource-policy/policy/balloons.html index c47205c4d..fcce12900 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-164-g85025a85 documentation + Balloons Policy — NRI Plugins v0.7.1-168-g109d59c0 documentation @@ -15,7 +15,7 @@ - + @@ -188,10 +188,11 @@

Parameterstrue: the container cannot use other CPUs.

  • pinMemory controls pinning a container to the memories that are closest to the CPUs of its balloon. The default is true: allow -using memory only from the closest NUMA nodes. Warning: this may -cause kernel to kill containers due to out-of-memory error when -closest NUMA nodes do not have enough memory. In this situation -consider switching this option false.

  • +using memory only from the closest NUMA nodes. Can be overridden by +pinMemory in balloon types. Warning: pinning memory may cause kernel +to kill containers due to out-of-memory error when allowed NUMA +nodes do not have enough memory. In this situation consider +switching this option false.

  • preserve specifies containers whose resource pinning must not be modified by the policy.