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

feat: cli: add support for supplying ephemeral parameters at workspace creation (#26012)

Browse Source 
Resolves the issue of `--prompt-ephemeral-parameters` and
`--ephemeral-parameter` not being available for use in the `coder
create` workspace creation command (they are only available in `coder
start` command). Back when they were [added
originally](https://github.com/coder/coder/pull/15030) it seems to have
been an oversight that they were left out.

The problem this solves:

```
coder create --parameter my_ephemeral_parameter=foo
error: prepare build: ephemeral parameter "my_ephemeral_parameter" can be used only with --prompt-ephemeral-parameters or --ephemeral-parameter flag
```

```
coder create my-test-ws -t general --ephemeral-parameter my_ephemeral_parameter=foo
parsing flags ([create my-test-ws -t general --ephemeral-parameter my_ephemeral_parameter=foo]) for "coder create": unknown flag: --ephemeral-parameter
```

Tested on a template with the following:

```
data "coder_parameter" "my_ephemeral_parameter" {
  name         = "my_ephemeral_parameter"
  type         = "bool"
  description  = "true or false?"
  mutable      = true
  default      = false
  ephemeral    = true
}

resource "coder_env" "debug_ephemeral" {
  agent_id = coder_agent.main.id
  name     = "EPHEMERAL_TEST"
  value    = data.coder_parameter.my_ephemeral_parameter.value
}
```

By running:

```
➜  coder git:(rowan/coder-create-5495) ✗ go run cmd/coder/main.go create --ephemeral-parameter my_ephemeral_parameter=true
> Specify a name for your workspace: ws4
Select a template below to preview the provisioned infrastructure:
?  kasmvnc-ubuntu-coder-dev used by 1 active developer
Select a preset below:
?  Small (2 CPU / 4 GB)
....
...
The ws4 workspace has been created at Jun  3 12:36:38!

➜  coder git:(rowan/coder-create-5495) ✗ coder ssh ws4               
workspace-ws4-5d6994756f-qlwnl% echo $EPHEMERAL_TEST
true
workspace-ws4-5d6994756f-qlwnl% exit
```
This commit is contained in:
Rowan Smith
2026-06-11 09:06:07 +10:00
committed by GitHub
parent 341285cdc7
commit 77522c3945
6 changed files with 140 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/cli/create.md
Generated
+43
View File
@@ -100,6 +100,41 @@ Return immediately after creating the workspace. The build will run in the backg
Bypass confirmation prompts.
### --build-option
| | |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
Build option value in the format "name=value".
### --build-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
Set the value of ephemeral parameters defined in the template. The format is "name=value".
### --prompt-ephemeral-parameters
| | |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for.
### --parameter
| | |
@@ -136,6 +171,14 @@ Rich parameter default values in the format "name=value".
Automatically accept parameter defaults when no value is provided.
### --always-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
### -O, --org
| | |
docs/reference/cli/external-workspaces_create.md
Generated
+43
View File
@@ -100,6 +100,41 @@ Return immediately after creating the workspace. The build will run in the backg
Bypass confirmation prompts.
### --build-option
| | |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
Build option value in the format "name=value".
### --build-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
Set the value of ephemeral parameters defined in the template. The format is "name=value".
### --prompt-ephemeral-parameters
| | |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for.
### --parameter
| | |
@@ -136,6 +171,14 @@ Rich parameter default values in the format "name=value".
Automatically accept parameter defaults when no value is provided.
### --always-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
### -O, --org
| | |