summaryrefslogtreecommitdiffhomepage
path: root/g3doc/user_guide/runtimeclass.md
diff options
context:
space:
mode:
authorIan Lewis <ianlewis@google.com>2020-08-04 02:41:34 -0700
committergVisor bot <gvisor-bot@google.com>2020-08-04 02:43:44 -0700
commit9873b8ea3ee87b2659c0b45cd8a23f01a52d3735 (patch)
tree8aac10337a6c0d94297ff077878f8b9d1792603f /g3doc/user_guide/runtimeclass.md
parenta02b7534f21d4f963ace890e80d7bf17e0d5d10f (diff)
Add shim documentation to the website.
Add three new doc pages to the website. - A containerd quick start covering containerd 1.2. This is limited to shim v2 and runtime class as the docs would get too complicated explaining all the combinations that are possible. We want folks to use shim v2 and runtime class anyway. - An advanced configuration page. This covers containerd and containerd-shim-runsc-v1's configuration options. - A page for old versions (i.e. containerd 1.1). Notes that this is deprecated and supported on a best-effort basis. Fixes #3279 PiperOrigin-RevId: 324775563
Diffstat (limited to 'g3doc/user_guide/runtimeclass.md')
-rw-r--r--g3doc/user_guide/runtimeclass.md46
1 files changed, 0 insertions, 46 deletions
diff --git a/g3doc/user_guide/runtimeclass.md b/g3doc/user_guide/runtimeclass.md
deleted file mode 100644
index 2e2d997be..000000000
--- a/g3doc/user_guide/runtimeclass.md
+++ /dev/null
@@ -1,46 +0,0 @@
-# RuntimeClass
-
-First, follow the appropriate installation instructions for your version of
-containerd.
-
-* For 1.1 or lower, use `gvisor-containerd-shim`.
-* For 1.2 or higher, use `containerd-shim-runsc-v1`.
-
-# Set up the Kubernetes RuntimeClass
-
-Creating the [RuntimeClass][runtimeclass] in Kubernetes is simple once the
-runtime is available for containerd:
-
-```shell
-cat <<EOF | kubectl apply -f -
-apiVersion: node.k8s.io/v1beta1
-kind: RuntimeClass
-metadata:
- name: gvisor
-handler: runsc
-EOF
-```
-
-Pods can now be created using this RuntimeClass:
-
-```shell
-cat <<EOF | kubectl apply -f -
-apiVersion: v1
-kind: Pod
-metadata:
- name: nginx-gvisor
-spec:
- runtimeClassName: gvisor
- containers:
- - name: nginx
- image: nginx
-EOF
-```
-
-You can verify that the Pod is running via this RuntimeClass:
-
-```shell
-kubectl get pod nginx-gvisor -o wide
-```
-
-[runtimeclass]: https://kubernetes.io/docs/concepts/containers/runtime-class/