From a99118b38f3b0eb25876396ad4a9d2174b99e2e5 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Thu, 22 Jun 2023 12:27:46 +0300 Subject: [PATCH 1/2] docs: flatten the hierarchy Drop one level of sub-hierarchy, making "Policies" a top-level item in the "Resource Policy Plugins" section. Makes the documentation easier to follow (and easier to find the detailed docs of the actual policies/plugins). Signed-off-by: Markus Lehtonen --- docs/resource-policy/configuration.rst | 7 ------- docs/resource-policy/index.rst | 3 ++- 2 files changed, 2 insertions(+), 8 deletions(-) delete mode 100644 docs/resource-policy/configuration.rst diff --git a/docs/resource-policy/configuration.rst b/docs/resource-policy/configuration.rst deleted file mode 100644 index f5c5ee6a9..000000000 --- a/docs/resource-policy/configuration.rst +++ /dev/null @@ -1,7 +0,0 @@ -Configuration -############# -.. toctree:: - :maxdepth: 1 - - policy/index.rst - node-agent.md diff --git a/docs/resource-policy/index.rst b/docs/resource-policy/index.rst index 0d08a7d1d..9fec3e495 100644 --- a/docs/resource-policy/index.rst +++ b/docs/resource-policy/index.rst @@ -8,6 +8,7 @@ Resource Policy Plugins introduction.md installation.md setup.md - configuration.rst + node-agent.md + policy/index.rst developers-guide/index.rst From d084b48189067592ff0ec2862f0c5e3c0f94e36b Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Thu, 22 Jun 2023 12:37:10 +0300 Subject: [PATCH 2/2] docs: work on documentation of dynamic configuration Edit the text at some parts describing the dynamic configuration, replacing "agent" with "dynamic configuration", trying to make it easier to read for the casual reader (who doesn't really care about the internal architecture, involving "agent"). Also, rename "resource-policy/node-agent.md" to "configuration.md" which better matches with the heading and contents. Signed-off-by: Markus Lehtonen --- .../{node-agent.md => configuration.md} | 0 docs/resource-policy/index.rst | 2 +- docs/resource-policy/policy/topology-aware.md | 10 ++++---- docs/resource-policy/setup.md | 24 +++++++++---------- 4 files changed, 17 insertions(+), 19 deletions(-) rename docs/resource-policy/{node-agent.md => configuration.md} (100%) diff --git a/docs/resource-policy/node-agent.md b/docs/resource-policy/configuration.md similarity index 100% rename from docs/resource-policy/node-agent.md rename to docs/resource-policy/configuration.md diff --git a/docs/resource-policy/index.rst b/docs/resource-policy/index.rst index 9fec3e495..521f69907 100644 --- a/docs/resource-policy/index.rst +++ b/docs/resource-policy/index.rst @@ -8,7 +8,7 @@ Resource Policy Plugins introduction.md installation.md setup.md - node-agent.md + configuration.md policy/index.rst developers-guide/index.rst diff --git a/docs/resource-policy/policy/topology-aware.md b/docs/resource-policy/policy/topology-aware.md index 63edba758..44c5e0361 100644 --- a/docs/resource-policy/policy/topology-aware.md +++ b/docs/resource-policy/policy/topology-aware.md @@ -130,11 +130,11 @@ policy: ## Configuring the Policy -The policy has a number of configuration options which affect its default behavior. -These options can be supplied as part of the -[dynamic configuration](../setup.md#using-nri-resource-policy-agent-and-a-configmap) -received via the [`node agent`](../node-agent.md), or in a fallback or forced -configuration file. These configuration options are +The policy has a number of configuration options which affect its default +behavior. These options can be supplied as part of the +[dynamic configuration](../setup.md#dynamic-configuration-with-configmaps) +or in a fallback or forced configuration file. These configuration options +are - `PinCPU` * whether to pin workloads to assigned pool CPU sets diff --git a/docs/resource-policy/setup.md b/docs/resource-policy/setup.md index 6eee35be9..88a2004eb 100644 --- a/docs/resource-policy/setup.md +++ b/docs/resource-policy/setup.md @@ -15,20 +15,18 @@ You can edit it as needed. ## Setting up NRI Resource Policy -### Using NRI Resource Policy Agent and a ConfigMap - -The [NRI Resource Policy Node Agent][agent] can monitor and fetch configuration -from the ConfigMap and pass it on to NRI Resource Policy plugin. -By default, it automatically tries to use the agent to acquire configuration, -unless you override this by forcing a static local configuration using -the `--force-config ` option. -When using the agent, it is also possible to provide an initial fallback for -configuration using the `--fallback-config `. This file is -used before the very first configuration is successfully acquired from the -agent. +### Dynamic configuration with ConfigMaps -See the [Node Agent][agent] about how to set up and configure the agent. +The resource policies plugins support[dynamic configuration][configuration] +using ConfigMaps. Plugins watch changes in the ConfigMap and reconfigure +themselves on any update. Tt is possible to provide an initial fallback for +configuration using the `--fallback-config ` flag. This file is +used before the very first configuration is successfully acquired from the +ConfigMap. +Dynamic configuration can be disabled with a static local configuration using +the `--force-config ` flag. See the [Node Agent][agent] about +how to set up and configure the agent. ## Logging and debugging @@ -58,4 +56,4 @@ the environment but off in the configuration, it will be turned off eventually. -[agent]: node-agent.md +[configuration]: configuration.md