diff --git a/Documentation-Requirements.md b/Documentation-Requirements.md index 736c77bb13..adfef8fce2 100644 --- a/Documentation-Requirements.md +++ b/Documentation-Requirements.md @@ -152,7 +152,7 @@ utility.
-- Long lines should not span across multiple lines by using the '`\`' +- Long lines should not span across multiple lines by using the `\` continuation character. GitHub automatically renders such blocks with scrollbars. Consequently, diff --git a/Releases.md b/Releases.md index a7b0a21222..7bf7ff41fb 100644 --- a/Releases.md +++ b/Releases.md @@ -71,7 +71,7 @@ The detailed steps to follow to create a new release are specified in the [Relea The Release Owner must follow the following process, which is designed to ensure clarity, quality, stability, and auditability of each release: -- Raise a [new github issue in the kata-containers repository](https://github.com/kata-containers/kata-containers/issues/new) and assign to themselves. +- Raise a [new GitHub issue in the `kata-containers` repository](https://github.com/kata-containers/kata-containers/issues/new) and assign to themselves. This issue is used to track the progress of the release with maximum visibility. diff --git a/design/architecture.md b/design/architecture.md index ad421ec885..281215a929 100644 --- a/design/architecture.md +++ b/design/architecture.md @@ -139,10 +139,10 @@ QEMU version called [`qemu-lite`](https://github.com/kata-containers/qemu/tree/q custom machine accelerators that are not available in the upstream version of QEMU. These custom machine accelerators are described below. -- nofw: this machine accelerator is x86 specific and only supported by `pc` and `q35` +- `nofw`: this machine accelerator is x86 specific and only supported by `pc` and `q35` machine types. `nofw` is used to boot an ELF format kernel by skipping the BIOS/firmware in the guest. This custom machine accelerator improves boot time significantly. -- static-prt: this machine accelerator is x86 specific and only supported by `pc` +- `static-prt`: this machine accelerator is x86 specific and only supported by `pc` and `q35` machine types. `static-prt` is used to reduce the interpretation burden for guest ACPI component. @@ -406,7 +406,7 @@ process. and signals and thus acts as an encapsulation layer between the container process reaper and the `kata-agent`. `kata-shim`: -- Connects to `kata-proxy` on a unix domain socket. The socket url is passed from +- Connects to `kata-proxy` on a Unix domain socket. The socket URL is passed from `kata-runtime` to `kata-shim` when the former spawns the latter along with a `containerID` and `execID`. The `containerID` and `execID` are used to identify the true container process that the shim process will be shadowing or representing. diff --git a/design/kata-design-requirements.md b/design/kata-design-requirements.md index 572303d57c..22edac97e6 100644 --- a/design/kata-design-requirements.md +++ b/design/kata-design-requirements.md @@ -29,7 +29,7 @@ The Kata Containers runtime **MUST** implement the following command line option ### [CRI](http://blog.kubernetes.io/2016/12/container-runtime-interface-cri-in-kubernetes.html) and [Kubernetes](https://kubernetes.io) support The Kata Containers project **MUST** provide two interfaces for CRI shims to manage hardware virtualization based Kubernetes pods and containers: -- An OCI and `runc` compatible command line interface, as decribed in the previous section. +- An OCI and `runc` compatible command line interface, as described in the previous section. This interface is used by implementations such as [`CRI-O`](http://cri-o.io) and [`cri-containerd`](https://github.com/containerd/cri-containerd), for example. - A hardware virtualization runtime library API for CRI shims to consume and provide a more CRI native implementation. The [`frakti`](https://github.com/kubernetes/frakti) CRI shim is an example of such a consumer. diff --git a/how-to/containerd-kata.md b/how-to/containerd-kata.md index baddc75230..0ac9c5fb6c 100644 --- a/how-to/containerd-kata.md +++ b/how-to/containerd-kata.md @@ -41,7 +41,7 @@ workloads with isolated sandboxes (i.e. Kata Containers). As a result, the CRI implementations extended their semantics for the requirements: -- At the beginning, [frakti](https://github.com/kubernetes/frakti) checks the network configuration of a Pod, and +- At the beginning, [Frakti](https://github.com/kubernetes/frakti) checks the network configuration of a Pod, and treat Pod with `host` network as trusted, while others are treated as untrusted. - The containerd introduced an annotation for untrusted Pods since [v1.0](https://github.com/containerd/cri/blob/v1.0.0-rc.0/docs/config.md): ```yaml @@ -143,14 +143,14 @@ The following sections outline how to add Kata Containers to the configurations. #### Kata Containers as a `RuntimeClass` For -- Kata Containers v1.5.0 or above (including 1.5.0-rc) +- Kata Containers v1.5.0 or above (including `1.5.0-rc`) - Containerd v1.2.0 or above - Kubernetes v1.12.0 or above The `RuntimeClass` is suggested. The following configuration includes three runtime classes: -- `plugins.cri.containerd.runtimes.runc`: the runC, and it is the default runtime. +- `plugins.cri.containerd.runtimes.runc`: the runc, and it is the default runtime. - `plugins.cri.containerd.runtimes.kata`: The function in containerd (reference [the document here](https://github.com/containerd/containerd/tree/master/runtime/v2#binary-naming)) where the dot-connected string `io.containerd.kata.v2` is translated to `containerd-shim-kata-v2` (i.e. the binary name of the Kata implementation of [Containerd Runtime V2 (Shim API)](https://github.com/containerd/containerd/tree/master/runtime/v2)). 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 27e0bb8fd4..a4bc1a4850 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 @@ -42,7 +42,7 @@ Then, make sure the containerd works with the [examples in it](containerd-kata.m ### Install Kubernetes - Follow the instructions for - [kubeadm installation](https://kubernetes.io/docs/setup/independent/install-kubeadm/). + [`kubeadm` installation](https://kubernetes.io/docs/setup/independent/install-kubeadm/). - Check `kubeadm` is now available @@ -130,7 +130,7 @@ $ sudo systemctl daemon-reload A pod network plugin is needed to allow pods to communicate with each other. - Install the `flannel` plugin by following the - [Using kubeadm to Create a Cluster](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#instructions) + [Using `kubeadm` to Create a Cluster](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#instructions) guide, starting from the **Installing a pod network** section. - Create a pod network using flannel diff --git a/how-to/what-is-vm-cache-and-how-do-I-use-it.md b/how-to/what-is-vm-cache-and-how-do-I-use-it.md index 59b6fc3896..c35f8a091b 100644 --- a/how-to/what-is-vm-cache-and-how-do-I-use-it.md +++ b/how-to/what-is-vm-cache-and-how-do-I-use-it.md @@ -44,4 +44,4 @@ and purge it by `ctrl-c` it. ### Limitations * Cannot work with VM templating. -* Only supports the qemu hypervisor. +* Only supports the QEMU hypervisor.