Skip to content
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

DOCS-3157: Use maintenance window within agent #3703

Merged
merged 2 commits into from
Nov 26, 2024
Merged

DOCS-3157: Use maintenance window within agent #3703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44ee3ed
DOCS-3157: Use maintenance window within agent
npentrel Nov 26, 2024
2ee9af7
Update viam-server.md
npentrel Nov 26, 2024
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
12 changes: 9 additions & 3 deletions docs/architecture/viam-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,16 @@ You can also revert to an earlier configuration from the History tab.

#### Maintenance window

If you only want to apply configuration updates under certain conditions, you can create a sensor with your conditions.
The sensor must return a true value when it is safe to update and a false value otherwise.
There are a few updates that may make your machine temporarily unavailable:

Add the following configuration to your machine's JSON configuration:
- `viam-agent` updating `viam-server`
- configuration updates

To avoid performing these updates until your machine is ready for maintenance, you can define a maintenance window.
A maintenance window consists of one or multiple conditions that determine if maintenance is currently allowed.
To configure a maintenance window, you need to create a sensor that returns true when your maintenance conditions are met and false otherwise.

Then, add the following configuration to your machine's JSON configuration:

```json
// components: [ ... ],
Expand Down
5 changes: 3 additions & 2 deletions docs/configure/agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,9 @@ The following configuration allows all upgrades from configured sources and sets

## Version management for `viam-agent` and `viam-server`

`viam-agent` automatically updates both itself, its subsystems, and `viam-server` as new updates are released.
You can configure update behavior for the Agent and `viam-server` using the [Viam app](https://app.viam.com/).
By default, `viam-agent` automatically updates both itself, its subsystems, and `viam-server` as new updates are released.
You can configure update behavior using the [Viam app](https://app.viam.com/).
To ensure that updates only occur when your machines are ready, configure a [maintenance window](/architecture/viam-server/#maintenance-window).

To use a specific version of `viam-agent` and `viam-server`, you can pin the version.

Expand Down
Loading