From 0dee32d477c47e293ddd6ffeae96c4add39f3d92 Mon Sep 17 00:00:00 2001 From: Github Date: Thu, 20 Jun 2024 07:49:11 +0000 Subject: [PATCH] Update documentation for devel Auto-generated from v0.5.0-37-g1e6050db by 'update-gh-pages.sh' --- devel/.buildinfo | 2 +- .../policy/topology-aware.md.txt | 18 +++++++++++++ devel/_static/documentation_options.js | 2 +- devel/deployment/operator/README.html | 2 +- devel/docs/contributing.html | 2 +- devel/docs/deployment/helm/balloons.html | 4 +-- devel/docs/deployment/helm/index.html | 2 +- devel/docs/deployment/helm/memory-qos.html | 2 +- devel/docs/deployment/helm/memtierd.html | 2 +- devel/docs/deployment/helm/sgx-epc.html | 2 +- devel/docs/deployment/helm/template.html | 4 +-- .../docs/deployment/helm/topology-aware.html | 4 +-- devel/docs/deployment/index.html | 2 +- devel/docs/deployment/operator/index.html | 2 +- devel/docs/deployment/operator/operator.html | 2 +- devel/docs/index.html | 2 +- devel/docs/introduction.html | 2 +- devel/docs/memory/index.html | 2 +- devel/docs/memory/memory-qos.html | 2 +- devel/docs/memory/memtierd.html | 2 +- devel/docs/memory/sgx-epc.html | 2 +- devel/docs/resource-policy/configuration.html | 4 +-- .../developers-guide/architecture.html | 24 +++++++++--------- .../developers-guide/cpu-allocator.html | 2 +- .../developers-guide/e2e-test.html | 2 +- .../developers-guide/index.html | 2 +- .../developers-guide/testing.html | 2 +- .../developers-guide/unit-test.html | 2 +- devel/docs/resource-policy/index.html | 2 +- devel/docs/resource-policy/introduction.html | 2 +- .../docs/resource-policy/policy/balloons.html | 2 +- devel/docs/resource-policy/policy/index.html | 2 +- .../docs/resource-policy/policy/template.html | 2 +- .../policy/topology-aware.html | 19 +++++++++++++- devel/docs/resource-policy/setup.html | 2 +- devel/genindex.html | 2 +- devel/search.html | 2 +- devel/searchindex.js | 2 +- releases/.doctrees/environment.pickle | Bin 12834 -> 12834 bytes 39 files changed, 87 insertions(+), 52 deletions(-) diff --git a/devel/.buildinfo b/devel/.buildinfo index f8dfad334..c4a48c6b1 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: b93fdb2254b7b27832b850bdf7f6f0f7 +config: 6c3d3cc986a8f266fd84a0ef04e58daa tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/devel/_sources/docs/resource-policy/policy/topology-aware.md.txt b/devel/_sources/docs/resource-policy/policy/topology-aware.md.txt index 5ef308981..4735a41de 100644 --- a/devel/_sources/docs/resource-policy/policy/topology-aware.md.txt +++ b/devel/_sources/docs/resource-policy/policy/topology-aware.md.txt @@ -271,6 +271,24 @@ metadata: These Pod annotations have no effect on containers which are not eligible for exclusive allocation. +### Selectively Disabling Hyperthreading + +If a container opts to hide hyperthreads, it is allowed to use only +one hyperthread from every physical CPU core allocated to it. Note +that as a result the container may be allowed to run on only half of +the CPUs it has requested. In case of workloads that do not benefit +from hyperthreading this nevertheless results in better performance +compared to running on all hyperthreads of the same CPU cores. If +container's CPU allocation is exclusive, no other container can run on +hidden hyperthreads either. + +```yaml +metadata: + annotations: + # allow the "LLM" container to use only single thread per physical CPU core + hide-hyperthreads.resource-policy.nri.io/container.LLM: "true" +``` + ### Implicit Hardware Topology Hints `NRI Resource Policy` automatically generates HW `Topology Hints` for devices diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js index 9587901ff..ad2d4eab5 100644 --- a/devel/_static/documentation_options.js +++ b/devel/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: 'v0.5.0-36-g9143f220', + VERSION: 'v0.5.0-37-g1e6050db', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/devel/deployment/operator/README.html b/devel/deployment/operator/README.html index a20c31d3b..532a4413a 100644 --- a/devel/deployment/operator/README.html +++ b/devel/deployment/operator/README.html @@ -4,7 +4,7 @@ - NRI-Plugins-Operator — NRI Plugins v0.5.0-36-g9143f220 documentation + NRI-Plugins-Operator — NRI Plugins v0.5.0-37-g1e6050db documentation