From f18a8f958187aa52d028d1e3cc3dc0c03b742fed Mon Sep 17 00:00:00 2001 From: Adin Scannell Date: Tue, 9 Apr 2019 10:19:17 -0700 Subject: Update README.md to point to gvisor.dev PiperOrigin-RevId: 242690968 Change-Id: I1ac2248b5ab3bcd95beed52ecddbb9f34eeb3775 --- g3doc/Layers.png | Bin 11044 -> 0 bytes g3doc/Layers.svg | 1 - g3doc/Machine-Virtualization.png | Bin 13205 -> 0 bytes g3doc/Machine-Virtualization.svg | 1 - g3doc/Rule-Based-Execution.png | Bin 6780 -> 0 bytes g3doc/Rule-Based-Execution.svg | 1 - g3doc/Sentry-Gofer.png | Bin 9064 -> 0 bytes g3doc/Sentry-Gofer.svg | 1 - g3doc/checkpoint_restore.md | 108 --------------------------------------- g3doc/logo.png | Bin 0 -> 27719 bytes 10 files changed, 112 deletions(-) delete mode 100644 g3doc/Layers.png delete mode 100644 g3doc/Layers.svg delete mode 100644 g3doc/Machine-Virtualization.png delete mode 100644 g3doc/Machine-Virtualization.svg delete mode 100644 g3doc/Rule-Based-Execution.png delete mode 100644 g3doc/Rule-Based-Execution.svg delete mode 100644 g3doc/Sentry-Gofer.png delete mode 100644 g3doc/Sentry-Gofer.svg delete mode 100644 g3doc/checkpoint_restore.md create mode 100644 g3doc/logo.png (limited to 'g3doc') diff --git a/g3doc/Layers.png b/g3doc/Layers.png deleted file mode 100644 index 308c6c451..000000000 Binary files a/g3doc/Layers.png and /dev/null differ diff --git a/g3doc/Layers.svg b/g3doc/Layers.svg deleted file mode 100644 index 0a366f841..000000000 --- a/g3doc/Layers.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/g3doc/Machine-Virtualization.png b/g3doc/Machine-Virtualization.png deleted file mode 100644 index 1ba2ed6b2..000000000 Binary files a/g3doc/Machine-Virtualization.png and /dev/null differ diff --git a/g3doc/Machine-Virtualization.svg b/g3doc/Machine-Virtualization.svg deleted file mode 100644 index 5352da07b..000000000 --- a/g3doc/Machine-Virtualization.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/g3doc/Rule-Based-Execution.png b/g3doc/Rule-Based-Execution.png deleted file mode 100644 index b42654a90..000000000 Binary files a/g3doc/Rule-Based-Execution.png and /dev/null differ diff --git a/g3doc/Rule-Based-Execution.svg b/g3doc/Rule-Based-Execution.svg deleted file mode 100644 index bd6717043..000000000 --- a/g3doc/Rule-Based-Execution.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/g3doc/Sentry-Gofer.png b/g3doc/Sentry-Gofer.png deleted file mode 100644 index ca2c27ef7..000000000 Binary files a/g3doc/Sentry-Gofer.png and /dev/null differ diff --git a/g3doc/Sentry-Gofer.svg b/g3doc/Sentry-Gofer.svg deleted file mode 100644 index 5c10750d2..000000000 --- a/g3doc/Sentry-Gofer.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/g3doc/checkpoint_restore.md b/g3doc/checkpoint_restore.md deleted file mode 100644 index 5fa3280a8..000000000 --- a/g3doc/checkpoint_restore.md +++ /dev/null @@ -1,108 +0,0 @@ -# runsc checkpoint/restore - -gVisor supports checkpointing and restoring containers. A container’s state can -be checkpointed and later restored into one or more containers. This can be used -to save work and time in cases of failure and allow for container migration. A -single container can perform slower setup tasks and then be checkpointed so that -many containers with the same task can be “restored” and started more quickly. - -### How to checkpoint/restore - -To use the runsc checkpoint command, first run a container. - -```sh -runsc run -``` - -To checkpoint the container, the --image-path flag must be provided. This is the -directory path within which the checkpoint state-file will be created. The file -will be called checkpoint.img and necessary directories will be created if they -do not yet exist. - -> Note: Two checkpoints cannot be saved to the save directory; every image-path -provided must be unique. - -```sh -runsc checkpoint --image-path= -``` - -There is also an optional --leave-running flag that allows the container to -continue to run after the checkpoint has been made. (By default, containers stop -their processes after committing a checkpoint.) - -> Note: All top-level runsc flags needed when calling run must be provided to -checkpoint if --leave-running is used. - -> Note: --leave-running functions by causing an immediate restore so the -container, although will maintain its given container id, may have a different -process id. - -```sh -runsc checkpoint --image-path= --leave-running -``` - -To restore, provide the image path to the checkpoint.img file created during the -checkpoint. Because containers stop by default after checkpointing, restore -needs to happen in a new container (restore is a command which parallels start). - -```sh -runsc create - -runsc restore --image-path= -``` - -### How to use checkpoint/restore in Docker: - -Currently checkpoint/restore through runsc is not entirely compatible with -Docker, although there has been progress made from both gVisor and Docker to -enable compatibility. Here, we document the ideal workflow. - -To run with Docker, first follow the [instructions](https://gvisor.googlesource.com/gvisor/+/master/README.md#configuring-docker) to use runsc as a runtime. - -Run a container: - -```sh -docker run [options] --runtime=runsc ` -``` - -Checkpoint a container: - -```sh -docker checkpoint create ` -``` - -Create a new container into which to restore: - -```sh -docker create [options] --runtime=runsc -``` - -Restore a container: - -```sh -docker start --checkpoint --checkpoint-dir= -``` - -**Issues Preventing Compatibility with Docker** -1. [Moby #37360][leave-running] - -Docker version 18.03.0-ce and earlier hangs when checkpointing and -does not create the checkpoint. To successfully use this feature, install a -custom version of docker-ce from the moby repository. This issue is caused by an -improper implementation of the `--leave-running` flag. This issue is now fixed -although is not yet part of an official release. - -2. Docker does not support restoration into new containers. - -Docker currently expects the container which created the checkpoint -to be the same container used to restore which is not possible in runsc. When -Docker supports container migration and therefore restoration into new -containers, this will be the flow. - -3. [Moby #37344][checkpoint-dir] - -Docker does not currently support the `--checkpoint-dir` flag but this will be -required when restoring from a checkpoint made in another container. - -[leave-running]: https://github.com/moby/moby/pull/37360 -[checkpoint-dir]: https://github.com/moby/moby/issues/37344 diff --git a/g3doc/logo.png b/g3doc/logo.png new file mode 100644 index 000000000..bd1a1e4b7 Binary files /dev/null and b/g3doc/logo.png differ -- cgit v1.2.3