8000 docs: add new dynamic parameters information to parameters doc by EdwardAngert · Pull Request #17653 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

docs: add new dynamic parameters information to parameters doc #17653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
May 19, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
corrected dynamic paramters
  • Loading branch information
stirby committed May 16, 2025
commit fa876a621ffc9a739a0b10f8bb605e984feab63d
31 changes: 23 additions & 8 deletions docs/admin/templates/extending-templates/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ data "coder_parameter" "force_rebuild" {

## Validating parameters

Coder supports rich parameters with multiple validation modes: min, max,
Coder supports parameters with multiple validation modes: min, max,
monotonic numbers, and regular expressions.

### Number
Expand Down Expand Up @@ -400,9 +400,10 @@ This feature allows template authors to create more interactive and responsive w

### Enable Dynamic Parameters

To use Dynamic Parameters, enable the experiment flag or set the environment variable. Note that as of v.22.0, Dynamic parameters are an _unsafe_ experiment and will not be enabled by using the experiment wildcard.

<div class="tabs">

To use Dynamic Parameters, enable the experiment flag or set the environment variable:

#### Flag

Expand All @@ -418,8 +419,22 @@ CODER_EXPERIMENTS=dynamic-parameters

</div>

Dynamic Parameters also require version >=2.4.0 of the coder provider. Inject the following at the top of your template after enabling the experiment:

```terraform
terraform {
required_providers {
coder = {
source = "coder/coder"
version = ">=2.4.0"
}
}
}
```


Once enabled, users can toggle between the experimental and classic interfaces during
workspace creation.
workspace creation using an escape hatch in the workspace creation form.

## Features and Capabilities

Expand All @@ -432,12 +447,12 @@ Dynamic Parameters introduces three primary enhancements to the standard paramet
- Modify validation rules conditionally
- Create branching paths in workspace creation forms

- **Dynamic Data Fetching**
- **Reference User Properties**

- Fetch data at workspace creation time
- Access Coder user attributes (groups, username, auth)
- Selectively expose options based on user properties
- Connect to external resources
- Read user data at build time from [`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/workspace_owner)
- Conditionally hide parameters based on user's role
- Change parameter options based on user groups
- Reference user name in parameters

- **Rich Parameter Entry**

Expand Down
Loading
0