summaryrefslogtreecommitdiffhomepage
path: root/shim/README.md
diff options
context:
space:
mode:
authorAdin Scannell <ascannell@google.com>2020-07-09 16:59:42 -0700
committerAdin Scannell <ascannell@google.com>2020-07-09 16:59:42 -0700
commit5471dbe2f36976eb61f8c8fe8eaafd5da0569779 (patch)
tree08fa0f9691189012085c5a515dd81dea46a105e2 /shim/README.md
parent5946f111827fa4e342a2e6e9c043c198d2e5cb03 (diff)
parent7f8172edf583e0d26bee5e06578a442c7507ba6f (diff)
Merge gvisor-containerd-shim
Diffstat (limited to 'shim/README.md')
-rw-r--r--shim/README.md16
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 &lt;= 1.2)](docs/configure-gvisor-containerd-shim.md)
+
+[containerd-shim]: https://github.com/containerd/containerd/tree/master/cmd/containerd-shim