From d9f0f69a13581c537cf8719833e724220b5ecf36 Mon Sep 17 00:00:00 2001 From: Github Date: Fri, 22 Dec 2023 13:58:09 +0000 Subject: [PATCH] Update documentation for devel Auto-generated from v0.1.0-202-g0241c49 by 'update-gh-pages.sh' --- devel/.buildinfo | 2 +- .../docs/deployment/helm/index.md.txt | 19 ++++++++++++ devel/_sources/docs/deployment/index.md.txt | 3 +- 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 | 28 +++++++++++++++++- 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 | 5 ++-- 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 | 2 +- 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 40 files changed, 99 insertions(+), 56 deletions(-) diff --git a/devel/.buildinfo b/devel/.buildinfo index 86ad245c5..99cabeb04 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: 46a2f2240cb6c767e57cce28a8aca501 +config: c09cb067f8c2b4b02786117795aaec61 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/devel/_sources/docs/deployment/helm/index.md.txt b/devel/_sources/docs/deployment/helm/index.md.txt index b635e2198..b13388c49 100644 --- a/devel/_sources/docs/deployment/helm/index.md.txt +++ b/devel/_sources/docs/deployment/helm/index.md.txt @@ -1,5 +1,24 @@ # Helm +All the available charts can be found in [artifacthub.io](https://artifacthub.io/packages/search?ts_query_web=nri&verified_publisher=true&official=true&sort=relevance&page=1). + +**NOTE:** NRI-plugins Helm installation has been successfully verified in both local clusters and major Cloud Providers' managed clusters, including: + + - AWS EKS + - kubernetes version: 1.28.x + - containerd version: 1.7 + - node image: Amazon Linux 2, Ubuntu 20.04, + - Google GKE + - kubernetes version: 1.28.x + - containerd version: 1.7 + - node image: Container-Optimized OS from Google (COS), Ubuntu 22.04 + - Azure AKS + - kubernetes version: 1.28.x + - containerd version: 1.7 + - node image: Azure Linux Container Host, Ubuntu 20.04 + +While Ubuntu 20.04/22.04 was used across all three CSP environments, it's worth noting that node images are not limited to Ubuntu 20.04/22.04 only. The majority of widely recognized Linux distributions should be suitable for use. + ```{toctree} --- maxdepth: 2 diff --git a/devel/_sources/docs/deployment/index.md.txt b/devel/_sources/docs/deployment/index.md.txt index 92c4a2e22..112be4432 100644 --- a/devel/_sources/docs/deployment/index.md.txt +++ b/devel/_sources/docs/deployment/index.md.txt @@ -1,7 +1,6 @@ # Deployment -The only supported installation method of the NRI plugins at the moment is -through Helm. +Currently supported installation methods of the NRI plugins are Helm and Operator. ```{toctree} --- diff --git a/devel/_static/documentation_options.js b/devel/_static/documentation_options.js index 3cc8e46d8..aeed52454 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.1.0-201-g61b0d6d', + VERSION: 'v0.1.0-202-g0241c49', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/devel/deployment/operator/README.html b/devel/deployment/operator/README.html index 9daeed724..4094e0ff7 100644 --- a/devel/deployment/operator/README.html +++ b/devel/deployment/operator/README.html @@ -4,7 +4,7 @@ - NRI-Plugins-Operator — NRI Plugins v0.1.0-201-g61b0d6d documentation + NRI-Plugins-Operator — NRI Plugins v0.1.0-202-g0241c49 documentation