mirror of
https://github.com/coder/coder.git
synced 2026-06-03 13:08:25 +00:00
Rafael Rodriguez
ad5e6785f4
## Summary In this pull request we're adding support for additional filtering options to the `provisioners list` CLI command and the `/provisionerdaemons` API endpoint. Resolves: https://github.com/coder/coder/issues/18783 ### Changes #### Added CLI Options - `--show-offline`: When this option is provided, all provisioner daemons will be returned. This means that when `--show-offline` is not provided only `idle` and `busy` provisioner daemons will be returned. - `--status=<list_of_statuses>`: When this option is provided with a comma-separated list of valid statuses (`idle`, `busy`, or `offline`) only provisioner daemons that have these statuses will be returned. - `--max-age=<duration>`: When this option is provided with a valid duration value (e.g., `24h`, `30s`) only provisioner daemons with a `last_seen_at` timestamp within the provided max age will be returned. #### Query Params - `?offline=true`: Include offline provisioner daemons in the results. Offline provisioner daemons will be excluded if `?offline=false` or if offline is not provided. - `?status=<list_of_statuses>`: Include provisioner daemons with the specified statuses. - `?max_age=<duration>`: Include provisioner daemons with a `last_seen_at` timestamp within the max age duration. #### Frontend - Since offline provisioners will not be returned by default anymore (`--show-offline` has to be provided to see them), a checkbox was added to the provisioners list page to allow for offline provisioners to be displayed - A revamp of the provisioners page will be done in: https://github.com/coder/coder/issues/17156, this checkbox change was just added to maintain currently functionality with the backend updates Current provisioners page (without checkbox) <img width="1329" height="574" alt="Screenshot 2025-08-20 at 10 51 00 AM" src="https://github.com/user-attachments/assets/77b73650-0b62-44f0-a77f-acbe5710809f" /> Provisioners page with checkbox (unchecked) <img width="1314" height="626" alt="Screenshot 2025-08-20 at 10 48 40 AM" src="https://github.com/user-attachments/assets/7ba164ad-6d3f-417b-bd39-338c0161b145" /> Provisioner page with checkbox (checked) and URL updated with query parameters <img width="1306" height="597" alt="Screenshot 2025-08-20 at 10 50 14 AM" src="https://github.com/user-attachments/assets/e78d0986-bbf8-491b-9d56-b682973237a0" /> ### Show Offline vs Offline Status To list offline provisioner daemons, users can either: 1. Include the `--show-offline` option OR 2. Include `offline` in the list of values provided to the `--status` option
81 lines
3.5 KiB
Markdown
Generated
81 lines
3.5 KiB
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
# provisioner list
|
|
|
|
List provisioner daemons in an organization
|
|
|
|
Aliases:
|
|
|
|
* ls
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder provisioner list [flags]
|
|
```
|
|
|
|
## Options
|
|
|
|
### -l, --limit
|
|
|
|
| | |
|
|
|-------------|--------------------------------------------|
|
|
| Type | <code>int</code> |
|
|
| Environment | <code>$CODER_PROVISIONER_LIST_LIMIT</code> |
|
|
| Default | <code>50</code> |
|
|
|
|
Limit the number of provisioners returned.
|
|
|
|
### -f, --show-offline
|
|
|
|
| | |
|
|
|-------------|----------------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_PROVISIONER_SHOW_OFFLINE</code> |
|
|
|
|
Show offline provisioners.
|
|
|
|
### -s, --status
|
|
|
|
| | |
|
|
|-------------|---------------------------------------------|
|
|
| Type | <code>[offline\|idle\|busy]</code> |
|
|
| Environment | <code>$CODER_PROVISIONER_LIST_STATUS</code> |
|
|
|
|
Filter by provisioner status.
|
|
|
|
### -m, --max-age
|
|
|
|
| | |
|
|
|-------------|----------------------------------------------|
|
|
| Type | <code>duration</code> |
|
|
| Environment | <code>$CODER_PROVISIONER_LIST_MAX_AGE</code> |
|
|
|
|
Filter provisioners by maximum age.
|
|
|
|
### -O, --org
|
|
|
|
| | |
|
|
|-------------|----------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_ORGANIZATION</code> |
|
|
|
|
Select which organization (uuid or name) to use.
|
|
|
|
### -c, --column
|
|
|
|
| | |
|
|
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| Type | <code>[id\|organization id\|created at\|last seen at\|name\|version\|api version\|tags\|key name\|status\|current job id\|current job status\|current job template name\|current job template icon\|current job template display name\|previous job id\|previous job status\|previous job template name\|previous job template icon\|previous job template display name\|organization]</code> |
|
|
| Default | <code>created at,last seen at,key name,name,version,status,tags</code> |
|
|
|
|
Columns to display in table output.
|
|
|
|
### -o, --output
|
|
|
|
| | |
|
|
|---------|--------------------------|
|
|
| Type | <code>table\|json</code> |
|
|
| Default | <code>table</code> |
|
|
|
|
Output format.
|