Skip to content

Commit

Permalink
docs: work on documentation of dyncamic configuration
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
marquiz committed Jun 22, 2023
1 parent cd32157 commit 1fb8d18
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 19 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/resource-policy/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
10 changes: 5 additions & 5 deletions docs/resource-policy/policy/topology-aware.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 11 additions & 13 deletions docs/resource-policy/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <config-file>` option.
When using the agent, it is also possible to provide an initial fallback for
configuration using the `--fallback-config <config-file>`. 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 <config-file>` 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 <config-file>` flag. See the [Node Agent][agent] about
how to set up and configure the agent.

## Logging and debugging

Expand Down Expand Up @@ -58,4 +56,4 @@ the environment but off in the configuration, it will be turned off
eventually.

<!-- Links -->
[agent]: node-agent.md
[configuration]: configuration.md

0 comments on commit 1fb8d18

Please sign in to comment.