update engine reference docs with latest changes by thaJeztah · Pull Request #13660 · docker/docs

thaJeztah · 2021-10-07T07:18:13Z

netlify · 2021-10-07T07:22:01Z

✔️ Deploy Preview for docsdocker ready!

🔨 Explore the source changes: 373ec2c

🔍 Inspect the deploy log: https://app.netlify.com/sites/docsdocker/deploys/6165fa6dff41db0009d7b37b

😎 Browse the preview: https://deploy-preview-13660--docsdocker.netlify.app

usha-mandya · 2021-10-07T13:53:22Z

+
+ You need at least version 2.0 of CRIU to run checkpoint/restore in Docker.
+
+ ### Use cases for checkpoint & restore


Suggested change
### Use cases for checkpoint & restore
### Use cases for checkpoint and restore

usha-mandya · 2021-10-07T13:53:57Z

+ - "Rewinding" processes to an earlier point in time
+ - "Forensic debugging" of running processes
+
+ Another primary use case of checkpoint & restore outside of Docker is the live


Suggested change
Another primary use case of checkpoint & restore outside of Docker is the live
Another primary use case of checkpoint and restore outside of Docker is the live

usha-mandya · 2021-10-07T13:54:50Z

+ abc0123
+ ```
+
+ This process just logs an incrementing counter to stdout. If you `docker logs`


Suggested change
This process just logs an incrementing counter to stdout. If you `docker logs`
This process just logs an incrementing counter to stdout. If you run `docker logs`

usha-mandya · 2021-10-07T13:55:56Z

+
+ ### Installing CRIU
+
+ If you use a Debian system, you can add the CRIU PPA and install with apt-get


Suggested change
If you use a Debian system, you can add the CRIU PPA and install with apt-get
If you use a Debian system, you can add the CRIU PPA and install with `apt-get`

usha-mandya · 2021-10-07T13:56:22Z

+
+ Alternatively, you can [build CRIU from source](https://criu.org/Installation).
+
+ You need at least version 2.0 of CRIU to run checkpoint/restore in Docker.


Suggested change
You need at least version 2.0 of CRIU to run checkpoint/restore in Docker.
You need at least version 2.0 of CRIU to run checkpoint and restore in Docker.

usha-mandya · 2021-10-07T13:57:03Z

+ - `ls` (lists existing checkpoints)
+ - `rm` (deletes an existing checkpoint)
+
+ Additionally, a `--checkpoint` flag is added to the container start command.


Suggested change
Additionally, a `--checkpoint` flag is added to the container start command.
Additionally, a `--checkpoint` flag is added to the `container start` command.

usha-mandya · 2021-10-07T13:57:52Z

+ --checkpoint-dir Use a custom checkpoint storage directory
+ ```
+
+ And to restore a container:


Suggested change
And to restore a container:
To restore a container:

Ah, looks like I missed this one; will keep that for a follow-up

usha-mandya · 2021-10-07T13:59:57Z

+
+ ### Known limitations
+
+ seccomp is only supported by CRIU in very up to date kernels.


Suggested change
seccomp is only supported by CRIU in very up to date kernels.
seccomp is only supported by CRIU in very up-to-date kernels.

usha-mandya · 2021-10-07T14:00:50Z

Thanks @thaJeztah. LGTM with some minor style and format suggestions

thaJeztah · 2021-10-07T14:11:50Z

I'll have a look at those changes (will have to be made in the cli and backported); this was just a move of an existing file that was already in the CLI, but previously not included in the reference docs

thaJeztah · 2021-10-11T14:36:59Z

I opened docker/cli#3333 and docker/cli#3334 to address the review comments in the docker/cli repository

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah · 2021-10-12T21:13:49Z

@usha-mandya updated with the changes from docker/cli#3334; PTAL

usha-mandya

LGTM

thaJeztah added the area/engine Issue affects Docker engine/daemon label Oct 7, 2021

usha-mandya reviewed Oct 7, 2021
View reviewed changes

thaJeztah mentioned this pull request Oct 11, 2021
docs: some minor touch-ups in checkpoint reference docker/cli#3333
Merged

thaJeztah mentioned this pull request Oct 11, 2021
[20.10 backport] docs fixups docker/cli#3334
Merged

update engine reference docs with latest changes
373ec2c
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah force-pushed the update_engine_reference2 branch from 48a466a to 373ec2cCompare October 12, 2021 21:13

usha-mandya approved these changes Oct 13, 2021
View reviewed changes

usha-mandya merged commit cf83d6d into docker:masterOct 13, 2021

thaJeztah deleted the update_engine_reference2 branch October 13, 2021 15:53


		You need at least version 2.0 of CRIU to run checkpoint/restore in Docker.

		### Use cases for checkpoint & restore

	### Use cases for checkpoint & restore
	### Use cases for checkpoint and restore

	Another primary use case of checkpoint & restore outside of Docker is the live
	Another primary use case of checkpoint and restore outside of Docker is the live

	This process just logs an incrementing counter to stdout. If you `docker logs`
	This process just logs an incrementing counter to stdout. If you run `docker logs`


		### Installing CRIU

		If you use a Debian system, you can add the CRIU PPA and install with apt-get


		Alternatively, you can [build CRIU from source](https://criu.org/Installation).

		You need at least version 2.0 of CRIU to run checkpoint/restore in Docker.

	Additionally, a `--checkpoint` flag is added to the container start command.
	Additionally, a `--checkpoint` flag is added to the `container start` command.


		### Known limitations

		seccomp is only supported by CRIU in very up to date kernels.

Uh oh!

Conversation

thaJeztah commented Oct 7, 2021

Uh oh!

netlifyBot commented Oct 7, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

usha-mandya commented Oct 7, 2021

Uh oh!

thaJeztah commented Oct 7, 2021

Uh oh!

thaJeztah commented Oct 11, 2021

Uh oh!

thaJeztah commented Oct 12, 2021

Uh oh!

usha-mandya left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlifyBot commented Oct 7, 2021•
edited
Loading