Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

Commit

Permalink
howto: k8s grammar and format changes
Browse files Browse the repository at this point in the history
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 <tribecca@tribecc.us>

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 <tribecca@tribecc.us>
  • Loading branch information
OGtrilliams committed Jun 13, 2018
1 parent c22d45e commit 5700df5
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions how-to/how-to-use-k8s-with-cri-containerd-and-kata.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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`

Expand All @@ -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/
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 5700df5

Please sign in to comment.