Add: Checkpoint/restore for pods #1399
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,7 @@ import ( | |||||
| "context" | ||||||
| _ "embed" | ||||||
| "encoding/json" | ||||||
| "errors" | ||||||
| "fmt" | ||||||
| "io" | ||||||
| "log/slog" | ||||||
|
|
@@ -84,14 +85,14 @@ func InitializeCRIUManager(ctx context.Context, config types.CRIUConfig) (CRIUMa | |||||
| return criuManager, nil | ||||||
| } | ||||||
|
|
||||||
| func (s *Worker) attemptCheckpointOrRestore(ctx context.Context, request *types.ContainerRequest, outputLogger *slog.Logger, outputWriter io.Writer, startedChan chan int, checkpointPIDChan chan int, configPath string, exposeNetwork func() error) (int, string, error) { | ||||||
| state, createCheckpoint := s.shouldCreateCheckpoint(request) | ||||||
|
|
||||||
| // If checkpointing is enabled, attempt to create a checkpoint | ||||||
| if createCheckpoint { | ||||||
| outputLogger.Info("Attempting to create container checkpoint...") | ||||||
|
|
||||||
| exitCode, err := s.createCheckpoint(ctx, request, outputWriter, outputLogger, startedChan, checkpointPIDChan, configPath, exposeNetwork) | ||||||
| if err != nil { | ||||||
| return -1, "", err | ||||||
| } | ||||||
|
|
@@ -113,6 +114,11 @@ func (s *Worker) attemptCheckpointOrRestore(ctx context.Context, request *types. | |||||
| } | ||||||
| defer f.Close() | ||||||
|
|
||||||
| err = exposeNetwork() | ||||||
|
Contributor
There was a problem hiding this comment. Network is exposed before a successful restore, potentially allowing premature connections; expose after a successful restore instead. (Based on the PR description stating the worker only exposes ports after checkpoint or restore.) Prompt for AI agents |
||||||
| if err != nil { | ||||||
| return -1, "", fmt.Errorf("failed to expose network: %v", err) | ||||||
|
Contributor
There was a problem hiding this comment. Use %w to wrap underlying error for exposeNetwork failure to preserve error chain. Prompt for AI agents
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| exitCode, err := s.criuManager.RestoreCheckpoint(ctx, &RestoreOpts{ | ||||||
| request: request, | ||||||
| state: state, | ||||||
|
|
@@ -123,31 +129,30 @@ func (s *Worker) attemptCheckpointOrRestore(ctx context.Context, request *types. | |||||
| configPath: configPath, | ||||||
| }) | ||||||
| if err != nil { | ||||||
| var e *runc.ExitError | ||||||
|
Contributor
Author
There was a problem hiding this comment. [TODO]: This logic is not complete. @luke-lombardi I want to chat with you about stop and error conditions related to a running RestoreCheckpoint process. A SIGKILL from container stop event from user would put the checkpoint into a |
||||||
| if errors.As(err, &e) { | ||||||
|
Contributor
There was a problem hiding this comment. Restore failures that are not runc.ExitError won't update checkpoint state or be logged, leaving stale/incorrect state. Prompt for AI agents |
||||||
| code := e.Status | ||||||
|
|
||||||
| if code != 137 { | ||||||
| log.Error().Str("container_id", request.ContainerId).Msgf("failed to restore checkpoint: %v", err) | ||||||
| updateStateErr := s.updateCheckpointState(request, types.CheckpointStatusRestoreFailed) | ||||||
| if updateStateErr != nil { | ||||||
| log.Error().Str("container_id", request.ContainerId).Msgf("failed to update checkpoint state: %v", updateStateErr) | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| return exitCode, "", err | ||||||
| } | ||||||
|
|
||||||
| return exitCode, request.ContainerId, nil | ||||||
| } | ||||||
|
|
||||||
| return -1, "", fmt.Errorf("checkpoint not found") | ||||||
|
Contributor
Author
There was a problem hiding this comment. The parent function already handles this exact intent of running the code without checkpoints as a fallback. This is just duplicated.
Contributor
There was a problem hiding this comment. Missing fallback to normal run when checkpoint is not found; this now returns an error instead of starting the container normally. (Based on the PR description that the worker falls back to a normal run if no checkpoint is found.) Prompt for AI agents |
||||||
| } | ||||||
|
|
||||||
| // Waits for the container to be ready to checkpoint at the desired point in execution, ie. | ||||||
| // after all processes within a container have reached a checkpointable state | ||||||
| func (s *Worker) createCheckpoint(ctx context.Context, request *types.ContainerRequest, outputWriter io.Writer, outputLogger *slog.Logger, startedChan chan int, checkpointPIDChan chan int, configPath string, exposeNetwork func() error) (int, error) { | ||||||
| bundlePath := filepath.Dir(configPath) | ||||||
|
|
||||||
| go func() { | ||||||
|
|
@@ -214,6 +219,11 @@ func (s *Worker) createCheckpoint(ctx context.Context, request *types.ContainerR | |||||
| if updateStateErr != nil { | ||||||
| log.Error().Str("container_id", request.ContainerId).Msgf("failed to update checkpoint state: %v", updateStateErr) | ||||||
| } | ||||||
|
|
||||||
| err = exposeNetwork() | ||||||
|
Contributor
Author
There was a problem hiding this comment. When we are checkpointing, we do not want requests to taint the checkpoint. It should only checkpoint the ready state of the pod and not any running requests. In the case of an API server, the running request would be a connection. |
||||||
| if err != nil { | ||||||
| log.Error().Str("container_id", request.ContainerId).Msgf("failed to expose network: %v", err) | ||||||
| } | ||||||
| }() | ||||||
|
|
||||||
| exitCode, err := s.criuManager.Run(ctx, request, bundlePath, &runc.CreateOpts{ | ||||||
|
|
||||||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding CHECKPOINT_ENABLED to request.Env duplicates the worker-controlled flag and can override it due to merge order; it also ignores the computed effective value (GPU>1), risking inconsistent checkpoint behavior.
Prompt for AI agents