Skip to content

Commit a10402f

Browse files
committed
s/prebuilds/prebuilt workspaces
1 parent 684ef43 commit a10402f

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

docs/admin/templates/extending-templates/prebuilt-workspaces.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Prebuilt workspaces are:
1919
- **Compatible Terraform provider**: Use `coder/coder` Terraform provider `>= 2.3.0-pre2`. (**TODO: update with latest version**)
2020
- **Feature flag**: Enable the `workspace-prebuilds` [experiment](../../../reference/cli/server.md#--experiments).
2121

22-
## Enable Prebuilds for template presets
22+
## Enable prebuilt workspaces for template presets
2323

2424
In your template, add a `prebuilds` block within a `coder_workspace_preset` block to identify how many prebuilt
2525
instances your Coder deployment should maintain:
@@ -43,42 +43,42 @@ internal reconciliation loop (similar to Kubernetes) to maintain the number of s
4343

4444
Prebuilt workspaces are displayed in the list of workspaces on the Coder dashboard with the owner set to `prebuilds`.
4545

46-
## Prebuild lifecycle
46+
## Prebuilt workspace lifecycle
4747

4848
Prebuilt workspaces follow a specific lifecycle from creation through eligibility to claiming.
4949

5050
Expand each item in this list for more information about the stage:
5151

52-
1. <details><summary>Prebuilds provisioning and initial state</summary>
52+
1. <details><summary>The prebuilt workspace is provisioned.</summary>
5353

54-
After you configure a preset with Prebuilds and publish the template:
54+
After you configure a preset with a prebuilt workspace and publish the template:
5555

5656
1. Coder automatically creates prebuilt workspaces up to the specified `instances` count.
5757
1. Each new prebuild is initially owned by an unprivileged system pseudo-user named `prebuilds`.
5858
- The `prebuilds` user belongs to the `Everyone` group (you can add it to additional groups if needed).
59-
1. Each Prebuild receives a randomly generated name for identification.
59+
1. Each prebuilt workspace receives a randomly generated name for identification.
60+
1. The workspace is provisioned like a regular workspace.
6061

6162
</details>
6263

6364
1. <details><summary>Eligibility process</summary>
6465

6566
Before a prebuilt workspace is available to users:
6667

67-
1. The workspace is provisioned like a regular workspace.
6868
1. The workspace reaches `running` state.
6969
1. The agent connects to coderd.
7070
1. The agent starts its bootstrap procedures and startup scripts complete successfully.
7171
1. The agent reports `ready` status.
7272

73-
Prebuilds that fail during provisioning are retried with an exponential backoff to prevent transient failures.
73+
Prebuilt workspaces that fail during provisioning are retried with an exponential backoff to prevent transient failures.
7474

7575
</details>
7676

7777
1. <details><summary>Claiming process</summary>
7878

7979
When a developer requests a new workspace, the claiming process occurs:
8080

81-
1. Developer selects a template and preset that has Prebuilds configured.
81+
1. Developer selects a template and preset that has prebuilt workspaces configured.
8282
1. If an eligible prebuilt workspace exists, it's automatically assigned to the user.
8383
1. Ownership transfers from the `prebuilds` user to the requesting user.
8484
1. The workspace name changes to the user's requested name.
@@ -96,11 +96,11 @@ You can view available prebuilt workspaces in the **Workspaces** view in the Cod
9696

9797
Prebuilt workspaces have specific behavior when templates are updated:
9898

99-
1. When a template version changes, Prebuilds for old versions are automatically deleted.
100-
1. New Prebuilds are created for the active template version.
101-
1. Prebuilds aren't automatically updated after creation.
99+
1. When a template version changes, prebuilt workspaces for old versions are automatically deleted.
100+
1. New prebuilt workspaces are created for the active template version.
101+
1. Prebuilt workspaces aren't automatically updated after creation.
102102
1. If dependencies change (e.g., an [AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) update) without a template version change, you can:
103-
- Delete the existing Prebuilds manually.
103+
- Delete the existing prebuilt workspaces manually.
104104
- Coder will automatically create new prebuilt workspaces with the updated dependencies.
105105

106106
The system always maintains the desired number of prebuilt workspaces for the active template version.
@@ -109,12 +109,11 @@ The system always maintains the desired number of prebuilt workspaces for the ac
109109

110110
Prebuilt workspaces are tightly integrated with [workspace presets](./parameters.md#workspace-presets-beta):
111111

112-
1. Each Prebuild is associated with a specific template preset.
112+
1. Each prebuilt workspace is associated with a specific template preset.
113113
1. The preset must define all required parameters needed to build the workspace.
114114
1. The preset parameters define the base configuration and are immutable after they're claimed.
115115
1. Parameters that are not defined in the preset can still be customized by users when they claim a workspace.
116116

117-
118117
## Administration and troubleshooting
119118

120119
### Managing resource quotas
@@ -123,7 +122,7 @@ Prebuilt workspaces can be used in conjunction with [resource quotas](../../user
123122
Because unclaimed prebuilt workspaces are owned by the `prebuilds` user, you can:
124123

125124
1. Configure quotas for any group that includes this user.
126-
1. Set appropriate limits to balance Prebuild availability with resource constraints.
125+
1. Set appropriate limits to balance prebuilt workspace availability with resource constraints.
127126

128127
If a quota is exceeded, the prebuilt workspace will fail provisioning the same way other workspaces do.
129128

@@ -208,6 +207,6 @@ Search for `coderd.prebuilds:` in your logs to track the reconciliation loop's b
208207

209208
These logs provide information about:
210209

211-
1. Creation and deletion attempts for prebuilds.
210+
1. Creation and deletion attempts for prebuilt workspaces.
212211
1. Backoff events after failed builds.
213212
1. Claiming operations.

0 commit comments

Comments
 (0)