opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: improve provisioner key cli usability (#14834)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/provisioners.md
+3 -3
View File
@@ -26,7 +26,7 @@ For example, running 30 provisioner containers will allow 30 users to start
workspaces at the same time.
Provisioners are started with the
[coder provisionerd start](../reference/cli/provisionerd_start.md) command.
[coder provisionerd start](../reference/cli/provisioner_start.md) command.
## Authentication
@@ -49,7 +49,7 @@ the [Helm example](#example-running-an-external-provisioner-with-helm) below.
Provisioners can broadly be categorized by scope: `organization` or `user`. The
scope of a provisioner can be specified with
[`-tag=scope=<scope>`](../reference/cli/provisionerd_start.md#t---tag) when
[`-tag=scope=<scope>`](../reference/cli/provisioner_start.md#t---tag) when
starting the provisioner daemon. Only users with at least the
[Template Admin](../admin/users.md#roles) role or higher may create
organization-scoped provisioner daemons.
@@ -59,7 +59,7 @@ There are two exceptions:
- [Built-in provisioners](../reference/cli/server.md#provisioner-daemons) are
always organization-scoped.
- External provisioners started using a
[pre-shared key (PSK)](../reference/cli/provisionerd_start.md#psk) are always
[pre-shared key (PSK)](../reference/cli/provisioner_start.md#psk) are always
organization-scoped.
### Organization-Scoped Provisioners
docs/manifest.json
+12 -12
View File
@@ -921,34 +921,34 @@
"path": "reference/cli/port-forward.md"
},
{
"title": "provisionerd",
"title": "provisioner",
"description": "Manage provisioner daemons",
"path": "reference/cli/provisionerd.md"
"path": "reference/cli/provisioner.md"
},
{
"title": "provisionerd keys",
"title": "provisioner keys",
"description": "Manage provisioner keys",
"path": "reference/cli/provisionerd_keys.md"
"path": "reference/cli/provisioner_keys.md"
},
{
"title": "provisionerd keys create",
"title": "provisioner keys create",
"description": "Create a new provisioner key",
"path": "reference/cli/provisionerd_keys_create.md"
"path": "reference/cli/provisioner_keys_create.md"
},
{
"title": "provisionerd keys delete",
"title": "provisioner keys delete",
"description": "Delete a provisioner key",
"path": "reference/cli/provisionerd_keys_delete.md"
"path": "reference/cli/provisioner_keys_delete.md"
},
{
"title": "provisionerd keys list",
"title": "provisioner keys list",
"description": "List provisioner keys in an organization",
"path": "reference/cli/provisionerd_keys_list.md"
"path": "reference/cli/provisioner_keys_list.md"
},
{
"title": "provisionerd start",
"title": "provisioner start",
"description": "Run a provisioner daemon",
"path": "reference/cli/provisionerd_start.md"
"path": "reference/cli/provisioner_start.md"
},
{
"title": "publickey",
docs/reference/api/enterprise.md
Generated
+31 -31
View File
@@ -1609,15 +1609,15 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi
Status Code **200**
| Name | Type | Required | Restrictions | Description |
| ------------------- | ----------------- | -------- | ------------ | ----------- |
| `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | |
| `» id` | string(uuid) | false | | |
| `» name` | string | false | | |
| `» organization` | string(uuid) | false | | |
| `» tags` | object | false | | |
| `»» [any property]` | string | false | | |
| Name | Type | Required | Restrictions | Description |
| ------------------- | -------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | |
| `» id` | string(uuid) | false | | |
| `» name` | string | false | | |
| `» organization` | string(uuid) | false | | |
| `» tags` | [codersdk.ProvisionerKeyTags](schemas.md#codersdkprovisionerkeytags) | false | | |
| `»» [any property]` | string | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
@@ -1725,28 +1725,28 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi
Status Code **200**
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------------------------------------------------------------ | -------- | ------------ | ----------- |
| `[array item]` | array | false | | |
| `» daemons` | array | false | | |
| `»» api_version` | string | false | | |
| `»» created_at` | string(date-time) | false | | |
| `»» id` | string(uuid) | false | | |
| `»» key_id` | string(uuid) | false | | |
| `»» last_seen_at` | string(date-time) | false | | |
| `»» name` | string | false | | |
| `»» organization_id` | string(uuid) | false | | |
| `»» provisioners` | array | false | | |
| `»» tags` | object | false | | |
| `»»» [any property]` | string | false | | |
| `»» version` | string | false | | |
| `» key` | [codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey) | false | | |
| `»» created_at` | string(date-time) | false | | |
| `»» id` | string(uuid) | false | | |
| `»» name` | string | false | | |
| `»» organization` | string(uuid) | false | | |
| `»» tags` | object | false | | |
| `»»» [any property]` | string | false | | |
| Name | Type | Required | Restrictions | Description |
| -------------------- | -------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `[array item]` | array | false | | |
| `» daemons` | array | false | | |
| `»» api_version` | string | false | | |
| `»» created_at` | string(date-time) | false | | |
| `»» id` | string(uuid) | false | | |
| `»» key_id` | string(uuid) | false | | |
| `»» last_seen_at` | string(date-time) | false | | |
| `»» name` | string | false | | |
| `»» organization_id` | string(uuid) | false | | |
| `»» provisioners` | array | false | | |
| `»» tags` | object | false | | |
| `»»» [any property]` | string | false | | |
| `»» version` | string | false | | |
| `» key` | [codersdk.ProvisionerKey](schemas.md#codersdkprovisionerkey) | false | | |
| `»» created_at` | string(date-time) | false | | |
| `»» id` | string(uuid) | false | | |
| `»» name` | string | false | | |
| `»» organization` | string(uuid) | false | | |
| `»» tags` | [codersdk.ProvisionerKeyTags](schemas.md#codersdkprovisionerkeytags) | false | | |
| `»»» [any property]` | string | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
docs/reference/api/schemas.md
Generated
+22 -8
View File
@@ -4176,14 +4176,13 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------ | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `id` | string | false | | |
| `name` | string | false | | |
| `organization` | string | false | | |
| `tags` | object | false | | |
| » `[any property]` | string | false | | |
| Name | Type | Required | Restrictions | Description |
| -------------- | ---------------------------------------------------------- | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `id` | string | false | | |
| `name` | string | false | | |
| `organization` | string | false | | |
| `tags` | [codersdk.ProvisionerKeyTags](#codersdkprovisionerkeytags) | false | | |
## codersdk.ProvisionerKeyDaemons
@@ -4226,6 +4225,21 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o
| `daemons` | array of [codersdk.ProvisionerDaemon](#codersdkprovisionerdaemon) | false | | |
| `key` | [codersdk.ProvisionerKey](#codersdkprovisionerkey) | false | | |
## codersdk.ProvisionerKeyTags
```json
{
"property1": "string",
"property2": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | ------ | -------- | ------------ | ----------- |
| `[any property]` | string | false | | |
## codersdk.ProvisionerLogLevel
```json
docs/reference/cli/README.md
Generated
+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
docs/reference/cli/provisioner.md
Generated
+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 |
docs/reference/cli/provisioner_keys.md
Generated
+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 |
docs/reference/cli/provisionerd_keys_create.md → docs/reference/cli/provisioner_keys_create.md
Generated
+2 -2
View File
@@ -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
docs/reference/cli/provisionerd_keys_delete.md → docs/reference/cli/provisioner_keys_delete.md
Generated
+2 -2
View File
@@ -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
docs/reference/cli/provisionerd_keys_list.md → docs/reference/cli/provisioner_keys_list.md
Generated
+2 -2
View File
@@ -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
docs/reference/cli/provisionerd_start.md → docs/reference/cli/provisioner_start.md
Generated
+11 -2
View File
@@ -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
| | |
docs/reference/cli/provisionerd.md
Generated
-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 |
docs/reference/cli/provisionerd_keys.md
Generated
-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 |