WIP! feat: log resource replacements when claiming a prebuilt workspace #17571
+1,594
−854
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>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
…replacement(s) Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
dannykopping
commented
Apr 25, 2025
| @@ -1166,5 +1166,5 @@ func (api *API) setupPrebuilds(featureEnabled bool) (agplprebuilds.Reconciliatio | |||
|
|
|||
| reconciler := prebuilds.NewStoreReconciler(api.Database, api.Pubsub, api.DeploymentValues.Prebuilds, | |||
| api.Logger.Named("prebuilds"), quartz.NewReal()) | |||
| return reconciler, prebuilds.EnterpriseClaimer{} | |||
| return reconciler, prebuilds.NewEnterpriseClaimer(api.Database) | |||
There was a problem hiding this comment.
This was an oversight in #17527
| If you’re using prebuilds to speed up provisioning, unexpected replacements will slow down | ||
| workspace startup—even when claiming a prebuilt environment. | ||
|
|
||
| For tips on preventing replacements and improving claim performance, see [this guide](https://coder.com/docs/TODO). |
There was a problem hiding this comment.
TODO: need docs
also a test that was broken from an earlier fix Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
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.
Closes coder/internal#369
When claiming a prebuilt workspace, we run
terraform applya second time (the first being to create the prebuilt workspace initially). This subsequent run can force replacement of resources if the template is not configured correctly. A replacement occurs when an immutable attribute is modified on a resource (i.e. theinitscript of a VM), and therefore it has to be deleted and recreated.Replacements then consequently obviate the point of prebuilt workspaces.
We can't know whether a replacement will take place apriori; we can only detect it at
plantime, because the provider decides whether a resource must be replaced and it cannot be inferred through static analysis of the template.Drift will now be logged in the workspace build logs:
Plus a notification will be sent to template admins when this situation arises: