Skip to content

checkpoint: support checkpoint create command #4484

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

Jump to bottom
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

checkpoint: support checkpoint create command #4484

wants to merge 9 commits into from
+743 −47

Conversation

ChengyuZhu6
Copy link
Member

Fixes: #4483

@ChengyuZhu6 ChengyuZhu6 mentioned this pull request Aug 20, 2025
Open
4 tasks
@ChengyuZhu6 ChengyuZhu6 added this to the v2.1.5 (?) milestone Aug 29, 2025
@ChengyuZhu6 ChengyuZhu6 force-pushed the checkpoint branch 8 times, most recently from b6e106e to fee41f4 Compare September 1, 2025 11:44
@ChengyuZhu6 ChengyuZhu6 marked this pull request as ready for review September 14, 2025 04:09
@ChengyuZhu6 ChengyuZhu6 force-pushed the checkpoint branch 7 times, most recently from 292ceb4 to c4ed970 Compare September 14, 2025 08:36
@ChengyuZhu6
Copy link
Member Author

ChengyuZhu6 commented Sep 14, 2025 •
edited
Loading 

# nerdctl run -d --name test-container ghcr.io/stargz-containers/alpine:3.13-org sleep infinity
b2a7213fd10f898f5af65493692aa2d1c18b9abd26fc477cc2c302170398987d

# nerdctl checkpoint create --leave-running=true --checkpoint-dir /tmp/test-checkpoints test-container test-checkpoint
test-checkpoint

# ls /tmp/test-checkpoints/test-checkpoint/
cgroup.img        files.img      ipcns-var-11.img    pages-1.img   tmpfs-dev-49.tar.gz.img  tmpfs-dev-55.tar.gz.img
core-1.img        fs-1.img       mm-1.img            pstree.img    tmpfs-dev-52.tar.gz.img  utsns-12.img
descriptors.json  ids-1.img      mountpoints-13.img  seccomp.img   tmpfs-dev-53.tar.gz.img
fdinfo-2.img      inventory.img  pagemap-1.img       timens-0.img  tmpfs-dev-54.tar.gz.img

@ChengyuZhu6 ChengyuZhu6 force-pushed the checkpoint branch 10 times, most recently from 05cc852 to 61e9bac Compare September 15, 2025 02:35
@ChengyuZhu6
Copy link
Member Author 

Error: pkg/taskutil/taskutil.go:51:1: argument-limit: maximum number of arguments per function exceeded; max 12 but got 13 (revive)
func NewTask(ctx context.Context, client *containerd.Client, container containerd.Container,
	attachStreamOpt []string, isInteractive, isTerminal, isDetach bool, con console.Console, logURI, detachKeys, namespace string, detachC chan<- struct{}, checkpointDir string)

We also need to refactor the NewTask function...

@ChengyuZhu6 ChengyuZhu6 force-pushed the checkpoint branch 9 times, most recently from 9cf10d0 to 60e5e2e Compare October 12, 2025 01:56
AkihiroSuda
AkihiroSuda reviewed Oct 12, 2025
View reviewed changes
.github/workflows/job-test-in-container.yml
# Enable IPv6 for Docker, and configure docker to use containerd for gha
sudo mkdir -p /etc/docker
echo '{"ipv6": true, "fixed-cidr-v6": "2001:db8:1::/64", "experimental": true, "ip6tables": true}' | sudo tee /etc/docker/daemon.json
echo '{"ipv6": true, "fixed-cidr-v6": "2001:db8:1::/64", "ip6tables": true}' | sudo tee /etc/docker/daemon.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why set experimental in a separate step?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because "Init: enable Docker experimental features" step will always set experimental to true, there's no need to duplicate this setting in the "Init: ipv6" step. This avoids configuration redundancy and ensures clean configuration logic.

AkihiroSuda
AkihiroSuda reviewed Oct 12, 2025
View reviewed changes
AkihiroSuda
AkihiroSuda reviewed Oct 12, 2025
View reviewed changes
AkihiroSuda
AkihiroSuda reviewed Oct 12, 2025
View reviewed changes
AkihiroSuda
AkihiroSuda reviewed Oct 12, 2025
View reviewed changes
AkihiroSuda
AkihiroSuda reviewed Oct 12, 2025
View reviewed changes
cmd/nerdctl/container/container_start.go
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update docs/command-reference.md

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the doc in the commit: ac3cebc

@ChengyuZhu6
checkpoint: support nerdctl checkpoint create command
e924d71 
- Create checkpoints from running containers using containerd APIs
- Support both leave-running and exit modes via --leave-running flag
- Configurable checkpoint directory via --checkpoint-dir flag

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
checkpoint: add unit tests for checkpoint create command
66f675e 
add unit tests for checkpoint create command.

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
docs: add checkpoint create command reference
5bc25ec 
add checkpoint create command reference.

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
container: add checkpoint restore support to container start
98445d9 
add checkpoint restore support to container start.
e.g.:
$ nerdctl run --name cr -d busybox sleep infinity
$ nerdctl checkpoint create cr checkpoint1
$ nerdctl start --checkpoint checkpoint  cr

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
container: add unit test for container start with checkpoint
1caa8de 
add unit test for container start with checkpoint.

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
docs: add nerdctl start with checkpoint command reference
ac3cebc 
add nerdctl start with checkpoint command reference.

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
ci: install criu dependency
2e9fbdc 
install criu in ci to test checkpoint.

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
taskutil: introduce taskoptions to reduce argument numbers
9bc761c 
introduce taskoptions to reduce argument numbers.
Otherwise, ci would be failed by:
```
Error: pkg/taskutil/taskutil.go:51:1: argument-limit:
maximum number of arguments per function exceeded; max 12 but got 13
func NewTask(ctx context.Context, client *containerd.Client,
container containerd.Container, attachStreamOpt []string,
isInteractive, isTerminal, isDetach bool, con console.Console,
logURI, detachKeys, namespace string, detachC chan<- struct{}, checkpointDir string)
```

Signed-off-by: ChengyuZhu6 <[email protected]>
@ChengyuZhu6
Disable checkpoint/restore unit tests for docker
db6e58f 
Currently, nerdctl CI uses docker 28.0.4, while docker version 28.x
has a known regression that breaks Checkpoint/Restore functionality.
The issue is tracked in the moby/moby project as moby/moby#50750.

Signed-off-by: ChengyuZhu6 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AkihiroSuda AkihiroSuda Awaiting requested review from AkihiroSuda

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v2.1.7

Development

Successfully merging this pull request may close these issues.

Track development: nerdctl checkpoint create

2 participants

@ChengyuZhu6 @AkihiroSuda