fix: improve provisioner key cli usability (#14834)

What this changes:
- Unhides the `--key` flag on provisioner start
- Deprecates and hides `provisionerd` command group in favor of
`provisioner(s)`
- Removes org id from `coder provisioner keys list`
This commit is contained in:
Garrett Delfosse
2024-09-27 10:34:41 -05:00
committed by GitHub
parent 62047e5f68
commit 5cc5bbea04
30 changed files with 329 additions and 131 deletions
+1 -1
View File
@@ -66,7 +66,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
| [<code>features</code>](./features.md) | List Enterprise features |
| [<code>licenses</code>](./licenses.md) | Add, delete, and list licenses |
| [<code>groups</code>](./groups.md) | Manage groups |
| [<code>provisionerd</code>](./provisionerd.md) | Manage provisioner daemons |
| [<code>provisioner</code>](./provisioner.md) | Manage provisioner daemons |
## Options
+22
View File
@@ -0,0 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner
Manage provisioner daemons
Aliases:
- provisioners
## Usage
```console
coder provisioner
```
## Subcommands
| Name | Purpose |
| -------------------------------------------- | ------------------------ |
| [<code>start</code>](./provisioner_start.md) | Run a provisioner daemon |
| [<code>keys</code>](./provisioner_keys.md) | Manage provisioner keys |
+23
View File
@@ -0,0 +1,23 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys
Manage provisioner keys
Aliases:
- key
## Usage
```console
coder provisioner keys
```
## Subcommands
| Name | Purpose |
| --------------------------------------------------- | ---------------------------------------- |
| [<code>create</code>](./provisioner_keys_create.md) | Create a new provisioner key |
| [<code>list</code>](./provisioner_keys_list.md) | List provisioner keys in an organization |
| [<code>delete</code>](./provisioner_keys_delete.md) | Delete a provisioner key |
@@ -1,13 +1,13 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys create
# provisioner keys create
Create a new provisioner key
## Usage
```console
coder provisionerd keys create [flags] <name>
coder provisioner keys create [flags] <name>
```
## Options
@@ -1,6 +1,6 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys delete
# provisioner keys delete
Delete a provisioner key
@@ -11,7 +11,7 @@ Aliases:
## Usage
```console
coder provisionerd keys delete [flags] <name>
coder provisioner keys delete [flags] <name>
```
## Options
@@ -1,6 +1,6 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys list
# provisioner keys list
List provisioner keys in an organization
@@ -11,7 +11,7 @@ Aliases:
## Usage
```console
coder provisionerd keys list [flags]
coder provisioner keys list [flags]
```
## Options
@@ -1,13 +1,13 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd start
# provisioner start
Run a provisioner daemon
## Usage
```console
coder provisionerd start [flags]
coder provisioner start [flags]
```
## Options
@@ -60,6 +60,15 @@ Deprecated and ignored.
Pre-shared key to authenticate with Coder server.
### --key
| | |
| ----------- | ------------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_KEY</code> |
Provisioner key to authenticate with Coder server.
### --name
| | |
-22
View File
@@ -1,22 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd
Manage provisioner daemons
Aliases:
- provisioner
## Usage
```console
coder provisionerd
```
## Subcommands
| Name | Purpose |
| --------------------------------------------- | ------------------------ |
| [<code>start</code>](./provisionerd_start.md) | Run a provisioner daemon |
| [<code>keys</code>](./provisionerd_keys.md) | Manage provisioner keys |
-23
View File
@@ -1,23 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd keys
Manage provisioner keys
Aliases:
- key
## Usage
```console
coder provisionerd keys
```
## Subcommands
| Name | Purpose |
| ---------------------------------------------------- | ---------------------------------------- |
| [<code>create</code>](./provisionerd_keys_create.md) | Create a new provisioner key |
| [<code>list</code>](./provisionerd_keys_list.md) | List provisioner keys in an organization |
| [<code>delete</code>](./provisionerd_keys_delete.md) | Delete a provisioner key |