chore: add prebuild docs #17580
Open
chore: add prebuild docs #17580
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
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
93019ad to
6b75c2e
Compare
1 task
docs/admin/templates/extending-templates/prebuilt-workspaces.md
Outdated
Show resolved
Hide resolved
dannykopping
commented
Apr 29, 2025
There was a problem hiding this comment.
Thanks a lot for your changes @EdwardAngert! This reads much better now.
See my edits: 1c6aee4
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
| 3. A prebuilt workspace is in eligible state | ||
| - User creates a new workspace via the API or the Coder web UI. | ||
| - User selected a preset which has been configured for prebuilds. | ||
| - Prebuilt workspace is in eligible state. |
There was a problem hiding this comment.
Suggested change
| - Prebuilt workspace is in eligible state. | |
| - Prebuilt workspace is in an eligible state. |
| New prebuilt workspaces will be provisioned for the active template version. | ||
|
|
||
| Invalidating prebuilt workspaces is useful when your template version does not change but a referenced dependency does, | ||
| You can invalidate a prebuilt workspace your template version does not change but a referenced dependency does, |
There was a problem hiding this comment.
Suggested change
| You can invalidate a prebuilt workspace your template version does not change but a referenced dependency does, | |
| You may want to invalidate a prebuilt workspace when your template version does not change but a referenced dependency does, |
| @@ -139,7 +140,7 @@ eliminating the value of the prior pre-provisioning. | |||
| Should this occur when a prebuilt workspace is claimed, all Template Admins will receive a notification which will | |||
| link them to the build logs to investigate which resource was being replaced. | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Suggested change
|  | |
|  |
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
cc9c029 to
4b3b0a9
Compare
EdwardAngert
approved these changes
Apr 29, 2025
dannykopping
commented
Apr 29, 2025
docs/admin/templates/extending-templates/prebuilt-workspaces.md
Outdated
Show resolved
Hide resolved
| Instead of creating a new workspace when a developer requests one, if a workspace matches a preset defined in the | ||
| template parameters, Coder assigns an existing instance, reducing setup time significantly. | ||
| The template administrator configures a template to be available with prebuilt workspaces, and then when a developer creates | ||
| a new workspace with matching parameters, Coder assigns them an existing prebuilt instance. |
There was a problem hiding this comment.
Suggested change
| a new workspace with matching parameters, Coder assigns them an existing prebuilt instance. | |
| a new workspace with matching a preset, Coder assigns them an existing prebuilt instance. |
There was a problem hiding this comment.
Suggested change
| a new workspace with matching parameters, Coder assigns them an existing prebuilt instance. | |
| a new workspace that matches the preset, Coder assigns them an existing prebuilt instance. |
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
|
|
||
| Prebuilt workspaces can only be utilized by the default organization. | ||
| _Note: In future releases, we will allow operators to invalidate their prebuilt workspaces programmatically._ |
There was a problem hiding this comment.
This is oddly out of place now.
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
| This is obviously undesirable because the prebuilt workspace will now have to provision _again_, while the user waits, | ||
| eliminating the value of the prior pre-provisioning. | ||
| 1. The workspace is initially created with values from the `prebuilds` user and a random name. | ||
| 1. After claiming, the workspace owner and name change, which Terraform sees as configuration drift. |
There was a problem hiding this comment.
This is too specific. The owner & name change are two of a very large set of possible changes.
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
Co-authored-by: Danny Kopping <danny@coder.com>
|
|
||
| Expand each item in this list for more information about the stage: | ||
|
|
||
| 1. <details><summary>The prebuilt workspace is provisioned.</summary> |
There was a problem hiding this comment.
I don't know how keen I am on this yet.
The goal was to summarize the lifecycle in a way that people can see easily and drill down into for more details if they want. I'm going to try another edit of the summaries to see if I can get it to work, and if it doesn't, I'll revert to separate headings
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Partially addresses coder/internal#593