mirror of
https://github.com/actions-runner-controller/actions-runner-controller.git
synced 2026-10-18 04:46:03 +02:00
Confirm the finished runner cleanup marker outside the cache before scaling up
The scale-up suppression read Status.FinishedRunnerCleanupPatchID off the EphemeralRunnerSet that Reconcile fetched through the manager's cached client. That marker is written by the cleanup reconcile, and it is the runner deletions performed by that same reconcile which trigger the next one, so the follow-up reconcile is regularly served from an informer cache that has not yet observed the controller's own status write. The marker read as 0, the guard did not fire, and the controller created a replacement runner for a job that had already finished. That is the exact spurious scale up the guard exists to prevent, so it is a correctness problem in a cluster and not only a flaky test. Make the decision from authoritative state. A cached hit still short circuits, because nothing ever clears the marker, so a hit cannot be a false positive. Only a miss falls through to an uncached Get via a new APIReader, which SetupWithManager fills in from mgr.GetAPIReader() so no construction site can forget it. The extra read is confined to scale-up decisions, where the controller is about to issue creates anyway. The window was transient: updateStatus copies the marker from the in-memory object and patches with MergeFrom, so a stale reconcile produces no diff for that field and cannot clobber the recorded value. The envtest spec that caught this only fails under CI load, so the regression is pinned down directly instead. TestScaleUpServicedByFinished RunnerCleanup drives the decision with a lagging cached client and an API reader that already has the write, and asserts the suppression still holds. Pointing the read back at the cached client fails that case and only that case. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
co-authored by
Copilot App
parent
e3656c69ff
commit
dd1e877f9e
@@ -52,6 +52,12 @@ type EphemeralRunnerSetReconciler struct {
|
||||
client.Client
|
||||
Log logr.Logger
|
||||
Scheme *runtime.Scheme
|
||||
// APIReader reads straight from the API server, bypassing the manager's
|
||||
// cache. It is needed where the controller has to observe a status field it
|
||||
// wrote itself in an earlier reconcile, because the informer cache is not
|
||||
// guaranteed to have caught up by the time the next reconcile runs.
|
||||
// SetupWithManager fills this in from the manager when it is left unset.
|
||||
APIReader client.Reader
|
||||
ResourceBuilder
|
||||
}
|
||||
|
||||
@@ -235,7 +241,12 @@ func (r *EphemeralRunnerSetReconciler) Reconcile(ctx context.Context, req ctrl.R
|
||||
// The gap below Spec.Replicas is the one the cleanup above opened for
|
||||
// this patch ID, not new demand. Wait for the listener to publish a
|
||||
// fresh desired state before acting on it.
|
||||
if ephemeralRunnerSet.Spec.PatchID > 0 && ephemeralRunnerSet.Status.FinishedRunnerCleanupPatchID == ephemeralRunnerSet.Spec.PatchID {
|
||||
suppressed, err := r.scaleUpServicedByFinishedRunnerCleanup(ctx, req.NamespacedName, &ephemeralRunnerSet)
|
||||
if err != nil {
|
||||
log.Error(err, "failed to determine whether scale up was already serviced by finished runner cleanup")
|
||||
return ctrl.Result{}, err
|
||||
}
|
||||
if suppressed {
|
||||
log.Info("Skipping scale up until listener publishes a fresh desired state after finished runner cleanup", "patchID", ephemeralRunnerSet.Spec.PatchID)
|
||||
return ctrl.Result{}, r.updateStatus(ctx, &ephemeralRunnerSet, ephemeralRunnersByState, log)
|
||||
}
|
||||
@@ -305,6 +316,43 @@ func (r *EphemeralRunnerSetReconciler) patchAppliedActionableRevisionStatus(ctx
|
||||
})
|
||||
}
|
||||
|
||||
// scaleUpServicedByFinishedRunnerCleanup reports whether the shortfall against
|
||||
// Spec.Replicas was created by this controller cleaning up finished runners for
|
||||
// the patch ID currently in the spec, rather than by new demand from the
|
||||
// listener.
|
||||
//
|
||||
// The marker is written by an earlier reconcile and then read back here, so the
|
||||
// cached copy handed to Reconcile cannot be trusted on its own: deleting the
|
||||
// finished runners triggers watch events that schedule the next reconcile, and
|
||||
// that reconcile can be served from an informer cache that has not yet observed
|
||||
// the controller's own status write. Reading a zero marker there would skip the
|
||||
// suppression and create exactly the unwanted runner this logic exists to
|
||||
// prevent.
|
||||
//
|
||||
// A cached hit is always safe, because nothing clears the marker, so only a miss
|
||||
// falls through to an uncached read. That confines the extra API call to
|
||||
// scale-up decisions, where the controller is about to issue creates anyway.
|
||||
func (r *EphemeralRunnerSetReconciler) scaleUpServicedByFinishedRunnerCleanup(ctx context.Context, key types.NamespacedName, ephemeralRunnerSet *v1alpha1.EphemeralRunnerSet) (bool, error) {
|
||||
if ephemeralRunnerSet.Spec.PatchID == 0 {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
if ephemeralRunnerSet.Status.FinishedRunnerCleanupPatchID == ephemeralRunnerSet.Spec.PatchID {
|
||||
return true, nil
|
||||
}
|
||||
|
||||
if r.APIReader == nil {
|
||||
return false, errors.New("APIReader is not configured, cannot confirm the finished runner cleanup patch ID without reading through the cache")
|
||||
}
|
||||
|
||||
var latest v1alpha1.EphemeralRunnerSet
|
||||
if err := r.APIReader.Get(ctx, key, &latest); err != nil {
|
||||
return false, fmt.Errorf("failed to read EphemeralRunnerSet without the cache: %w", err)
|
||||
}
|
||||
|
||||
return latest.Status.FinishedRunnerCleanupPatchID == ephemeralRunnerSet.Spec.PatchID, nil
|
||||
}
|
||||
|
||||
// patchFinishedRunnerCleanupPatchIDStatus records that finished runners were
|
||||
// deleted while serving patchID, so a later reconcile can tell the resulting gap
|
||||
// below Spec.Replicas apart from genuine new demand.
|
||||
@@ -724,6 +772,10 @@ func (r *EphemeralRunnerSetReconciler) deleteEphemeralRunnerWithActionsClient(ct
|
||||
func (r *EphemeralRunnerSetReconciler) SetupWithManager(mgr ctrl.Manager, opts ...Option) error {
|
||||
r.setSchemeIfUnset(r.Scheme)
|
||||
|
||||
if r.APIReader == nil {
|
||||
r.APIReader = mgr.GetAPIReader()
|
||||
}
|
||||
|
||||
return builderWithOptions(
|
||||
ctrl.NewControllerManagedBy(mgr).
|
||||
For(&v1alpha1.EphemeralRunnerSet{}).
|
||||
|
||||
Reference in New Issue
Block a user