Skip to content

Commit 336ebf3

Browse files
committed
suggestions from review
1 parent 739c4f7 commit 336ebf3

File tree

1 file changed

+20
-34
lines changed

1 file changed

+20
-34
lines changed

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

Lines changed: 20 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Prebuilt workspaces
22

3-
Prebuilt workspaces (prebuilds) reduce workspace creation time with an automatically maintained pool of
3+
Prebuilt workspaces (prebuilds) reduce workspace creation time with an automatically-maintained pool of
44
ready-to-use workspaces.
55

66
The template administrator defines the prebuilt workspace's parameters and number of instances to keep provisioned.
@@ -14,8 +14,8 @@ Prebuilt workspaces are:
1414
- Monitored and replaced automatically to maintain your desired pool size.
1515
- Automatically scaled based on time-based schedules to optimize resource usage.
1616

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.
17+
Prebuilt workspaces are not fully compatible with
18+
[workspace scheduling features](../../../user-guides/workspace-scheduling.md) like autostart and autostop.
1919

2020
## Relationship to workspace presets
2121

@@ -119,10 +119,6 @@ New prebuilt workspaces are only created to maintain the desired count if needed
119119
Prebuilt workspaces support time-based scheduling to scale the number of instances up or down.
120120
This allows you to reduce resource costs during off-hours while maintaining availability during peak usage times.
121121

122-
> [!IMPORTANT]
123-
> Use scheduling for prebuilt workspaces instead of
124-
> [workspace scheduling features](../../../user-guides/workspace-scheduling.md).
125-
126122
Configure scheduling by adding a `scheduling` block within your `prebuilds` configuration:
127123

128124
```tf
@@ -226,7 +222,7 @@ When a template's active version is updated:
226222
1. Prebuilt workspaces for old versions are automatically deleted.
227223
1. New prebuilt workspaces are created for the active template version.
228224
1. If dependencies change (e.g., an [AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) update) without a template version change:
229-
- You may delete the existing prebuilt workspaces manually.
225+
- You can delete the existing prebuilt workspaces manually.
230226
- Coder will automatically create new prebuilt workspaces with the updated dependencies.
231227

232228
The system always maintains the desired number of prebuilt workspaces for the active template version.
@@ -291,32 +287,6 @@ does not reconnect after a template update. This shortcoming is described in [th
291287
and will be addressed before the next release (v2.23). In the interim, a simple workaround is to restart the workspace
292288
when it is in this problematic state.
293289

294-
### Current limitations
295-
296-
The prebuilt workspaces feature has these current limitations:
297-
298-
- **Organizations**
299-
300-
Prebuilt workspaces can only be used with the default organization.
301-
302-
[View issue](https://github.com/coder/internal/issues/364)
303-
304-
- **Dev containers**
305-
306-
Prebuilt workspaces do not work reliably with the [dev containers integration](../extending-templates/devcontainers.md).
307-
308-
If your project relies on a dev container configuration, we recommend disabling prebuilds or carefully testing behavior before enabling them.
309-
310-
- **Workspace autostart/autostop**
311-
312-
Disable any form of [workspace scheduling features](../../../user-guides/workspace-scheduling.md)
313-
like autostart and autostop for prebuilt workspaces.
314-
315-
Instead, use the [prebuilt-specific TTL and scheduling features](#scheduling).
316-
317-
Prebuilt workspaces with an active autostop configuration can lead to "zombie" workspaces that the Coder server
318-
will not automatically reconcile.
319-
320290
### Monitoring and observability
321291

322292
#### Available metrics
@@ -339,3 +309,19 @@ These logs provide information about:
339309
1. Creation and deletion attempts for prebuilt workspaces.
340310
1. Backoff events after failed builds.
341311
1. Claiming operations.
312+
313+
## Known Issues and Limitations
314+
315+
Some known limitations of prebuilt workspaces include:
316+
317+
- **Organizations**
318+
319+
Prebuilt workspaces can only be used with the default organization.
320+
321+
[View issue](https://github.com/coder/internal/issues/364)
322+
323+
- **Dev containers**
324+
325+
Prebuilt workspaces do not work reliably with the [dev containers integration](../extending-templates/devcontainers.md).
326+
327+
If your project relies on a dev container configuration, you should disabling prebuilds or carefully test their behavior before enabling them.

0 commit comments

Comments
 (0)