mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-04-19 09:10:51 +01:00
doc: Add overview of how WA config merging works
This commit is contained in:
parent
aa4dbebcb6
commit
b4b6f949cc
@ -21,7 +21,8 @@ config
|
|||||||
This section is used to provide overall configuration for WA and its run. The
|
This section is used to provide overall configuration for WA and its run. The
|
||||||
``config`` section of an agenda will be merged with any other configuration
|
``config`` section of an agenda will be merged with any other configuration
|
||||||
files provided (including the default config file) and merged with the most
|
files provided (including the default config file) and merged with the most
|
||||||
specific configuration taking precedence.
|
specific configuration taking precedence (see :ref:`here <config-merging>` for
|
||||||
|
more information.
|
||||||
|
|
||||||
Within this section there are multiple distinct types of configuration that can be
|
Within this section there are multiple distinct types of configuration that can be
|
||||||
provided.
|
provided.
|
||||||
|
@ -72,6 +72,31 @@ various assets when it starts.
|
|||||||
scans a very large number of locations; this may also be set to a lower
|
scans a very large number of locations; this may also be set to a lower
|
||||||
value to reduce WA's memory footprint on memory-constrained hosts.
|
value to reduce WA's memory footprint on memory-constrained hosts.
|
||||||
|
|
||||||
|
---------------------
|
||||||
|
|
||||||
.. include:: user_reference/runtime_parameters.rst
|
.. include:: user_reference/runtime_parameters.rst
|
||||||
|
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. _config-merging:
|
||||||
|
|
||||||
|
Configuration Merging
|
||||||
|
---------------------
|
||||||
|
WA configuration can come from various sources of increasing priority, as well
|
||||||
|
as being specified in a generic and specific manner. For example WA's global
|
||||||
|
config file would be considered the least specific vs the parameters of a
|
||||||
|
workload in an agenda which would be the most specific. WA has two rules for the
|
||||||
|
priority of configuration:
|
||||||
|
|
||||||
|
- Configuration from higher priority sources overrides configuration from
|
||||||
|
lower priority sources.
|
||||||
|
- More specific configuration overrides less specific configuration.
|
||||||
|
|
||||||
|
There is a situation where these two rules come into conflict. When a generic
|
||||||
|
configuration is given in config source of high priority and a specific
|
||||||
|
configuration is given in a config source of lower priority. In this situation
|
||||||
|
it is not possible to know the end users intention and WA will error.
|
||||||
|
|
||||||
|
This functionality allows for defaults for plugins, targets etc. to be
|
||||||
|
configured at a global level and then seamless overridden without the need to
|
||||||
|
remove the high level configuration.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user