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
Next Next commit
chore: documenting workspace update issue 
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
  • Loading branch information
@dannykopping
dannykopping committed May 15, 2025
commit b0a86ffa8a55cc77dcc489221b6eb23c01c9a56c
7 changes: 7 additions & 0 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 @@ -169,6 +169,13 @@ 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

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)
and will be addressed before the next release (v2.23). In the interim, a simple workaround is to restart the workspace
when it is in this problematic state.

### Current limitations

The prebuilt workspaces feature has these current limitations:
Expand Down