docs: add dev containers and scheduling to prebuilt workspaces known issues #18816
Conversation
EdwardAngert
requested review from
matifali,
the-dietcoke-ofevil,
stirby and
bartekgatzcoder
| @@ -21,6 +14,9 @@ Prebuilt workspaces are: | |||
| - Monitored and replaced automatically to maintain your desired pool size. | |||
| - Automatically scaled based on time-based schedules to optimize resource usage. | |||
|
|
|||
| Currently, Prebuilt workspaces are not fully compatible with the | |||
| [dev containers integration](../extending-templates/devcontainers.md) or with [workspace scheduling features](../../../user-guides/workspace-scheduling.md) like autostart and autostop. | |||
There was a problem hiding this comment.
Currently here makes sense for devcontainers as that will change, but I don't believe we'll ever support autostart or autostop and this implies that we will.
There was a problem hiding this comment.
Yes, it was decided that autostart and autostop won’t ever be supported for prebuilds, since they would conflict with the prebuilds’ own reconciliation loop. I think we can safely remove this mention.
| 2. The schedule that matches the current time becomes active. Overlapping schedules are disallowed by validation rules. | ||
| 3. If no schedules match the current time, the base `instances` count is used. | ||
| 4. The reconciliation loop automatically creates or destroys prebuilt workspaces to match the target count. | ||
| 1. The schedule that matches the current time becomes active. Overlapping schedules are disallowed by validation rules. |
There was a problem hiding this comment.
Is the numbering here correct?
There was a problem hiding this comment.
Yes, I believe it's correct! In Markdown, you can use 1. for all items and the renderers will automatically number them properly.
| @@ -301,6 +301,22 @@ The prebuilt workspaces feature has these current limitations: | |||
|
|
|||
| [View issue](https://github.com/coder/internal/issues/364) | |||
|
|
|||
| - **Dev containers** | |||
There was a problem hiding this comment.
There seems to be some duplication between this and the sections above. Is that intended?
| @@ -21,6 +14,9 @@ Prebuilt workspaces are: | |||
| - Monitored and replaced automatically to maintain your desired pool size. | |||
| - Automatically scaled based on time-based schedules to optimize resource usage. | |||
|
|
|||
| Currently, Prebuilt workspaces are not fully compatible with the | |||
| [dev containers integration](../extending-templates/devcontainers.md) or with [workspace scheduling features](../../../user-guides/workspace-scheduling.md) like autostart and autostop. | |||
There was a problem hiding this comment.
Yes, it was decided that autostart and autostop won’t ever be supported for prebuilds, since they would conflict with the prebuilds’ own reconciliation loop. I think we can safely remove this mention.
| @@ -123,6 +119,10 @@ New prebuilt workspaces are only created to maintain the desired count if needed | |||
| Prebuilt workspaces support time-based scheduling to scale the number of instances up or down. | |||
| This allows you to reduce resource costs during off-hours while maintaining availability during peak usage times. | |||
|
|
|||
| > [!IMPORTANT] | |||
| > Use scheduling for prebuilt workspaces instead of | |||
There was a problem hiding this comment.
I'm not sure we need this important notice 🤔
We’ve essentially split the workspace scheduling features: they now apply only to regular workspaces. Prebuilt workspaces have their own reconciliation loop that handles scheduling independently.
What might be worth highlighting instead is that only once a prebuilt workspace is claimed will it follow the regular workspace scheduling behavior.
| 2. The schedule that matches the current time becomes active. Overlapping schedules are disallowed by validation rules. | ||
| 3. If no schedules match the current time, the base `instances` count is used. | ||
| 4. The reconciliation loop automatically creates or destroys prebuilt workspaces to match the target count. | ||
| 1. The schedule that matches the current time becomes active. Overlapping schedules are disallowed by validation rules. |
There was a problem hiding this comment.
Yes, I believe it's correct! In Markdown, you can use 1. for all items and the renderers will automatically number them properly.
|
|
||
| If your project relies on a dev container configuration, we recommend disabling prebuilds or carefully testing behavior before enabling them. | ||
|
|
||
| - **Workspace autostart/autostop** |
There was a problem hiding this comment.
We should delete this. This is not a limitation, workspace scheduling for prebuilds is handled by the reconciliation loop.
There was a problem hiding this comment.
I lifted this pretty much directly from @bartekgatzcoder 's comment #18806 (comment)
we can talk about the reconciliation loop better, but it seemed like the "known issue" was a main part of the issue
closes #18806
preview