summaryrefslogtreecommitdiffhomepage
path: root/g3doc/user_guide
diff options
context:
space:
mode:
authorIan Lewis <ianlewis@google.com>2020-10-26 21:59:47 -0700
committergVisor bot <gvisor-bot@google.com>2020-10-26 22:01:56 -0700
commit3bb5f7164eefc6d5f33e7c08f87e2ae6df1c4bff (patch)
tree15c560026d567133dba390deb8a005a0f9f0a9bc /g3doc/user_guide
parentfacb2fb9c39de72c2426849a972f7181e236e7ab (diff)
Update latest install docs to install containerd shim
PiperOrigin-RevId: 339182137
Diffstat (limited to 'g3doc/user_guide')
-rw-r--r--g3doc/user_guide/containerd/quick_start.md4
-rw-r--r--g3doc/user_guide/install.md19
2 files changed, 14 insertions, 9 deletions
diff --git a/g3doc/user_guide/containerd/quick_start.md b/g3doc/user_guide/containerd/quick_start.md
index b6a3186d8..a98fe5c4a 100644
--- a/g3doc/user_guide/containerd/quick_start.md
+++ b/g3doc/user_guide/containerd/quick_start.md
@@ -1,7 +1,7 @@
# Containerd Quick Start
-This document describes how to install and configure `containerd-shim-runsc-v1`
-using the containerd runtime handler support on `containerd` 1.2 or later.
+This document describes how to use `containerd-shim-runsc-v1` with the
+containerd runtime handler support on `containerd` 1.2 or later.
> ⚠️ NOTE: If you are using Kubernetes and set up your cluster using kubeadm you
> may run into issues. See the [FAQ](../FAQ.md#runtime-handler) for details.
diff --git a/g3doc/user_guide/install.md b/g3doc/user_guide/install.md
index abb9e8582..c3ced9d61 100644
--- a/g3doc/user_guide/install.md
+++ b/g3doc/user_guide/install.md
@@ -13,15 +13,19 @@ To download and install the latest release manually follow these steps:
(
set -e
URL=https://storage.googleapis.com/gvisor/releases/release/latest
- wget ${URL}/runsc ${URL}/runsc.sha512
- sha512sum -c runsc.sha512
- rm -f runsc.sha512
- sudo mv runsc /usr/local/bin
- sudo chmod a+rx /usr/local/bin/runsc
+ wget ${URL}/runsc ${URL}/runsc.sha512 \
+ ${URL}/gvisor-containerd-shim ${URL}/gvisor-containerd-shim.sha512 \
+ ${URL}/containerd-shim-runsc-v1 ${URL}/containerd-shim-runsc-v1.sha512
+ sha512sum -c runsc.sha512 \
+ -c gvisor-containerd-shim.sha512 \
+ -c containerd-shim-runsc-v1.sha512
+ rm -f *.sha512
+ chmod a+rx runsc gvisor-containerd-shim containerd-shim-runsc-v1
+ sudo mv runsc gvisor-containerd-shim containerd-shim-runsc-v1 /usr/local/bin
)
```
-To install gVisor with Docker, run the following commands:
+To install gVisor as a Docker runtime, run the following commands:
```bash
/usr/local/bin/runsc install
@@ -165,5 +169,6 @@ You can use this link with the steps described in
Note that `apt` installation of a specific point release is not supported.
After installation, try out `runsc` by following the
-[Docker Quick Start](./quick_start/docker.md) or
+[Docker Quick Start](./quick_start/docker.md),
+[Containerd QuickStart](./containerd/quick_start.md), or
[OCI Quick Start](./quick_start/oci.md).