mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat(cli): add enterprise external-workspaces CLI command (#19287)
This pull request introduces support for external workspace management, allowing users to register and manage workspaces that are provisioned and managed outside of the Coder. * coder external-workspaces create - Creates a new external workspace (this command extends coder create) * Example: coder external-workspaces create ext-workspace --template=externally-managed-workspace -y * Checks if template has coder_external_agent resource before creating a workspace * coder external-workspaces list - Lists all external workspaces * coder external-workspaces agent-instructions <workspace name> <agent name> - Retrieves agent connection instruction * Example: coder external-workspaces agent-instructions ext-workspace main --output=json
This commit is contained in:
Kacper Sawicki
+29
@@ -0,0 +1,29 @@
|
||||
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
||||
# external-workspaces
|
||||
|
||||
Create or manage external workspaces
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
coder external-workspaces [flags] [subcommand]
|
||||
```
|
||||
|
||||
## Subcommands
|
||||
|
||||
| Name | Purpose |
|
||||
|--------------------------------------------------------------------------------|--------------------------------------------|
|
||||
| [<code>create</code>](./external-workspaces_create.md) | Create a new external workspace |
|
||||
| [<code>agent-instructions</code>](./external-workspaces_agent-instructions.md) | Get the instructions for an external agent |
|
||||
| [<code>list</code>](./external-workspaces_list.md) | List external workspaces |
|
||||
|
||||
## Options
|
||||
|
||||
### -O, --org
|
||||
|
||||
| | |
|
||||
|-------------|----------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_ORGANIZATION</code> |
|
||||
|
||||
Select which organization (uuid or name) to use.
|
||||
@@ -0,0 +1,21 @@
|
||||
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
||||
# external-workspaces agent-instructions
|
||||
|
||||
Get the instructions for an external agent
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
coder external-workspaces agent-instructions [flags] [user/]workspace[.agent]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
### -o, --output
|
||||
|
||||
| | |
|
||||
|---------|-------------------------|
|
||||
| Type | <code>text\|json</code> |
|
||||
| Default | <code>text</code> |
|
||||
|
||||
Output format.
|
||||
+128
@@ -0,0 +1,128 @@
|
||||
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
||||
# external-workspaces create
|
||||
|
||||
Create a new external workspace
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
coder external-workspaces create [flags] [workspace]
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
```console
|
||||
- Create a workspace for another user (if you have permission):
|
||||
|
||||
$ coder create <username>/<workspace_name>
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
### -t, --template
|
||||
|
||||
| | |
|
||||
|-------------|-----------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
|
||||
|
||||
Specify a template name.
|
||||
|
||||
### --template-version
|
||||
|
||||
| | |
|
||||
|-------------|--------------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
|
||||
|
||||
Specify a template version name.
|
||||
|
||||
### --preset
|
||||
|
||||
| | |
|
||||
|-------------|---------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_PRESET_NAME</code> |
|
||||
|
||||
Specify the name of a template version preset. Use 'none' to explicitly indicate that no preset should be used.
|
||||
|
||||
### --start-at
|
||||
|
||||
| | |
|
||||
|-------------|----------------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
|
||||
|
||||
Specify the workspace autostart schedule. Check coder schedule start --help for the syntax.
|
||||
|
||||
### --stop-after
|
||||
|
||||
| | |
|
||||
|-------------|------------------------------------------|
|
||||
| Type | <code>duration</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
|
||||
|
||||
Specify a duration after which the workspace should shut down (e.g. 8h).
|
||||
|
||||
### --automatic-updates
|
||||
|
||||
| | |
|
||||
|-------------|-------------------------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
|
||||
| Default | <code>never</code> |
|
||||
|
||||
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
|
||||
|
||||
### --copy-parameters-from
|
||||
|
||||
| | |
|
||||
|-------------|----------------------------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
|
||||
|
||||
Specify the source workspace name to copy parameters from.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
| | |
|
||||
|------|-------------------|
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Bypass prompts.
|
||||
|
||||
### --parameter
|
||||
|
||||
| | |
|
||||
|-------------|------------------------------------|
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_RICH_PARAMETER</code> |
|
||||
|
||||
Rich parameter value in the format "name=value".
|
||||
|
||||
### --rich-parameter-file
|
||||
|
||||
| | |
|
||||
|-------------|-----------------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
|
||||
|
||||
Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters.
|
||||
|
||||
### --parameter-default
|
||||
|
||||
| | |
|
||||
|-------------|--------------------------------------------|
|
||||
| Type | <code>string-array</code> |
|
||||
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
|
||||
|
||||
Rich parameter default values in the format "name=value".
|
||||
|
||||
### -O, --org
|
||||
|
||||
| | |
|
||||
|-------------|----------------------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Environment | <code>$CODER_ORGANIZATION</code> |
|
||||
|
||||
Select which organization (uuid or name) to use.
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
||||
# external-workspaces list
|
||||
|
||||
List external workspaces
|
||||
|
||||
Aliases:
|
||||
|
||||
* ls
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
coder external-workspaces list [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
### -a, --all
|
||||
|
||||
| | |
|
||||
|------|-------------------|
|
||||
| Type | <code>bool</code> |
|
||||
|
||||
Specifies whether all workspaces will be listed or not.
|
||||
|
||||
### --search
|
||||
|
||||
| | |
|
||||
|---------|-----------------------|
|
||||
| Type | <code>string</code> |
|
||||
| Default | <code>owner:me</code> |
|
||||
|
||||
Search for a workspace with a query.
|
||||
|
||||
### -c, --column
|
||||
|
||||
| | |
|
||||
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
|
||||
| Default | <code>workspace,template,status,healthy,last built,current version,outdated</code> |
|
||||
|
||||
Columns to display in table output.
|
||||
|
||||
### -o, --output
|
||||
|
||||
| | |
|
||||
|---------|--------------------------|
|
||||
| Type | <code>table\|json</code> |
|
||||
| Default | <code>table</code> |
|
||||
|
||||
Output format.
|
||||
Generated
+46
-45
@@ -22,51 +22,52 @@ Coder — A tool for provisioning self-hosted development environments with Terr
|
||||
|
||||
## Subcommands
|
||||
|
||||
| Name | Purpose |
|
||||
|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [<code>completion</code>](./completion.md) | Install or update shell completion scripts for the detected or chosen shell. |
|
||||
| [<code>dotfiles</code>](./dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
|
||||
| [<code>external-auth</code>](./external-auth.md) | Manage external authentication |
|
||||
| [<code>login</code>](./login.md) | Authenticate with Coder deployment |
|
||||
| [<code>logout</code>](./logout.md) | Unauthenticate your local session |
|
||||
| [<code>netcheck</code>](./netcheck.md) | Print network debug information for DERP and STUN |
|
||||
| [<code>notifications</code>](./notifications.md) | Manage Coder notifications |
|
||||
| [<code>organizations</code>](./organizations.md) | Organization related commands |
|
||||
| [<code>port-forward</code>](./port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
|
||||
| [<code>publickey</code>](./publickey.md) | Output your Coder public key used for Git operations |
|
||||
| [<code>reset-password</code>](./reset-password.md) | Directly connect to the database to reset a user's password |
|
||||
| [<code>state</code>](./state.md) | Manually manage Terraform state to fix broken workspaces |
|
||||
| [<code>templates</code>](./templates.md) | Manage templates |
|
||||
| [<code>tokens</code>](./tokens.md) | Manage personal access tokens |
|
||||
| [<code>users</code>](./users.md) | Manage users |
|
||||
| [<code>version</code>](./version.md) | Show coder version |
|
||||
| [<code>autoupdate</code>](./autoupdate.md) | Toggle auto-update policy for a workspace |
|
||||
| [<code>config-ssh</code>](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh workspace.coder" |
|
||||
| [<code>create</code>](./create.md) | Create a workspace |
|
||||
| [<code>delete</code>](./delete.md) | Delete a workspace |
|
||||
| [<code>favorite</code>](./favorite.md) | Add a workspace to your favorites |
|
||||
| [<code>list</code>](./list.md) | List workspaces |
|
||||
| [<code>open</code>](./open.md) | Open a workspace |
|
||||
| [<code>ping</code>](./ping.md) | Ping a workspace |
|
||||
| [<code>rename</code>](./rename.md) | Rename a workspace |
|
||||
| [<code>restart</code>](./restart.md) | Restart a workspace |
|
||||
| [<code>schedule</code>](./schedule.md) | Schedule automated start and stop times for workspaces |
|
||||
| [<code>show</code>](./show.md) | Display details of a workspace's resources and agents |
|
||||
| [<code>speedtest</code>](./speedtest.md) | Run upload and download tests from your machine to a workspace |
|
||||
| [<code>ssh</code>](./ssh.md) | Start a shell into a workspace or run a command |
|
||||
| [<code>start</code>](./start.md) | Start a workspace |
|
||||
| [<code>stat</code>](./stat.md) | Show resource usage for the current workspace. |
|
||||
| [<code>stop</code>](./stop.md) | Stop a workspace |
|
||||
| [<code>unfavorite</code>](./unfavorite.md) | Remove a workspace from your favorites |
|
||||
| [<code>update</code>](./update.md) | Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first. |
|
||||
| [<code>whoami</code>](./whoami.md) | Fetch authenticated user info for Coder deployment |
|
||||
| [<code>support</code>](./support.md) | Commands for troubleshooting issues with a Coder deployment. |
|
||||
| [<code>server</code>](./server.md) | Start a Coder server |
|
||||
| [<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>prebuilds</code>](./prebuilds.md) | Manage Coder prebuilds |
|
||||
| [<code>provisioner</code>](./provisioner.md) | View and manage provisioner daemons and jobs |
|
||||
| Name | Purpose |
|
||||
|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [<code>completion</code>](./completion.md) | Install or update shell completion scripts for the detected or chosen shell. |
|
||||
| [<code>dotfiles</code>](./dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
|
||||
| [<code>external-auth</code>](./external-auth.md) | Manage external authentication |
|
||||
| [<code>login</code>](./login.md) | Authenticate with Coder deployment |
|
||||
| [<code>logout</code>](./logout.md) | Unauthenticate your local session |
|
||||
| [<code>netcheck</code>](./netcheck.md) | Print network debug information for DERP and STUN |
|
||||
| [<code>notifications</code>](./notifications.md) | Manage Coder notifications |
|
||||
| [<code>organizations</code>](./organizations.md) | Organization related commands |
|
||||
| [<code>port-forward</code>](./port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
|
||||
| [<code>publickey</code>](./publickey.md) | Output your Coder public key used for Git operations |
|
||||
| [<code>reset-password</code>](./reset-password.md) | Directly connect to the database to reset a user's password |
|
||||
| [<code>state</code>](./state.md) | Manually manage Terraform state to fix broken workspaces |
|
||||
| [<code>templates</code>](./templates.md) | Manage templates |
|
||||
| [<code>tokens</code>](./tokens.md) | Manage personal access tokens |
|
||||
| [<code>users</code>](./users.md) | Manage users |
|
||||
| [<code>version</code>](./version.md) | Show coder version |
|
||||
| [<code>autoupdate</code>](./autoupdate.md) | Toggle auto-update policy for a workspace |
|
||||
| [<code>config-ssh</code>](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh workspace.coder" |
|
||||
| [<code>create</code>](./create.md) | Create a workspace |
|
||||
| [<code>delete</code>](./delete.md) | Delete a workspace |
|
||||
| [<code>favorite</code>](./favorite.md) | Add a workspace to your favorites |
|
||||
| [<code>list</code>](./list.md) | List workspaces |
|
||||
| [<code>open</code>](./open.md) | Open a workspace |
|
||||
| [<code>ping</code>](./ping.md) | Ping a workspace |
|
||||
| [<code>rename</code>](./rename.md) | Rename a workspace |
|
||||
| [<code>restart</code>](./restart.md) | Restart a workspace |
|
||||
| [<code>schedule</code>](./schedule.md) | Schedule automated start and stop times for workspaces |
|
||||
| [<code>show</code>](./show.md) | Display details of a workspace's resources and agents |
|
||||
| [<code>speedtest</code>](./speedtest.md) | Run upload and download tests from your machine to a workspace |
|
||||
| [<code>ssh</code>](./ssh.md) | Start a shell into a workspace or run a command |
|
||||
| [<code>start</code>](./start.md) | Start a workspace |
|
||||
| [<code>stat</code>](./stat.md) | Show resource usage for the current workspace. |
|
||||
| [<code>stop</code>](./stop.md) | Stop a workspace |
|
||||
| [<code>unfavorite</code>](./unfavorite.md) | Remove a workspace from your favorites |
|
||||
| [<code>update</code>](./update.md) | Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first. |
|
||||
| [<code>whoami</code>](./whoami.md) | Fetch authenticated user info for Coder deployment |
|
||||
| [<code>support</code>](./support.md) | Commands for troubleshooting issues with a Coder deployment. |
|
||||
| [<code>server</code>](./server.md) | Start a Coder server |
|
||||
| [<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>prebuilds</code>](./prebuilds.md) | Manage Coder prebuilds |
|
||||
| [<code>provisioner</code>](./provisioner.md) | View and manage provisioner daemons and jobs |
|
||||
| [<code>external-workspaces</code>](./external-workspaces.md) | Create or manage external workspaces |
|
||||
|
||||
## Options
|
||||
|
||||
|
||||
Reference in New Issue
Block a user