Skip to content

fix: close RolloutGate creation race window that allows prod to bypass staging ordering #1

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

Open
LittleChimera wants to merge 1 commit into
base: release-0.1
Choose a base branch
from
Open

fix: close RolloutGate creation race window that allows prod to bypass staging ordering #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 19 additions & 6 deletions internal/controller/githubenvironment_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,15 @@ func (r *GitHubEnvironmentReconciler) Reconcile(ctx context.Context, req ctrl.Re
return ctrl.Result{}, fmt.Errorf("unsupported backend: %s", deployment.Spec.Backend.Type)
}

// Create or update RolloutGate before any GitHub API calls. The gate starts
// blocking immediately (allowedVersions=[]) when a relationship is configured,
// so the rollout controller cannot deploy to this environment before the gate
// has been populated with versions that passed the upstream environment.
if err := r.createOrUpdateRolloutGate(ctx, deployment); err != nil {
log.Error(err, "Failed to create or update RolloutGate")
return ctrl.Result{}, err
}

// Get the referenced Rollout to get the current version
rollout, err := r.getReferencedRollout(ctx, deployment)
if err != nil {
Expand Down Expand Up @@ -131,12 +140,6 @@ func (r *GitHubEnvironmentReconciler) Reconcile(ctx context.Context, req ctrl.Re
return ctrl.Result{}, err
}

// Create or update RolloutGate
if err := r.createOrUpdateRolloutGate(ctx, deployment); err != nil {
log.Error(err, "Failed to create or update RolloutGate")
return ctrl.Result{}, err
}

// Update allowed versions on RolloutGate based on relationships
if err := r.updateAllowedVersionsFromRelationships(ctx, deployment); err != nil {
log.Error(err, "Failed to update allowed versions from relationships")
Expand Down Expand Up @@ -1178,6 +1181,16 @@ func (r *GitHubEnvironmentReconciler) applyRolloutGateDesiredState(rolloutGate *
// Set spec
rolloutGate.Spec.RolloutRef = &deployment.Spec.RolloutRef

// When a relationship is configured, initialize AllowedVersions to an empty
// slice (not nil) so the gate blocks all versions by default until
// updateAllowedVersionsFromRelationships populates it. A nil AllowedVersions
// is treated by the rollout controller as "no restriction", which would allow
// deployments to race through before the gate is fully set up.
if deployment.Spec.Relationship != nil && rolloutGate.Spec.AllowedVersions == nil {
empty := []string{}
rolloutGate.Spec.AllowedVersions = &empty
}

// Set owner reference
if err := ctrl.SetControllerReference(deployment, rolloutGate, r.Scheme); err != nil {
return fmt.Errorf("failed to set owner reference: %w", err)
Expand Down
Loading