docs: add documentation for prebuild scheduling feature #18462
Merged
Conversation
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
21c9c1a to
b92ae48
Compare
b92ae48 to
d26f663
Compare
dannykopping
approved these changes
Jun 20, 2025
docs/admin/templates/extending-templates/prebuilt-workspaces.md
Outdated
Show resolved
Hide resolved
docs/admin/templates/extending-templates/prebuilt-workspaces.md
Outdated
Show resolved
Hide resolved
docs/admin/templates/extending-templates/prebuilt-workspaces.md
Outdated
Show resolved
Hide resolved
matifali
reviewed
Jun 20, 2025
docs/admin/templates/extending-templates/prebuilt-workspaces.md
Outdated
Show resolved
Hide resolved
matifali
reviewed
Jun 20, 2025
docs/admin/templates/extending-templates/prebuilt-workspaces.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Danny Kopping <danny@coder.com>
Co-authored-by: Danny Kopping <danny@coder.com>
Co-authored-by: Danny Kopping <danny@coder.com>
Co-authored-by: Atif Ali <atif@coder.com>
Co-authored-by: Atif Ali <atif@coder.com>
ssncferreira
approved these changes
Jun 20, 2025
| instances = 0 # default to 0 instances | ||
|
|
||
| scheduling { | ||
| timezone = "UTC" # only a single timezone may be used for simplicity |
There was a problem hiding this comment.
nit: add the list of supported timezones
| **How scheduling works:** | ||
|
|
||
| 1. The reconciliation loop evaluates all active schedules every reconciliation interval (`CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL`). | ||
| 2. The schedule that matches the current time becomes active. Overlapping schedules are disallowed by validation rules. |
There was a problem hiding this comment.
small nit:
Suggested change
| 2. The schedule that matches the current time becomes active. Overlapping schedules are disallowed by validation rules. | |
| 2. The schedule matching the current time is considered active. Overlapping schedules are prevented by validation rules. |
|
|
||
| 1. The reconciliation loop evaluates all active schedules every reconciliation interval (`CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL`). | ||
| 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. |
There was a problem hiding this comment.
small nit:
Suggested change
| 3. If no schedules match the current time, the base `instances` count is used. | |
| 3. If no schedule matches the current time, the system defaults to the base `instances` count. |
| Cron expressions follow the format: `* HOUR DOM MONTH DAY-OF-WEEK` | ||
|
|
||
| - `*` (minute): Must always be `*` to ensure the schedule covers entire hours rather than specific minute intervals | ||
| - `HOUR`: 0-23, range (e.g., 8-18 for 8AM-6:59PM), or `*` |
There was a problem hiding this comment.
Maybe use the same time interval for consistency:
Suggested change
| - `HOUR`: 0-23, range (e.g., 8-18 for 8AM-6:59PM), or `*` | |
| - `HOUR`: 8-18, range (e.g., 8-18 for 8AM-6:59PM), or `*` |
| instances = 10 | ||
| } | ||
| schedule { | ||
| cron = "* 19-23,0-7 * * 1,5" # Evenings and nights (7PM-11:59PM, 12AM-7:59AM, Mon-Fri) |
There was a problem hiding this comment.
Wow, it is possible to compose multiple hour intervals? Nice 🤩
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Follow-up to #18126
Changes: