From 5700df5835951a156cbf79117775cd4d592be969 Mon Sep 17 00:00:00 2001 From: trilliams Date: Thu, 24 May 2018 12:14:22 -0700 Subject: [PATCH] howto: k8s grammar and format changes Went through and made a few grammar and format updates to make how-to guide easier to follow, as well as adddirect links to project Github pages where applicable. Fixes: #127 Signed-off-by: trilliams howto: k8s grammar and format changes Went through and made a few grammar and format updates to make how-to guide easier to follow, as well as adddirect links to project Github pages where applicable. Fixes: #127 Signed-off-by: trilliams --- ...to-use-k8s-with-cri-containerd-and-kata.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md b/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md index 4047372e..7a1bd452 100644 --- a/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md +++ b/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md @@ -1,17 +1,14 @@ # How to use Kata Containers and CRI (containerd plugin) with Kubernetes This document describes how to set up a single-machine Kubernetes cluster. -The Kubernetes cluster will use the [CRI containerd plugin](https://github.com/containerd/cri) and [Kata Containers](https://katacontainers.io) to launch untrusted workloads. +The Kubernetes cluster will use the [CRI containerd plugin](https://github.com/containerd/cri) and [Kata Containers](https://github.com/kata-containers) to launch untrusted workloads. ## Requirements - Kubernetes, kubelet, kubeadm - cri-containerd - Kata Containers -Note| ------------------ | -|For information about the supported versions of these components, see the Kata Containers [versions.yaml](https://github.com/kata-containers/runtime/blob/master/versions.yaml) file. | - +For information about the supported versions of these components, see the Kata Containers [versions.yaml](https://github.com/kata-containers/runtime/blob/master/versions.yaml) file. ## Install containerd(with CRI plugin enabled) @@ -52,7 +49,7 @@ $ command -v kubeadm The CRI containerd plugin supports configuration for two runtime types. - **Default runtime:** A runtime that is used by default to run workloads. -- **Untrusted workload runtime:** A runtime that will be used run untrusted workloads. +- **Untrusted workload runtime:** A runtime that will be used to run untrusted workloads. #### Define the Kata runtime as `untrusted_workload_runtime` @@ -61,7 +58,7 @@ Configure the Kata runtime for untrusted workload with the [config option](https Unless configured otherwise, the default runtime is set to `runc`. -- Configure containerd to use Kata as `untrusted_workload_runtime` +- Configure containerd to use Kata as `untrusted_workload_runtime`: ```bash $ sudo mkdir -p /etc/containerd/ @@ -78,8 +75,7 @@ EOT ### Configure Kubelet to use containerd -In order to allow kubelet use containerd (using CRI interface), configure the service to -point to the `containerd` socket. +In order to allow kubelet to use containerd (using CRI interface), configure the service to point to the `containerd` socket. - Configure k8s to use containerd @@ -99,8 +95,7 @@ $ sudo systemctl daemon-reload ### Optional: Configure proxy -If you are behind a proxy, use this script to configure your proxy for docker, -kubelet, and containerd. +If you are behind a proxy, use the following script to configure your proxy for docker, kubelet, and containerd: ```bash # Set proxys @@ -200,7 +195,7 @@ $ sudo -E kubectl taint nodes --all node-role.kubernetes.io/master- By default, all pods are created with the default runtime configured in CRI containerd plugin. If a pod has the `io.kubernetes.cri.untrusted-workload` annotation set to -`"true"`, the CRI plugin will run the pod with the [Kata Containers runtime](https://github.com/kata-containers/runtime). +`"true"`, the CRI plugin runs the pod with the [Kata Containers runtime](https://github.com/kata-containers/runtime). ```bash # Create untrusted pod configuration