Skip to content

chore: improve prebuilds docs #17850

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 7 commits into from
May 16, 2025
Merged

chore: improve prebuilds docs #17850

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b0a86ff
chore: documenting workspace update issue
dannykopping May 15, 2025
e88569f
chore: document stopped behaviour
dannykopping May 15, 2025
2dc3af8
chore: move back to "transparent" phrasing
dannykopping May 15, 2025
f1cffaa
chore: removing coder/internal reference
dannykopping May 15, 2025
e8634fa
chore: update provider version
dannykopping May 15, 2025
253ce23
chore: apply suggestions from code review
dannykopping May 16, 2025
c38e356
chore: clarify
dannykopping May 16, 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
chore: apply suggestions from code review 
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
  • Loading branch information
@dannykopping @EdwardAngert
dannykopping and EdwardAngert authored May 16, 2025
commit 253ce2308735ec26c25dfd15c466c5b490903c62
8 changes: 4 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 @@ -91,9 +91,9 @@ You can view available prebuilt workspaces in the **Workspaces** view in the Cod
![A prebuilt workspace in the dashboard](../../../images/admin/templates/extend-templates/prebuilt/prebuilt-workspaces.png)
_Note the search term `owner:prebuilds`._

Prebuilt workspaces may be operated on like any other workspace. However, if a prebuilt workspace is stopped, the
reconciliation loop will not destroy it. The intention behind this design is to give operators the ability to park
problematic prebuilt workspaces in a stopped state for further investigation.
Prebuilt workspaces can be maintained and updated in the same way as any other workspace.
However, if a Prebuilt workspace is stopped, the reconciliation loop will not destroy it.
This gives template admins the ability to park problematic prebuilt workspaces in a stopped state for further investigation.

### Template updates and the prebuilt workspace lifecycle

Expand Down Expand Up @@ -173,7 +173,7 @@ For example, the [`ami`](https://registry.terraform.io/providers/hashicorp/aws/l
has [`ForceNew`](https://github.com/hashicorp/terraform-provider-aws/blob/main/internal/service/ec2/ec2_instance.go#L75-L81) set,
since the AMI cannot be changed in-place._

#### Updating claimed prebuilt workspaces' templates
#### Updating claimed prebuilt workspace templates

Once a prebuilt workspace has been claimed, and if its template uses `ignore_changes`, users may run into an issue where the agent
does not reconnect after a template update. This shortcoming is described in [this issue](https://github.com/coder/coder/issues/17840)
Expand Down
Loading