8000 chore: add prebuild docs by dannykopping · Pull Request #17580 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

chore: add prebuild docs #17580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
May 9, 2025
Merged

chore: add prebuild docs #17580

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
6b75c2e
chore: prebuild docs
dannykopping Apr 28, 2025
c806859
add prebuilt to manifest; make lint/fmt/gen
EdwardAngert Apr 28, 2025
1ef926a
relative links
EdwardAngert Apr 28, 2025
4b101f3
copy edit
EdwardAngert Apr 28, 2025
8bebe5a
Merge branch 'main' into dk/prebuilds-docs
EdwardAngert Apr 28, 2025
1c6aee4
chore: review comments & additions
dannykopping Apr 29, 2025
5c603db
copy edit
EdwardAngert Apr 29, 2025
4b3b0a9
link to groups roles
EdwardAngert Apr 29, 2025
684ef43
Apply suggestions from code review
EdwardAngert Apr 29, 2025
a10402f
s/prebuilds/prebuilt workspaces
EdwardAngert Apr 29, 2025
850581e
heading edit
EdwardAngert Apr 29, 2025
88f918a
edit prebuilt workspace lifecycle steps
EdwardAngert Apr 30, 2025
470f061
Merge branch 'main' into dk/prebuilds-docs
EdwardAngert May 2, 2025
d95806b
Apply suggestions from code review
EdwardAngert May 5, 2025
6439616
less-specific resource replacement
EdwardAngert May 5, 2025
e4332d7
Merge branch 'main' into dk/prebuilds-docs
EdwardAngert May 5, 2025
ad056d7
Merge branch 'main' of github.com:/coder/coder into dk/prebuilds-docs
dannykopping May 6, 2025
1edc98f
Merge branch 'dk/prebuilds-docs' of github.com:/coder/coder into dk/p…
dannykopping May 6, 2025
dfb7958
fix: copy updates
dannykopping May 6, 2025
596d7a0
md/copy
EdwardAngert May 7, 2025
14998a0
invisible/transparent
EdwardAngert May 7, 2025
ac21df1
chore: update provider version
dannykopping May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
md/copy
  • Loading branch information
@EdwardAngert
EdwardAngert committed May 7, 2025
commit 596d7a0f489ec79c1332cc5a4194ebc03fca07c5
7 changes: 3 additions & 4 deletions docs/admin/templates/extending-templates/prebuilt-workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Prebuilt workspaces are tightly integrated with [workspace presets](./parameters

## Enable prebuilt workspaces for template presets

In your template, add a `prebuilds` block within a `coder_workspace_preset` definition to identify how many prebuilt
In your template, add a `prebuilds` block within a `coder_workspace_preset` definition to identify the number of prebuilt
instances your Coder deployment should maintain:

```hcl
Expand Down Expand Up @@ -71,7 +71,7 @@ Prebuilt workspaces follow a specific lifecycle from creation through eligibilit
1. The agent starts its bootstrap procedures and completes its startup scripts.
1. The agent reports `ready` status.

Only once the agent reports `ready` is the prebuilt workspace considered eligible.
After the agent reports `ready`, the prebuilt workspace considered eligible to be claimed.

Prebuilt workspaces that fail during provisioning are retried with a backoff to prevent transient failures.

Expand All @@ -84,12 +84,11 @@ Prebuilt workspaces follow a specific lifecycle from creation through eligibilit
[`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/workspace_owner)
datasources (see [Preventing resource replacement](#preventing-resource-replacement) for further considerations).

The process is transparent to the developer - they simply see a workspace ready faster than normal.
The process is invisible to the developer - their workspace is ready faster than usual.

You can view available prebuilt workspaces in the **Workspaces** view in the Coder dashboard:

![A prebuilt workspace in the dashboard](../../../images/admin/templates/extend-templates/prebuilt/prebuilt-workspaces.png)

_Note the search term `owner:prebuilds`._

### Template updates and the prebuilt workspace lifecycle
Expand Down
Loading
0