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/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..521f69907 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 + 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