mirror of
https://github.com/fleetdm/fleet
synced 2026-05-24 09:28:54 +00:00
Adding more notes to overrides behavior in agent settings (#9482)
Adding notes on the agent_options.overrides behavior
This commit is contained in:
parent
237a97d07a
commit
980fbcc003
1 changed files with 15 additions and 5 deletions
|
|
@ -998,11 +998,20 @@ spec:
|
||||||
3600: "SELECT total_seconds AS uptime FROM uptime"
|
3600: "SELECT total_seconds AS uptime FROM uptime"
|
||||||
overrides:
|
overrides:
|
||||||
# Note configs in overrides take precedence over the default config defined
|
# Note configs in overrides take precedence over the default config defined
|
||||||
# under the config key above. Hosts receive overrides based on the platform
|
# under the config key above. Be aware that these overrides are NOT merged
|
||||||
# returned by `SELECT platform FROM os_version`. In this example, the base
|
# with the top-level configuration!! This means that settings values defined
|
||||||
# config would be used for Windows and CentOS hosts, while Mac and Ubuntu
|
# on the top-level config.options section will not be propagated to the platform
|
||||||
# hosts would receive their respective overrides. Note, these overrides are
|
# override sections. So for example, the config.options.distributed_interval value
|
||||||
# NOT merged with the top level configuration.
|
# will be discared on a platform override section, and only the section value
|
||||||
|
# for distributed_interval will be used. If the given setting is not specified
|
||||||
|
# in the override section, its default value will be enforced.
|
||||||
|
# Going back to the example, if the override section is windows,
|
||||||
|
# overrides.platforms.windows.distributed_interval will have to be set again to 5
|
||||||
|
# for this setting to be enforced as expected, otherwise the setting will get
|
||||||
|
# its default value (60 in the case of distributed_interval).
|
||||||
|
# Hosts receive overrides based on the platform returned by `SELECT platform FROM os_version`.
|
||||||
|
# In this example, the base config would be used for Windows and CentOS hosts,
|
||||||
|
# while Mac and Ubuntu hosts would receive their respective overrides.
|
||||||
platforms:
|
platforms:
|
||||||
darwin:
|
darwin:
|
||||||
options:
|
options:
|
||||||
|
|
@ -1139,6 +1148,7 @@ The `overrides` key allows you to segment hosts, by their platform, and supply t
|
||||||
|
|
||||||
In the example file below, all Darwin and Ubuntu hosts will **only** receive the options specified in their respective overrides sections.
|
In the example file below, all Darwin and Ubuntu hosts will **only** receive the options specified in their respective overrides sections.
|
||||||
|
|
||||||
|
> IMPORTANT: If a given option is not specified in a platform override section, its default value will be enforced.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
agent_options:
|
agent_options:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue