From 611434b630174fdba823eb8295857ba4dfb1943b Mon Sep 17 00:00:00 2001 From: Github Date: Thu, 28 Mar 2024 13:55:50 +0000 Subject: [PATCH] Update documentation for v0.4 Auto-generated from v0.4.0-8-gf547a1a by 'update-gh-pages.sh' --- v0.4/.buildinfo | 2 +- .../docs/deployment/helm/index.md.txt | 22 +++++++++++ v0.4/_static/documentation_options.js | 2 +- v0.4/deployment/operator/README.html | 2 +- v0.4/docs/contributing.html | 2 +- v0.4/docs/deployment/helm/balloons.html | 18 +++------ v0.4/docs/deployment/helm/index.html | 37 +++++++++++++++---- v0.4/docs/deployment/helm/memory-qos.html | 16 +++----- v0.4/docs/deployment/helm/memtierd.html | 16 +++----- v0.4/docs/deployment/helm/sgx-epc.html | 16 +++----- v0.4/docs/deployment/helm/template.html | 18 +++------ v0.4/docs/deployment/helm/topology-aware.html | 18 +++------ v0.4/docs/deployment/index.html | 10 ++--- v0.4/docs/deployment/operator/index.html | 2 +- v0.4/docs/deployment/operator/operator.html | 2 +- v0.4/docs/index.html | 2 +- v0.4/docs/introduction.html | 2 +- v0.4/docs/memory/index.html | 2 +- v0.4/docs/memory/memory-qos.html | 2 +- v0.4/docs/memory/memtierd.html | 2 +- v0.4/docs/memory/sgx-epc.html | 2 +- v0.4/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 +- v0.4/docs/resource-policy/index.html | 2 +- v0.4/docs/resource-policy/introduction.html | 2 +- .../docs/resource-policy/policy/balloons.html | 2 +- v0.4/docs/resource-policy/policy/index.html | 2 +- .../docs/resource-policy/policy/template.html | 2 +- .../policy/topology-aware.html | 2 +- v0.4/docs/resource-policy/setup.html | 2 +- v0.4/genindex.html | 2 +- v0.4/search.html | 2 +- v0.4/searchindex.js | 2 +- 38 files changed, 129 insertions(+), 124 deletions(-) diff --git a/v0.4/.buildinfo b/v0.4/.buildinfo index 5ac572dd3..23ec8e81e 100644 --- a/v0.4/.buildinfo +++ b/v0.4/.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: 7a1c61c2d2d053d40e6f83717460e242 +config: 5070c7ae5c7ea3cfb7f0f95eca10023b tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v0.4/_sources/docs/deployment/helm/index.md.txt b/v0.4/_sources/docs/deployment/helm/index.md.txt index b13388c49..59079e745 100644 --- a/v0.4/_sources/docs/deployment/helm/index.md.txt +++ b/v0.4/_sources/docs/deployment/helm/index.md.txt @@ -1,5 +1,7 @@ # Helm +## Stable Helm Charts + 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: @@ -19,6 +21,26 @@ All the available charts can be found in [artifacthub.io](https://artifacthub.io 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. +## Unstable Helm Charts + +Helm charts are also published from the main/development branch after each merge. +These charts reference the latest development images tagged as `unstable` and are +are stored alongside plugin images in the OCI image registry. + +### Discovering Unstable Helm Charts + +Unstable charts can be discovered using [skopeo](https://github.com/containers/skopeo). +For instance, one can list the available charts for the balloons plugin using this +skopeo command: +`skopeo list-tags docker://ghcr.io/containers/nri-plugins/helm-charts/nri-resource-policy-balloons` + +### Using Unstable Helm Charts + +Once discovered, unstable Helm charts can be used like any other. For instance, to use +the `v$X.$Y-unstable` version of the chart to install the development version of the +balloons plugin one can use this command: +`helm install --devel -n kube-system test oci://ghcr.io/containers/nri-plugins/helm-charts/nri-resource-policy-balloons --version v$X.$Y-unstable --set image.tag=unstable --set image.pullPolicy=Always` + ```{toctree} --- maxdepth: 2 diff --git a/v0.4/_static/documentation_options.js b/v0.4/_static/documentation_options.js index 0743b5e48..3f446b1cf 100644 --- a/v0.4/_static/documentation_options.js +++ b/v0.4/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: 'v0.4.0-1-g659d042', + VERSION: 'v0.4.0-8-gf547a1a', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/v0.4/deployment/operator/README.html b/v0.4/deployment/operator/README.html index b07d562fa..389baeb21 100644 --- a/v0.4/deployment/operator/README.html +++ b/v0.4/deployment/operator/README.html @@ -4,7 +4,7 @@ - NRI-Plugins-Operator — NRI Plugins v0.4.0-1-g659d042 documentation + NRI-Plugins-Operator — NRI Plugins v0.4.0-8-gf547a1a documentation