From ec51ea57e2a7ec6eb15200a7efd1dd6245381ec1 Mon Sep 17 00:00:00 2001 From: Ian Lewis Date: Wed, 25 Mar 2020 08:28:36 +0900 Subject: Config docs (#54) * Updated configuration docs to be more consistent * Add links to configuration docs * Add links to top README * Fix markdown formatting --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5480ab905..40a474c4f 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,19 @@ gvisor-containerd-shim is a containerd shim for [gVisor](https://github.com/goog ## Requirements -- gvisor (runsc) >= 2018-12-07 -- containerd, containerd-shim >= 1.1 +- gvisor (runsc) >= 2018-12-07 +- containerd, containerd-shim >= 1.1 ## Installation -- [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) +- [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) + +## Configuration + +- [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) # Contributing -- cgit v1.2.3