You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/templates/extending-templates/prebuilt-workspaces.md
+32-16Lines changed: 32 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,6 @@
1
1
# Prebuilt workspaces
2
2
3
-
> [!WARNING]
4
-
> Prebuilds Compatibility Limitations:
5
-
> Prebuilt workspaces currently do not work reliably with [DevContainers feature](../managing-templates/devcontainers/index.md).
6
-
> If your project relies on DevContainer configuration, we recommend disabling prebuilds or carefully testing behavior before enabling them.
7
-
>
8
-
> We’re actively working to improve compatibility, but for now, please avoid using prebuilds with this feature to ensure stability and expected behavior.
9
-
10
-
Prebuilt workspaces allow template administrators to improve the developer experience by reducing workspace
3
+
Prebuilt workspaces (prebuilds) allow template administrators to improve the developer experience by reducing workspace
11
4
creation time with an automatically maintained pool of ready-to-use workspaces for specific parameter presets.
12
5
13
6
The template administrator configures a template to provision prebuilt workspaces in the background, and then when a developer creates
@@ -21,6 +14,9 @@ Prebuilt workspaces are:
21
14
- Monitored and replaced automatically to maintain your desired pool size.
22
15
- Automatically scaled based on time-based schedules to optimize resource usage.
23
16
17
+
Currently, Prebuilt workspaces are not fully compatible with the
18
+
[dev containers integration](../extending-templates/devcontainers.md) or with [workspace scheduling features](../../../user-guides/workspace-scheduling.md) like autostart and autostop.
19
+
24
20
## Relationship to workspace presets
25
21
26
22
Prebuilt workspaces are tightly integrated with [workspace presets](./parameters.md#workspace-presets):
@@ -52,7 +48,7 @@ instances your Coder deployment should maintain, and optionally configure a `exp
52
48
prebuilds {
53
49
instances = 3 # Number of prebuilt workspaces to maintain
54
50
expiration_policy {
55
-
ttl = 86400 # Time (in seconds) after which unclaimed prebuilds are expired (1 day)
51
+
ttl = 86400 # Time (in seconds) after which unclaimed prebuilds are expired (86400 = 1 day)
56
52
}
57
53
}
58
54
}
@@ -123,6 +119,10 @@ New prebuilt workspaces are only created to maintain the desired count if needed
123
119
Prebuilt workspaces support time-based scheduling to scale the number of instances up or down.
124
120
This allows you to reduce resource costs during off-hours while maintaining availability during peak usage times.
125
121
122
+
> [!IMPORTANT]
123
+
> Use scheduling for prebuilt workspaces instead of
0 commit comments