-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update machine settings information (#3772)
- Loading branch information
Showing
4 changed files
with
162 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| --- | ||
| linkTitle: "Configure machine settings" | ||
| title: "Configure machine operating system settings" | ||
| weight: 50 | ||
| layout: "docs" | ||
| type: "docs" | ||
| description: "Configure network settings, operating system package updates and logging defaults." | ||
| --- | ||
|
|
||
| The `viam-agent` configuration allows you to configure: | ||
|
|
||
| - [settings for package updates for the host operating system](#configure-os-package-updates) | ||
| - [networks a machine can connect to](#configure-networks) | ||
| - [parameters for operating system logging](#configure-operating-system-logging) | ||
|
|
||
| ## Manage OS package updates | ||
|
|
||
| By default, the configuration in <FILE>/etc/apt/apt.conf.d/</FILE> determines the behavior for updating operating system packages. | ||
| To manage OS package updates using Viam, add an `"agent-syscfg"` object to the `"agent"` object in the machine's JSON configuration, if it doesn't already exist. | ||
| Then, add the `"upgrades"` field in its attributes: | ||
|
|
||
| ```json | ||
| "agent": { | ||
| "agent-syscfg": { | ||
| "release_channel": "stable", | ||
| "attributes": { | ||
| "upgrades": { | ||
| "type": "all|security|disabled" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| When the `type` attribute is specified for `"upgrades"`, `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. | ||
|
|
||
| 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": "disabled" }`. | ||
|
|
||
| For complete reference information, see [viam-agent](/configure/agent/#agent-syscfg). | ||
|
|
||
| ## Configure networks | ||
|
|
||
| By default, your machine can connect to networks added at the operating system level, for example, directly in NetworkManager. | ||
|
|
||
| For an already-online device, you can add new WiFi networks by updating the `"agent"` value in the machine's JSON configuration. | ||
| This is primarily useful for a machine that moves between different networks, so the machine can automatically connect when moved between locations. | ||
|
|
||
| To add networks, add the `networks` field to the `agent-provisioning`'s `attributes` object and set `"roaming_mode": true`. | ||
| You may need to add the `agent-provisioning` object to the `agent` object if it doesn't already exist. | ||
|
|
||
| {{< alert title="Note" color="note" >}} | ||
| If you are using the Viam app to add networks to a machine’s configuration, the machine will need to be connected to the internet to retrieve the configuration information containing the network credentials before it can use them. | ||
| {{< /alert >}} | ||
|
|
||
| The following configuration defines the connection information and credentials for two WiFi networks named `fallbackNetOne` and `fallbackNetTwo`. | ||
| `viam-agent` will try to connect to `fallbackNetOne` first, since its priority is highest. | ||
| If the `fallbackNetOne` is not available or the machine can connect but internet is not available, `viam-agent` will then attempt to connect to `fallbackNetTwo`. | ||
|
|
||
| ```json | ||
| "agent": { | ||
| "agent-provisioning": { | ||
| ... | ||
| "attributes": { | ||
| "roaming_mode": true, | ||
| "networks": [ | ||
| { | ||
| "type": "wifi", | ||
| "ssid": "fallbackNetOne", | ||
| "psk": "myFirstPassword", | ||
| "priority": 30 | ||
| }, | ||
| { | ||
| "type": "wifi", | ||
| "ssid": "fallbackNetTwo", | ||
| "psk": "mySecondPassword", | ||
| "priority": 10 | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| For complete reference information, see [viam-agent](/configure/agent/#networks). | ||
|
|
||
| ## Configure operating system logging | ||
|
|
||
| By default, the maximum disk space `journald` will use for `viam-server` logs is 512MB. | ||
|
|
||
| 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) and the [`journald` docs](https://www.freedesktop.org/software/systemd/man/latest/journald.conf.html#SystemMaxUse=). | ||
|
|
||
| ### Set the maximum disk space | ||
|
|
||
| To set the maximum disk space `journald` will use to persist logs, add the `system_max_use` field to the `agent-syscfg`'s `attributes` object. | ||
| You may need to add the `agent-syscfg` object to the `agent` object if it doesn't already exist. | ||
|
|
||
| The configured values will take precedence over operating system defaults. | ||
|
|
||
| ```json | ||
| "agent": { | ||
| "agent-syscfg": { | ||
| "release_channel": "stable", | ||
| "attributes": { | ||
| "logging": { | ||
| "system_max_use": "512M" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Set the runtime space limit space | ||
|
|
||
| To set the temporary space limit for logs, add the `runtime_max_use` field to the `agent-syscfg`'s `attributes` object. | ||
| You may need to add the `agent-syscfg` object to the `agent` object if it doesn't already exist. | ||
|
|
||
| The configured values will take precedence over operating system defaults. | ||
|
|
||
| ```json | ||
| "agent": { | ||
| "agent-syscfg": { | ||
| "release_channel": "stable", | ||
| "attributes": { | ||
| "logging": { | ||
| "runtime_max_use": "512M" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Use the default operating system settings | ||
|
|
||
| This configuration does not modify the OS-level logging configuration. | ||
|
|
||
| The operating system defaults for `journald` will determine the logging settings. | ||
|
|
||
| ```json | ||
| "agent": { | ||
| "agent-syscfg": { | ||
| "release_channel": "stable", | ||
| "attributes": { | ||
| "logging": { | ||
| "disable": true | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.