Method StopDeploymentInner

admin/deployments.go:340–396

StopDeploymentInner stops a deployment by checkpointing it and hibernating its provisioner resources. Persistent state (e.g. the runtime's PVC) is preserved across stop/start so that restarts are fast. The implementation is idempotent, enabling it to be called from a retryable background job.

(ctx context.Context, depl *database.Deployment)

// Persistent state (e.g. the runtime's PVC) is preserved across stop/start so that restarts are fast.
// The implementation is idempotent, enabling it to be called from a retryable background job.
func (s *Service) StopDeploymentInner(ctx context.Context, depl *database.Deployment) error {
	// Connect to the deployment's runtime and checkpoint repo changes if editable.
	// Best effort: if the runtime is unreachable (e.g. already gone or partially torn down), we proceed to hibernate the provisioner resources anyway.
	if depl.Editable {
		rt, err := s.OpenRuntimeClient(depl)
		if err != nil {
			s.Logger.Info("failed to open runtime client for deployment stop", zap.String("deployment_id", depl.ID), zap.String("runtime_instance_id", depl.RuntimeInstanceID), zap.Error(err), observability.ZapCtx(ctx))
		} else {
			defer rt.Close()

			_, err = rt.GitPush(ctx, &runtimev1.GitPushRequest{
				InstanceId:    depl.RuntimeInstanceID,
				CommitMessage: "Auto checkpoint",
			})
			if err != nil {
				s.Logger.Error("failed to checkpoint repo changes", zap.String("deployment_id", depl.ID), zap.String("runtime_instance_id", depl.RuntimeInstanceID), zap.Error(err), observability.ZapCtx(ctx))
			}
		}
	}

	// Hibernate all provisioned resources for the deployment.
	// Hibernation is a lighter-weight alternative to deprovisioning that attempts to preserve persistent state.
	prs, err := s.DB.FindProvisionerResourcesForDeployment(ctx, depl.ID)
	if err != nil {
		return err
	}
	for _, pr := range prs {
		p, ok := s.ProvisionerSet[pr.Provisioner]
		if !ok {
			s.Logger.Warn("provisioner: hibernation skipped, provisioner not found", zap.String("deployment_id", depl.ID), zap.String("provisioner", pr.Provisioner), zap.String("provision_id", pr.ID), observability.ZapCtx(ctx))
			continue
		}

		r, err := p.Hibernate(ctx, &provisioner.Resource{
			ID:     pr.ID,
			Type:   provisioner.ResourceType(pr.Type),
			State:  pr.State,
			Config: pr.Config,
		})
		if err != nil {
			return err
		}

		_, err = s.DB.UpdateProvisionerResource(ctx, pr.ID, &database.UpdateProvisionerResourceOptions{
			Status:        database.ProvisionerResourceStatusOK,
			StatusMessage: "",
			Args:          pr.Args,
			State:         r.State,
			Config:        r.Config,
		})
		if err != nil {
			return err
		}
	}

	return nil
}