Skip to content

Commit

Permalink
DOCS-3157: Use maintenance window within agent
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel committed Nov 26, 2024
1 parent 647c0bc commit 742a534
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
12 changes: 9 additions & 3 deletions docs/architecture/viam-server.md
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 perfomring these updates until your machine is ready for maintenance, you can define a maintenance window.

Check failure on line 67 in docs/architecture/viam-server.md

View workflow job for this annotation

GitHub Actions / runner / codespell

perfomring ==> performing
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
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

0 comments on commit 742a534

Please sign in to comment.