Update machine settings information #3772
Conversation
viambot
added
the
safe to build
npentrel
force-pushed
the
updates-fleet
branch
from
6d3a994 to
4e05dd2
Compare
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3772 |
docs/manage/fleet/system-settings.md
Outdated
| - [networks a machine can connect to](#configure-networks) | ||
| - [parameters for operating system logging](#configure-operating-system-logging) | ||
|
|
||
| ## Configure OS package updates |
There was a problem hiding this comment.
I'm unclear why a single field is explained in full three different times, with full json examples for each, when all that changes is one word. Wouldn't it be a lot easier to understand if the field was explained, and then just state that there are three options for "type"?
docs/manage/fleet/system-settings.md
Outdated
| When set, `viam-agent` will install the `unattended-upgrades` package and replace `20auto-upgrades` and `50unattended-upgrades` in <FILE>/etc/apt/apt.conf.d/</FILE> with an Origins-Pattern list generated automatically from configured repositories on the system. | ||
| Custom repos installed on the system at the time the setting is enabled will be included. | ||
|
|
||
| To set automatic upgrades for packages containing `"security"` in their codename (for example `bookworm-security`), add the `upgrades` field to the `agent-syscfg`'s `attributes` object as following. | ||
| You may need to add the `agent-syscfg` object to the `agent` object if it doesn't already exist. |
There was a problem hiding this comment.
Why is this explanation repeated for every option here? Wouldn't it make more sense to just explain the overall purpose once at the top?
docs/manage/fleet/system-settings.md
Outdated
|
|
||
| For complete reference information, see [viam-agent](/configure/agent/#networks). | ||
|
|
||
| ### Example 2 |
There was a problem hiding this comment.
Is this just a stray header?
| To adjust these settings update the `"agent"` value in the machine's JSON configuration. | ||
|
|
||
| For complete reference information, see [viam-agent](/configure/agent/#agent-syscfg). | ||
|
|
There was a problem hiding this comment.
This should probably link to the docs for journald, which better explain what exactly these two fields mean. https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#SystemMaxUse=
| To adjust these settings update the `"agent"` value in the machine's JSON configuration. | ||
|
|
||
| For complete reference information, see [viam-agent](/configure/agent/#agent-syscfg). | ||
|
|
There was a problem hiding this comment.
Should mention that if NOT set, both of these fields are set to 512MB by default (unless disable is set.)
There was a problem hiding this comment.
Does that mean this sentence is wrong or that the moment we set a logging value even if it is empty the value 512 is used?
By default, the operating system defaults determine the disk space that `journald` uses to persist **logs.**
There was a problem hiding this comment.
Correct. We enforce 512MB by default (per request from Eliot) when this is not set, which is typically smaller than most OS defaults. That's why I added the "disable" option to avoid this for people that don't want it changed.
docs/manage/fleet/system-settings.md
Outdated
| You may need to add the `agent-syscfg` object to the `agent` object if it doesn't already exist. | ||
| You can set automatic upgrades for all packages by setting the field value to `{ "type": "all" }`. | ||
| Alternatively, you can set automatic upgrades for only packages containing `"security"` in their codename (for example `bookworm-security`), by setting the field value to `{ "type": "security" }`. | ||
| To disable automatic upgrades, set the field value to `{ "type": "all" }`. |
There was a problem hiding this comment.
| To disable automatic upgrades, set the field value to `{ "type": "all" }`. | |
| To disable automatic upgrades, set the field value to `{ "type": "disabled" }`. |
Co-authored-by: Ale Paredes <[email protected]>
npentrel
force-pushed
the
updates-fleet
branch
from
7943ac2 to
ab7a57b
Compare
Please review https://docs-test.viam.dev/3772/manage/fleet/system-settings/ and the changes to the upgrades description on https://docs-test.viam.dev/3772/manage/reference/agent/#agent-syscfg. Please review for correctness. If any of the described "tasks" should be removed, please let me know.
Ignore any broken links and other pages.