Skip to content

Update os_auto_upgrade_type default to managed-security #5228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremyrose-viam merged 1 commit into from
Jul 29, 2026
+12 −12
Merged

Update os_auto_upgrade_type default to managed-security #5228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/fleet/system-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@ Control automatic operating system package updates on the machine.

In the machine settings card, open **Settings** and expand **System**. Set `os_auto_upgrade_type`:

| Value | Description |
| ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `"all"` | Install all available OS package updates using the OS's built-in upgrade schedule. Debian only. |
| `"security"` | Install security updates only using the OS's built-in upgrade schedule. Debian only. |
| <code style="white-space: nowrap">"managed-all"</code> | Install all available OS package updates on a schedule controlled by `viam-agent`. Works on apt-based, RPM-based, and Windows distributions. |
| <code style="white-space: nowrap">"managed-security"</code> | Install security updates only on a schedule controlled by `viam-agent`. Works on apt-based, RPM-based, and Windows distributions. |
| `"disable"` | Disable automatic OS updates. |
| `""` (empty) | Do not change the system's current update settings. This is the default. |
| Value | Description |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `"all"` | Install all available OS package updates using the OS's built-in upgrade schedule. Debian only. |
| `"security"` | Install security updates only using the OS's built-in upgrade schedule. Debian only. |
| <code style="white-space: nowrap">"managed-all"</code> | Install all available OS package updates on a schedule controlled by `viam-agent`. Works on apt-based, RPM-based, and Windows distributions. |
| <code style="white-space: nowrap">"managed-security"</code> | Install security updates only on a schedule controlled by `viam-agent`. Works on apt-based, RPM-based, and Windows distributions. This is the default. |
| `"disable"` | Disable automatic OS updates. |
| `""` (empty) | Treated as `"managed-security"`. To disable automatic updates, set `"disable"` explicitly. |

Managed modes work on apt-based distributions (Debian, Ubuntu, Raspberry Pi OS), RPM-based distributions (Fedora, RHEL 7+, Rocky Linux, AlmaLinux, CentOS 7), and Windows (using the PSWindowsUpdate PowerShell module).

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/viam-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ In the machine settings card, open **Settings** and expand **System**:

### OS package updates

| Field | Type | Default | Description |
| ----------------------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `os_auto_upgrade_type` | string | `""` | Controls automatic OS package updates. Accepts `"all"`, `"security"`, `"managed-all"`, `"managed-security"`, `"disable"`, or `""` (leave OS defaults). The modes are described below. |
| `os_managed_upgrade_interval_hours` | float | `24` | How often `viam-agent` checks for and installs packages, in hours. Minimum value: `1`. Only applies when `os_auto_upgrade_type` is `"managed-all"` or `"managed-security"`. |
| Field | Type | Default | Description |
| ----------------------------------- | ------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `os_auto_upgrade_type` | string | `"managed-security"` | Controls automatic OS package updates. Accepts `"all"`, `"security"`, `"managed-all"`, `"managed-security"`, `"disable"`, or `""`. If empty or missing, defaults to `"managed-security"`. The modes are described below. |
| `os_managed_upgrade_interval_hours` | float | `24` | How often `viam-agent` checks for and installs packages, in hours. Minimum value: `1`. Only applies when `os_auto_upgrade_type` is `"managed-all"` or `"managed-security"`. |

The `"all"` and `"security"` modes delegate scheduling to the operating system's built-in upgrade timer (`unattended-upgrades` on Debian). The `"managed-all"` and `"managed-security"` modes let `viam-agent` control the upgrade schedule directly, which also enables upgrade support on Ubuntu and RPM-based distributions (Fedora, RHEL, Rocky Linux, AlmaLinux, CentOS).

Expand Down
Loading