Skip to content

Commit 8539134

Browse files
authored
DOCS-3186: Remove subsystem term from agent docs (#3720)
1 parent 6ea2523 commit 8539134

File tree

3 files changed

+13
-27
lines changed

3 files changed

+13
-27
lines changed

docs/configure/agent.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ date: "2024-08-16"
1313
The [`viam-agent`](https://github.com/viamrobotics/agent) is a self-updating service manager that maintains the lifecycle for itself and the following system services:
1414

1515
- `viam-server`: the core of the machine
16-
- [`agent-provisioning`](#agent-provisioning): device provisioning subsystem that can set up machine configs and manage WiFi networks. For more information see [Provisioning](/fleet/provision/).
16+
- [`agent-provisioning`](#agent-provisioning): device provisioning which can set up machine configs and manage WiFi networks. For more information see [Provisioning](/fleet/provision/).
1717
- [`agent-syscfg`](#agent-syscfg): provides various operating system and system configuration tweaks
1818

1919
Among other things, `viam-agent`:
2020

2121
- Installs, runs, and monitors `viam-server`
2222
You can also use a custom build of `viam-server`, if needed.
23-
- Provides automatic updates for `viam-server`, the agent itself, and any configured subsystems (such as the `agent-provisioning` subsystem).
23+
- Provides automatic updates for `viam-server` and the agent itself.
2424
- Allows control of deployed software versions through the Viam app.
2525

2626
{{< alert title="Support notice" color="note" >}}
@@ -106,16 +106,10 @@ Edit and fill in the attributes as applicable.
106106
}
107107
},
108108
"agent-provisioning": {
109-
"release_channel": "stable",
110-
"pin_version": "",
111-
"pin_url": "",
112109
"disable_subsystem": false,
113110
"networks": []
114111
},
115112
"agent-syscfg": {
116-
"release_channel": "stable",
117-
"pin_version": "",
118-
"pin_url": "",
119113
"disable_subsystem": false
120114
}
121115
}
@@ -174,15 +168,13 @@ Edit and fill in the attributes as applicable.
174168
{{% /tab %}}
175169
{{< /tabs >}}
176170

177-
Each section primarily controls updates for that subsystem:
178-
179171
### `viam-agent`
180172

181173
<!-- prettier-ignore -->
182174
| Option | Type | Required? | Description |
183175
| ------ | ---- | --------- | ----------- |
184176
| `release_channel` | string | Optional | `viam-agent` is semantically versioned and is tested before release. Releases happen infrequently. When set to `"stable"`, `viam-agent` will automatically upgrade when a new version is released. Options: `"stable"` (default). |
185-
| `pin_version` | string | Optional | Lock the subsystem to a specific version (as provided by the release channel). If set, no automatic upgrades will be performed until the setting is updated to a new version (or removed to revert to the release channel). If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
177+
| `pin_version` | string | Optional | Use a specific version for `viam-agent` (as provided by the release channel). If set, no automatic upgrades will be performed until the setting is updated to a new version (or removed to revert to the release channel). If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
186178
| `pin_url` | string | Optional | Ignore normal version selection and directly download from the specified URL. If set, no automatic upgrades will be performed until the setting is updated to a new URL (or removed to revert to the release channel). Typically this is only used for testing/troubleshooting. If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
187179

188180
### `viam-server`
@@ -191,9 +183,9 @@ Each section primarily controls updates for that subsystem:
191183
| Option | Type | Required? | Description |
192184
| ------ | ---- | --------- | ----------- |
193185
| `release_channel` | string | Optional | `viam-agent` is semantically versioned and is tested before release. Releases happen infrequently. When set to `"stable"`, `viam-agent` will automatically upgrade when a new version is released. Options: `"stable"` (default), `"latest"`. |
194-
| `pin_version` | string | Optional | "Lock" the subsystem to a specific version (as provided by the release channel). If set, no automatic upgrades will be performed until the setting is updated to a new version (or removed to revert to the release channel). If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
186+
| `pin_version` | string | Optional | Use a specific version for `viam-server` (as provided by the release channel). If set, no automatic upgrades will be performed until the setting is updated to a new version (or removed to revert to the release channel). If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
195187
| `pin_url` | string | Optional | Ignore normal version selection and directly download from the specified URL. If set, no automatic upgrades will be performed until the setting is updated to a new URL (or removed to revert to the release channel). Typically this is only used for testing/troubleshooting. If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
196-
| `disable_subsystem` | boolean | Optional | When set to `true` it disables the `viam-server` subsystem. |
188+
| `disable_subsystem` | boolean | Optional | When set to `true` it disables the management of `viam-server`. |
197189
| `attributes` | object | Optional | <ul><li>`fast_start`: If set to `true`, `viam-agent` will not wait for a network connection nor check for updates before starting `viam-server`. See [Fast start mode](#fast-start-mode).</li></ul> |
198190

199191
#### Fast start mode
@@ -215,10 +207,7 @@ You can also start `viam-agent` in fast start mode by setting `VIAM_AGENT_FAST_S
215207
<!-- prettier-ignore -->
216208
| Option | Type | Required? | Description |
217209
| ------ | ---- | --------- | ----------- |
218-
| `release_channel` | string | Optional | `agent-provisioning` is semantically versioned and is tested before release. Releases happen infrequently. When set to `"stable"`, `viam-agent` will automatically upgrade when a new version is released. Options: `"stable"` (default), `"latest"`. |
219-
| `pin_version` | string | Optional | Lock the subsystem to a specific version (as provided by the release channel). If set, no automatic upgrades will be performed until the setting is updated to a new version (or removed to revert to the release channel). If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
220-
| `pin_url` | string | Optional | Ignore normal version selection and directly download from the specified URL. If set, no automatic upgrades will be performed until the setting is updated to a new URL (or removed to revert to the release channel). Typically this is only used for testing/troubleshooting. If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
221-
| `disable_subsystem` | boolean | Optional | When set to `true` it disables the `agent-provisioning` subsystem. |
210+
| `disable_subsystem` | boolean | Optional | When set to `true` it disables `agent-provisioning` management. |
222211
| `attributes` | object | Optional | You can override all attributes from the [`viam-agent` configuration file](/fleet/provision/#configuration) here. The [`viam-agent` configuration file](/fleet/provision/#configuration) is generally customized by the manufacturer to provide "out of the box" settings. The attributes configured in the machine config in the Viam app can let you as the machine user override those if you wish. For security purposes, you should change the `hotspot_password`. You can also configure `roaming_mode` and add any additional networks you want to configure. <ul><li>`hotspot_password`: Overwrite the password set for the WiFi hotspot a machine creates during provisioning.</li><li>`networks`: Networks a machine can automatically connect to when roaming mode is enabled. See [Networks](#networks). </li><li>`roaming_mode`: If enabled, lets the machine connect to additional configured networks. See [Networks](#networks). </li><li>`wifi_power_save`: If set, will explicitly enable or disable power save for all WiFi connections managed by NetworkManager. </li></ul> |
223212

224213
#### Networks
@@ -275,15 +264,12 @@ The following configuration defines the connection information and credentials f
275264

276265
### `agent-syscfg`
277266

278-
`agent-syscfg` is a subsystem (plugin) for `viam-agent` that provides a number of system and operating system configuration helpers.
267+
`agent-syscfg` is a plugin for `viam-agent` that provides a number of system and operating system configuration helpers.
279268

280269
<!-- prettier-ignore -->
281270
| Option | Type | Required? | Description |
282271
| ------ | ---- | --------- | ----------- |
283-
| `release_channel` | string | Optional | `agent-syscfg` is semantically versioned and is tested before release. Releases happen infrequently. When set to `"stable"`, `viam-agent` will automatically upgrade when a new version is released. Options: `"stable"` (default), `"latest"`. |
284-
| `pin_version` | string | Optional | "Lock" the subsystem to a specific version (as provided by the release channel). If set, no automatic upgrades will be performed until the setting is updated to a new version (or removed to revert to the release channel). If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
285-
| `pin_url` | string | Optional | Ignore normal version selection and directly download from the specified URL. If set, no automatic upgrades will be performed until the setting is updated to a new URL (or removed to revert to the release channel). Typically this is only used for testing/troubleshooting. If both `pin_url` and `pin_version` is set, `pin_url` will be used. Default: `""`. |
286-
| `disable_subsystem` | boolean | Optional | When set to `true` it disables the `agent-syscfg` subsystem. |
272+
| `disable_subsystem` | boolean | Optional | When set to `true` it disables `agent-syscfg`. |
287273
| `attributes` | object | Optional | <ul><li>`logging`: parameters for logging<ul><li>`system_max_use`: sets the maximum disk space `journald` will user for persistent log storage. Numeric values are in bytes, with optional single letter suffix for larger units, for example. K, M, or G. Default: `512M`.</li><li>`runtime_max_use`: sets the runtime/temporary limit. Numeric values are in bytes, with optional single letter suffix for larger units, for example. K, M, or G. Default: `512M`.</li><li>`disable`: If `false` (default), Viam enforces the given logging configurations. If `true`: Viam does NOT modify logging configuration, and the operating system defaults are used.</li></ul></li><li>`upgrades`: using `upgrades` installs the `unattended-upgrades` package, and replace `20auto-upgrades` and `50unattended-upgrades` in <FILE>/etc/apt/apt.conf.d/</FILE>, with the latter's Origins-Pattern list being generated automatically from configured repositories on the system, so custom repos (at the time the setting is enabled) will be included.<ul><li>`type`: Configured unattended upgrades for Debian bullseye and bookworm. Options: `""` (no effect), `"disable"` (disables automatic upgrades), `"security"` (only enables updates from sources with "security" in their codename, ex: `bookworm-security`), `"all"` (enable updates from all configured sources).</li></ul></li></ul> |
288274

289275
The following configuration allows all upgrades from configured sources and sets the maximum disk space `journald` will user for persistent log storage to 128MB and the runtime limit to 96MB:
@@ -306,7 +292,7 @@ The following configuration allows all upgrades from configured sources and sets
306292

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

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

@@ -337,7 +323,7 @@ You can find these messages on the [**LOGS** tab](/cloud/machines/#logs) of your
337323
`viam-agent` only sends messages when your machine is online and connected to the internet.
338324
If your machine is offline, log messages are queued and are sent to the Viam app once your machine reconnects to the internet.
339325

340-
These log messages include when `viam-server` is stopped and started, the status of agent subsystems, and any errors or warnings encountered during operation.
326+
These log messages include when `viam-server` is stopped and started, the status of `viam-agent`, and any errors or warnings encountered during operation.
341327

342328
## Next Steps
343329

docs/fleet/provision.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ date: "2024-08-16"
1818
You can use Viam's software provisioning manager (`agent-provisioning`), to provision a machine as it first comes online with a pre-defined configuration.
1919
This is useful when deploying a fleet of machines directly from the factory to a customer, or when bundling proprietary software on your Viam machine.
2020

21-
The provisioning subsystem is a feature of [`viam-agent`](/configure/agent/), which you can install as part of your manufacturing process.
21+
Provisioning is a feature of [`viam-agent`](/configure/agent/), which you can install as part of your manufacturing process.
2222
`agent-provisioning` will then perform the rest of the first-time setup for your machine once an [end user sets up the machine](#end-user-experience).
2323

2424
Consider a company that sells machines that monitor weather conditions on a maritime craft and provide navigation advice based on those readings.
2525
Such a machine might use Viam to regularly capture and upload a stream of sensor readings, for example.
2626
To parse the readings and provide tailored guidance to a ship's captain, the company writes their own proprietary application which includes live analytics and speech generation for conveying advice to the captain.
2727

2828
Using `agent-provisioning`, this company can ship their machines directly to customers with `viam-agent` installed.
29-
When a customer sets up their machine, the provisioning subsystem installs `viam-server`.
29+
When a customer sets up their machine, `viam-agent` installs `viam-server`.
3030
By having the end customer set up the machine, the company:
3131

3232
- eliminates per-device setup and individualization at the factory

docs/how-tos/provision-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ date: "2024-08-21"
1515
cost: "0"
1616
---
1717

18-
The provisioning subsystem is a feature of `viam-agent`, which you can install as part of your manufacturing process. `agent-provisioning` will then perform the rest of the first-time setup for your machine once an end user sets up the machine.
18+
Provisioning is a feature of `viam-agent`, which you can install as part of your manufacturing process. `agent-provisioning` will then perform the rest of the first-time setup for your machine once an end user sets up the machine.
1919

2020
This is useful when deploying a fleet of machines directly from the factory to a customer, or when bundling proprietary software on your Viam machine.
2121

0 commit comments

Comments
 (0)