Skip to content

Commit 9dcdb63

Browse files
committed
made a few grammatical and format changes
docs: Grammar and format updates 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: kata-containers#127 Signed-off-by: trilliams <[email protected]>
1 parent ae0ffb0 commit 9dcdb63

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

how-to/how-to-use-k8s-with-cri-containerd-and-kata.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
# How to use Kata Containers and CRI (containerd plugin) with Kubernetes
22

33
This document describes how to set up a single-machine Kubernetes cluster.
4-
The Kubernetes cluster will use the [CRI containerd plugin](https://github.com/containerd/cri) and [Kata Containers](https://katacontainers.io) to launch untrusted workloads.
4+
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.
55

66
## Requirements
77
- Kubernetes, kubelet, kubeadm
88
- cri-containerd
99
- Kata Containers
1010

11-
Note|
12-
----------------- |
13-
|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. |
14-
11+
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.
1512

1613

1714
## Install containerd(with CRI plugin enabled)
@@ -52,7 +49,7 @@ $ command -v kubeadm
5249
The CRI containerd plugin supports configuration for two runtime types.
5350

5451
- **Default runtime:** A runtime that is used by default to run workloads.
55-
- **Untrusted workload runtime:** A runtime that will be used run untrusted workloads.
52+
- **Untrusted workload runtime:** A runtime that will be used to run untrusted workloads.
5653

5754
#### Define the Kata runtime as `untrusted_workload_runtime`
5855

@@ -61,7 +58,7 @@ Configure the Kata runtime for untrusted workload with the [config option](https
6158

6259
Unless configured otherwise, the default runtime is set to `runc`.
6360

64-
- Configure containerd to use Kata as `untrusted_workload_runtime`
61+
- Configure containerd to use Kata as `untrusted_workload_runtime`:
6562

6663
```bash
6764
$ sudo mkdir -p /etc/containerd/
@@ -78,8 +75,7 @@ EOT
7875

7976
### Configure Kubelet to use containerd
8077

81-
In order to allow kubelet use containerd (using CRI interface), configure the service to
82-
point to the `containerd` socket.
78+
In order to allow kubelet to use containerd (using CRI interface), configure the service to point to the `containerd` socket.
8379

8480

8581
- Configure k8s to use containerd
@@ -99,8 +95,7 @@ $ sudo systemctl daemon-reload
9995

10096
### Optional: Configure proxy
10197

102-
If you are behind a proxy, use this script to configure your proxy for docker,
103-
kubelet, and containerd.
98+
If you are behind a proxy, use the following script to configure your proxy for docker, kubelet, and containerd:
10499

105100
```bash
106101
# Set proxys
@@ -200,7 +195,7 @@ $ sudo -E kubectl taint nodes --all node-role.kubernetes.io/master-
200195

201196
By default, all pods are created with the default runtime configured in CRI containerd plugin.
202197
If a pod has the `io.kubernetes.cri.untrusted-workload` annotation set to
203-
`"true"`, the CRI plugin will run the pod with the [Kata Containers runtime](https://github.com/kata-containers/runtime).
198+
`"true"`, the CRI plugin runs the pod with the [Kata Containers runtime](https://github.com/kata-containers/runtime).
204199

205200
```bash
206201
# Create untrusted pod configuration
@@ -238,3 +233,12 @@ $ ps aux | grep qemu
238233
# Delete pod
239234
$ sudo -E kubectl delete -f nginx-untrusted.yaml
240235
```
236+
237+
238+
docs: Grammatical fixes & updates
239+
240+
Made a few minor grammatical & spelling updates, as well as add hyperlinks to project Github pages where available.
241+
242+
Fixes: #124
243+
244+
Signed-off-by: T. Nichole Williams <[email protected]>

0 commit comments

Comments
 (0)