Skip to content

Commit a48a2e1

Browse files
authored
DOCS-3157: Use maintenance window within agent (#3703)
1 parent 5c58eff commit a48a2e1

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

docs/architecture/viam-server.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,16 @@ You can also revert to an earlier configuration from the History tab.
5959

6060
#### Maintenance window
6161

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

65-
Add the following configuration to your machine's JSON configuration:
64+
- `viam-agent` updating `viam-server`
65+
- configuration updates
66+
67+
To avoid performing these updates until your machine is ready for maintenance, you can define a maintenance window.
68+
A maintenance window consists of one or multiple conditions that determine if maintenance is currently allowed.
69+
To configure a maintenance window, you need to create a sensor that returns true when your maintenance conditions are met and false otherwise.
70+
71+
Then, add the following configuration to your machine's JSON configuration:
6672

6773
```json
6874
// components: [ ... ],

docs/configure/agent.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -306,8 +306,9 @@ The following configuration allows all upgrades from configured sources and sets
306306

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

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

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

0 commit comments

Comments
 (0)