Skip to content

Commit 3c3d5f3

Browse files
bfjeldsCopilot
andcommitted
docs: add missing commands (rollback, diagnose, stream-disk) and expand get kinds
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f2ed47c commit 3c3d5f3

1 file changed

Lines changed: 49 additions & 2 deletions

File tree

docs/Explanation/Trident-Architecture.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,8 +275,55 @@ consistency, and dependency availability.
275275

276276
### `trident get`
277277

278-
Retrieves the current [Host Configuration, status, or last error](../Reference/Trident-CLI.md#get)
279-
information from the datastore.
278+
Retrieves information from the datastore. The subcommand accepts a `kind`
279+
argument (defaults to `status`):
280+
281+
| Kind | Description |
282+
|------|-------------|
283+
| `status` | Current Host Status (default) |
284+
| `configuration` | Active Host Configuration |
285+
| `last-error` | Last recorded fatal error |
286+
| `rollback-chain` | Full history of available rollback points |
287+
| `rollback-target` | The specific state that would be restored by a rollback |
288+
289+
Output can be directed to a file with `--outfile`.
290+
291+
### `trident rollback`
292+
293+
Triggers a manual rollback to the previous system state. Supports two modes:
294+
295+
1. **Runtime Rollback** (`--runtime`) — Reverts runtime configuration changes
296+
without rebooting. Only available when the last operation was a runtime
297+
update.
298+
2. **A/B Rollback** (`--ab`) — Switches the active/inactive volume pair back,
299+
effectively reverting to the previous OS version. Requires a reboot to take
300+
effect.
301+
302+
A `--check` flag is available to preview what rollback operation would be
303+
performed without executing it. Like `update`, rollback supports
304+
`--allowed-operations` to control stage/finalize phases independently.
305+
306+
Rollback can only be triggered from the `Provisioned`,
307+
`ManualRollbackAbStaged`, or `ManualRollbackRuntimeStaged` servicing states.
308+
309+
### `trident diagnose`
310+
311+
Generates a diagnostic support bundle as a compressed tarball. Collects:
312+
313+
- Trident logs and datastore state
314+
- System information
315+
- Optionally, full system journal and dmesg output (`--journal`)
316+
- Optionally, SELinux audit logs (`--selinux`)
317+
318+
The bundle is saved to the path specified by `--output` and can be shared for
319+
troubleshooting.
320+
321+
### `trident stream-disk` (gRPC client only)
322+
323+
Streams a disk image from a URL directly to the target device. This command is
324+
available only through the gRPC client interface and is used for low-level
325+
image deployment scenarios. Accepts an optional `--hash` parameter for manifest
326+
integrity verification.
280327

281328
## A/B Update Mechanism
282329

0 commit comments

Comments
 (0)