- Notifications
You must be signed in to change notification settings - Fork928
docs: describe resource ordering in UI#12185
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
10 changes: 5 additions & 5 deletionsdocs/manifest.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -177,6 +177,11 @@ | ||
| "title": "Resource metadata", | ||
| "description": "Show information in the workspace about template resources", | ||
| "path": "./templates/resource-metadata.md" | ||
| }, | ||
| { | ||
| "title": "UI Resource Ordering", | ||
| "description": "Learn how to manage the order of Terraform resources in UI", | ||
| "path": "./templates/resource-ordering.md" | ||
| } | ||
| ] | ||
| }, | ||
| @@ -236,11 +241,6 @@ | ||
| "path": "./templates/process-logging.md", | ||
| "state": "enterprise" | ||
| }, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Looks like this entry is a duplicate. | ||
| { | ||
| "title": "Icons", | ||
| "description": "Coder includes icons for popular cloud providers and programming languages for you to use", | ||
183 changes: 183 additions & 0 deletionsdocs/templates/resource-ordering.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| # UI Resource Ordering | ||
| In Coder templates, managing the order of UI elements is crucial for a seamless | ||
| user experience. This page outlines how resources can be aligned using the | ||
| `order` Terraform property or inherit the natural order from the file. | ||
| The resource with the lower `order` is presented before the one with greater | ||
| value. A missing `order` property defaults to 0. If two resources have the same | ||
| `order` property, the resources will be ordered by property `name` (or `key`). | ||
| ## Using `order` property | ||
| ### Coder parameters | ||
| The `order` property of `coder_parameter` resource allows specifying the order | ||
| of parameters in UI forms. In the below example, `project_id` will appear | ||
| _before_ `account_id`: | ||
| ```hcl | ||
| data "coder_parameter" "project_id" { | ||
| name = "project_id" | ||
| display_name = "Project ID" | ||
| description = "Specify cloud provider project ID." | ||
| order = 2 | ||
| } | ||
| data "coder_parameter" "account_id" { | ||
| name = "account_id" | ||
| display_name = "Account ID" | ||
| description = "Specify cloud provider account ID." | ||
| order = 1 | ||
| } | ||
| ``` | ||
| ### Agents | ||
| Agent resources within the UI left pane are sorted based on the `order` | ||
| property, followed by `name`, ensuring a consistent and intuitive arrangement. | ||
| ```hcl | ||
| resource "coder_agent" "primary" { | ||
| ... | ||
| order = 1 | ||
| } | ||
| resource "coder_agent" "secondary" { | ||
| ... | ||
| order = 2 | ||
| } | ||
| ``` | ||
| The agent with the lowest order is presented at the top in the workspace view. | ||
| ### Agent metadata | ||
| The `coder_agent` exposes metadata to present operational metrics in the UI. | ||
| Metrics defined with Terraform `metadata` blocks can be ordered using additional | ||
| `order` property; otherwise, they are sorted by `key`. | ||
| ```hcl | ||
| resource "coder_agent" "main" { | ||
| ... | ||
| metadata { | ||
| display_name = "CPU Usage" | ||
| key = "cpu_usage" | ||
| script = "coder stat cpu" | ||
| interval = 10 | ||
| timeout = 1 | ||
| order = 1 | ||
| } | ||
| metadata { | ||
| display_name = "CPU Usage (Host)" | ||
| key = "cpu_usage_host" | ||
| script = "coder stat cpu --host" | ||
| interval = 10 | ||
| timeout = 1 | ||
| order = 2 | ||
| } | ||
| metadata { | ||
| display_name = "RAM Usage" | ||
| key = "ram_usage" | ||
| script = "coder stat mem" | ||
| interval = 10 | ||
| timeout = 1 | ||
| order = 1 | ||
| } | ||
| metadata { | ||
| display_name = "RAM Usage (Host)" | ||
| key = "ram_usage_host" | ||
| script = "coder stat mem --host" | ||
| interval = 10 | ||
| timeout = 1 | ||
| order = 2 | ||
| } | ||
| } | ||
| ``` | ||
| ### Applications | ||
| Similarly to Coder agents, `coder_app` resources incorporate the `order` | ||
| property to organize button apps in the app bar within a `coder_agent` in the | ||
| workspace view. | ||
| Only template defined applications can be arranged. _VS Code_ or _Terminal_ | ||
| buttons are static. | ||
| ```hcl | ||
| resource "coder_app" "code-server" { | ||
| agent_id = coder_agent.main.id | ||
| slug = "code-server" | ||
| display_name = "code-server" | ||
| ... | ||
| order = 2 | ||
| } | ||
| resource "coder_app" "filebrowser" { | ||
| agent_id = coder_agent.main.id | ||
| display_name = "File Browser" | ||
| slug = "filebrowser" | ||
| ... | ||
| order = 1 | ||
| } | ||
| ``` | ||
| ## Inherit order from file | ||
| ### Coder parameter options | ||
| The options for Coder parameters maintain the same order as in the file | ||
| structure. This simplifies management and ensures consistency between | ||
| configuration files and UI presentation. | ||
| ```hcl | ||
| data "coder_parameter" "database_region" { | ||
| name = "database_region" | ||
| display_name = "Database Region" | ||
| icon = "/icon/database.svg" | ||
| description = "These are options." | ||
| mutable = true | ||
| default = "us-east1-a" | ||
| // The order of options is stable and inherited from .tf file. | ||
| option { | ||
| name = "US Central" | ||
| description = "Select for central!" | ||
| value = "us-central1-a" | ||
| } | ||
| option { | ||
| name = "US East" | ||
| description = "Select for east!" | ||
| value = "us-east1-a" | ||
| } | ||
| ... | ||
| } | ||
| ``` | ||
| ### Coder metadata items | ||
| In cases where multiple item properties exist, the order is inherited from the | ||
| file, facilitating seamless integration between a Coder template and UI | ||
| presentation. | ||
| ```hcl | ||
| resource "coder_metadata" "attached_volumes" { | ||
| resource_id = docker_image.main.id | ||
| // Items will be presented in the UI in the following order. | ||
| item { | ||
| key = "disk-a" | ||
| value = "60 GiB" | ||
| } | ||
| item { | ||
| key = "disk-b" | ||
| value = "128 GiB" | ||
| } | ||
| } | ||
| ``` |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.