diff options
| author | Adin Scannell <ascannell@google.com> | 2020-05-05 18:06:46 -0700 |
|---|---|---|
| committer | Adin Scannell <ascannell@google.com> | 2020-05-19 21:24:22 -0700 |
| commit | 7f8172edf583e0d26bee5e06578a442c7507ba6f (patch) | |
| tree | 05060a421333308720ced12c4dd72e95b500999f /shim/README.md | |
| parent | 104a0ad08c8346a17d56287beb9756b8d52f684f (diff) | |
Restructure shim packages for merging.
Diffstat (limited to 'shim/README.md')
| -rw-r--r-- | shim/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/shim/README.md b/shim/README.md new file mode 100644 index 000000000..e446ec970 --- /dev/null +++ b/shim/README.md @@ -0,0 +1,16 @@ +# gvisor-containerd-shim + +gvisor-containerd-shim is a containerd shim. It implements the containerd v1 +shim API. It can be used as a drop-in replacement for +[containerd-shim][containerd-shim] +(though containerd-shim must still be installed). It allows the use of both +gVisor (runsc) and normal containers in the same containerd installation by +deferring to the runc shim if the desired runtime engine is not runsc. + +- [Untrusted Workload Quick Start (containerd >=1.1)](docs/untrusted-workload-quickstart.md) +- [Runtime Handler/RuntimeClass Quick Start (containerd >=1.2)](docs/runtime-handler-quickstart.md) +- [Runtime Handler/RuntimeClass Quick Start (shim v2) (containerd >=1.2)](docs/runtime-handler-shim-v2-quickstart.md) +- [Configure containerd-shim-runsc-v1 (shim v2) (containerd >= 1.3)](docs/configure-containerd-shim-runsc-v1.md) +- [Configure gvisor-containerd-shim (shim v1) (containerd <= 1.2)](docs/configure-gvisor-containerd-shim.md) + +[containerd-shim]: https://github.com/containerd/containerd/tree/master/cmd/containerd-shim |