mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: add migrations and queries to support prebuilds (#16891)
Depends on https://github.com/coder/coder/pull/16916 _(change base to `main` once it is merged)_ Closes https://github.com/coder/internal/issues/514 _This is one of several PRs to decompose the `dk/prebuilds` feature branch into separate PRs to merge into `main`._ --------- Signed-off-by: Danny Kopping <dannykopping@gmail.com> Co-authored-by: Danny Kopping <dannykopping@gmail.com> Co-authored-by: evgeniy-scherbina <evgeniy.shcherbina.es@gmail.com>
This commit is contained in:
Sas Swart
co-authored by
Danny Kopping
evgeniy-scherbina
Danny Kopping
evgeniy-scherbina
parent
4aa45a5c43
commit
99c6f235eb
@@ -0,0 +1,146 @@
|
||||
-- name: ClaimPrebuiltWorkspace :one
|
||||
UPDATE workspaces w
|
||||
SET owner_id = @new_user_id::uuid,
|
||||
name = @new_name::text,
|
||||
updated_at = NOW()
|
||||
WHERE w.id IN (
|
||||
SELECT p.id
|
||||
FROM workspace_prebuilds p
|
||||
INNER JOIN workspace_latest_builds b ON b.workspace_id = p.id
|
||||
INNER JOIN templates t ON p.template_id = t.id
|
||||
WHERE (b.transition = 'start'::workspace_transition
|
||||
AND b.job_status IN ('succeeded'::provisioner_job_status))
|
||||
-- The prebuilds system should never try to claim a prebuild for an inactive template version.
|
||||
-- Nevertheless, this filter is here as a defensive measure:
|
||||
AND b.template_version_id = t.active_version_id
|
||||
AND p.current_preset_id = @preset_id::uuid
|
||||
AND p.ready
|
||||
LIMIT 1 FOR UPDATE OF p SKIP LOCKED -- Ensure that a concurrent request will not select the same prebuild.
|
||||
)
|
||||
RETURNING w.id, w.name;
|
||||
|
||||
-- name: GetTemplatePresetsWithPrebuilds :many
|
||||
-- GetTemplatePresetsWithPrebuilds retrieves template versions with configured presets and prebuilds.
|
||||
-- It also returns the number of desired instances for each preset.
|
||||
-- If template_id is specified, only template versions associated with that template will be returned.
|
||||
SELECT
|
||||
t.id AS template_id,
|
||||
t.name AS template_name,
|
||||
o.name AS organization_name,
|
||||
tv.id AS template_version_id,
|
||||
tv.name AS template_version_name,
|
||||
tv.id = t.active_version_id AS using_active_version,
|
||||
tvp.id,
|
||||
tvp.name,
|
||||
tvp.desired_instances AS desired_instances,
|
||||
t.deleted,
|
||||
t.deprecated != '' AS deprecated
|
||||
FROM templates t
|
||||
INNER JOIN template_versions tv ON tv.template_id = t.id
|
||||
INNER JOIN template_version_presets tvp ON tvp.template_version_id = tv.id
|
||||
INNER JOIN organizations o ON o.id = t.organization_id
|
||||
WHERE tvp.desired_instances IS NOT NULL -- Consider only presets that have a prebuild configuration.
|
||||
AND (t.id = sqlc.narg('template_id')::uuid OR sqlc.narg('template_id') IS NULL);
|
||||
|
||||
-- name: GetRunningPrebuiltWorkspaces :many
|
||||
SELECT
|
||||
p.id,
|
||||
p.name,
|
||||
p.template_id,
|
||||
b.template_version_id,
|
||||
p.current_preset_id AS current_preset_id,
|
||||
p.ready,
|
||||
p.created_at
|
||||
FROM workspace_prebuilds p
|
||||
INNER JOIN workspace_latest_builds b ON b.workspace_id = p.id
|
||||
WHERE (b.transition = 'start'::workspace_transition
|
||||
AND b.job_status = 'succeeded'::provisioner_job_status);
|
||||
|
||||
-- name: CountInProgressPrebuilds :many
|
||||
-- CountInProgressPrebuilds returns the number of in-progress prebuilds, grouped by template version ID and transition.
|
||||
-- Prebuild considered in-progress if it's in the "starting", "stopping", or "deleting" state.
|
||||
SELECT t.id AS template_id, wpb.template_version_id, wpb.transition, COUNT(wpb.transition)::int AS count
|
||||
FROM workspace_latest_builds wlb
|
||||
INNER JOIN workspace_prebuild_builds wpb ON wpb.id = wlb.id
|
||||
-- We only need these counts for active template versions.
|
||||
-- It doesn't influence whether we create or delete prebuilds
|
||||
-- for inactive template versions. This is because we never create
|
||||
-- prebuilds for inactive template versions, we always delete
|
||||
-- running prebuilds for inactive template versions, and we ignore
|
||||
-- prebuilds that are still building.
|
||||
INNER JOIN templates t ON t.active_version_id = wlb.template_version_id
|
||||
WHERE wlb.job_status IN ('pending'::provisioner_job_status, 'running'::provisioner_job_status)
|
||||
GROUP BY t.id, wpb.template_version_id, wpb.transition;
|
||||
|
||||
-- GetPresetsBackoff groups workspace builds by preset ID.
|
||||
-- Each preset is associated with exactly one template version ID.
|
||||
-- For each group, the query checks up to N of the most recent jobs that occurred within the
|
||||
-- lookback period, where N equals the number of desired instances for the corresponding preset.
|
||||
-- If at least one of the job within a group has failed, we should backoff on the corresponding preset ID.
|
||||
-- Query returns a list of preset IDs for which we should backoff.
|
||||
-- Only active template versions with configured presets are considered.
|
||||
-- We also return the number of failed workspace builds that occurred during the lookback period.
|
||||
--
|
||||
-- NOTE:
|
||||
-- - To **decide whether to back off**, we look at up to the N most recent builds (within the defined lookback period).
|
||||
-- - To **calculate the number of failed builds**, we consider all builds within the defined lookback period.
|
||||
--
|
||||
-- The number of failed builds is used downstream to determine the backoff duration.
|
||||
-- name: GetPresetsBackoff :many
|
||||
WITH filtered_builds AS (
|
||||
-- Only select builds which are for prebuild creations
|
||||
SELECT wlb.template_version_id, wlb.created_at, tvp.id AS preset_id, wlb.job_status, tvp.desired_instances
|
||||
FROM template_version_presets tvp
|
||||
INNER JOIN workspace_latest_builds wlb ON wlb.template_version_preset_id = tvp.id
|
||||
INNER JOIN workspaces w ON wlb.workspace_id = w.id
|
||||
INNER JOIN template_versions tv ON wlb.template_version_id = tv.id
|
||||
INNER JOIN templates t ON tv.template_id = t.id AND t.active_version_id = tv.id
|
||||
WHERE tvp.desired_instances IS NOT NULL -- Consider only presets that have a prebuild configuration.
|
||||
AND wlb.transition = 'start'::workspace_transition
|
||||
AND w.owner_id = 'c42fdf75-3097-471c-8c33-fb52454d81c0'
|
||||
),
|
||||
time_sorted_builds AS (
|
||||
-- Group builds by preset, then sort each group by created_at.
|
||||
SELECT fb.template_version_id, fb.created_at, fb.preset_id, fb.job_status, fb.desired_instances,
|
||||
ROW_NUMBER() OVER (PARTITION BY fb.preset_id ORDER BY fb.created_at DESC) as rn
|
||||
FROM filtered_builds fb
|
||||
),
|
||||
failed_count AS (
|
||||
-- Count failed builds per preset in the given period
|
||||
SELECT preset_id, COUNT(*) AS num_failed
|
||||
FROM filtered_builds
|
||||
WHERE job_status = 'failed'::provisioner_job_status
|
||||
AND created_at >= @lookback::timestamptz
|
||||
GROUP BY preset_id
|
||||
)
|
||||
SELECT
|
||||
tsb.template_version_id,
|
||||
tsb.preset_id,
|
||||
COALESCE(fc.num_failed, 0)::int AS num_failed,
|
||||
MAX(tsb.created_at)::timestamptz AS last_build_at
|
||||
FROM time_sorted_builds tsb
|
||||
LEFT JOIN failed_count fc ON fc.preset_id = tsb.preset_id
|
||||
WHERE tsb.rn <= tsb.desired_instances -- Fetch the last N builds, where N is the number of desired instances; if any fail, we backoff
|
||||
AND tsb.job_status = 'failed'::provisioner_job_status
|
||||
AND created_at >= @lookback::timestamptz
|
||||
GROUP BY tsb.template_version_id, tsb.preset_id, fc.num_failed;
|
||||
|
||||
-- name: GetPrebuildMetrics :many
|
||||
SELECT
|
||||
t.name as template_name,
|
||||
tvp.name as preset_name,
|
||||
o.name as organization_name,
|
||||
COUNT(*) as created_count,
|
||||
COUNT(*) FILTER (WHERE pj.job_status = 'failed'::provisioner_job_status) as failed_count,
|
||||
COUNT(*) FILTER (
|
||||
WHERE w.owner_id != 'c42fdf75-3097-471c-8c33-fb52454d81c0'::uuid -- The system user responsible for prebuilds.
|
||||
) as claimed_count
|
||||
FROM workspaces w
|
||||
INNER JOIN workspace_prebuild_builds wpb ON wpb.workspace_id = w.id
|
||||
INNER JOIN templates t ON t.id = w.template_id
|
||||
INNER JOIN template_version_presets tvp ON tvp.id = wpb.template_version_preset_id
|
||||
INNER JOIN provisioner_jobs pj ON pj.id = wpb.job_id
|
||||
INNER JOIN organizations o ON o.id = w.organization_id
|
||||
WHERE NOT t.deleted AND wpb.build_number = 1
|
||||
GROUP BY t.name, tvp.name, o.name
|
||||
ORDER BY t.name, tvp.name, o.name;
|
||||
@@ -1,8 +1,18 @@
|
||||
-- name: InsertPreset :one
|
||||
INSERT INTO
|
||||
template_version_presets (template_version_id, name, created_at)
|
||||
VALUES
|
||||
(@template_version_id, @name, @created_at) RETURNING *;
|
||||
INSERT INTO template_version_presets (
|
||||
template_version_id,
|
||||
name,
|
||||
created_at,
|
||||
desired_instances,
|
||||
invalidate_after_secs
|
||||
)
|
||||
VALUES (
|
||||
@template_version_id,
|
||||
@name,
|
||||
@created_at,
|
||||
@desired_instances,
|
||||
@invalidate_after_secs
|
||||
) RETURNING *;
|
||||
|
||||
-- name: InsertPresetParameters :many
|
||||
INSERT INTO
|
||||
@@ -38,3 +48,9 @@ FROM
|
||||
INNER JOIN template_version_presets ON template_version_preset_parameters.template_version_preset_id = template_version_presets.id
|
||||
WHERE
|
||||
template_version_presets.template_version_id = @template_version_id;
|
||||
|
||||
-- name: GetPresetByID :one
|
||||
SELECT tvp.*, tv.template_id, tv.organization_id FROM
|
||||
template_version_presets tvp
|
||||
INNER JOIN template_versions tv ON tvp.template_version_id = tv.id
|
||||
WHERE tvp.id = @preset_id;
|
||||
|
||||
Reference in New Issue
Block a user