diff --git a/docs/how-to/README.md b/docs/how-to/README.md index 6dd163ce73..aa09b49c73 100644 --- a/docs/how-to/README.md +++ b/docs/how-to/README.md @@ -5,7 +5,7 @@ - [Run Kata containers with `crictl`](run-kata-with-crictl.md) - [Run Kata Containers with Kubernetes](run-kata-with-k8s.md) - [How to use Kata Containers and Containerd](containerd-kata.md) -- [How to use Kata Containers and CRI (containerd) with Kubernetes](how-to-use-k8s-with-cri-containerd-and-kata.md) +- [How to use Kata Containers and containerd with Kubernetes](how-to-use-k8s-with-containerd-and-kata.md) - [Kata Containers and service mesh for Kubernetes](service-mesh.md) - [How to import Kata Containers logs into Fluentd](how-to-import-kata-logs-with-fluentd.md) diff --git a/docs/how-to/how-to-set-prometheus-in-k8s.md b/docs/how-to/how-to-set-prometheus-in-k8s.md index 2090c3bd51..e61db2d1ca 100644 --- a/docs/how-to/how-to-set-prometheus-in-k8s.md +++ b/docs/how-to/how-to-set-prometheus-in-k8s.md @@ -19,7 +19,7 @@ Also you should ensure that `kubectl` working correctly. > **Note**: More information about Kubernetes integrations: > - [Run Kata Containers with Kubernetes](run-kata-with-k8s.md) > - [How to use Kata Containers and Containerd](containerd-kata.md) -> - [How to use Kata Containers and CRI (containerd plugin) with Kubernetes](how-to-use-k8s-with-cri-containerd-and-kata.md) +> - [How to use Kata Containers and containerd with Kubernetes](how-to-use-k8s-with-containerd-and-kata.md) ## Configure Prometheus diff --git a/docs/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md b/docs/how-to/how-to-use-k8s-with-containerd-and-kata.md similarity index 93% rename from docs/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md rename to docs/how-to/how-to-use-k8s-with-containerd-and-kata.md index bacfdccc86..de7a34ef61 100644 --- a/docs/how-to/how-to-use-k8s-with-cri-containerd-and-kata.md +++ b/docs/how-to/how-to-use-k8s-with-containerd-and-kata.md @@ -1,15 +1,15 @@ -# How to use Kata Containers and CRI (containerd plugin) with Kubernetes +# How to use Kata Containers and containerd with Kubernetes This document describes how to set up a single-machine Kubernetes (k8s) cluster. The Kubernetes cluster will use the -[CRI containerd](https://github.com/containerd/containerd/) and -[Kata Containers](https://katacontainers.io) to launch untrusted workloads. +[containerd](https://github.com/containerd/containerd/) and +[Kata Containers](https://katacontainers.io) to launch workloads. ## Requirements - Kubernetes, Kubelet, `kubeadm` -- containerd with `cri` plug-in +- containerd - Kata Containers > **Note:** For information about the supported versions of these components, @@ -149,7 +149,7 @@ $ sudo -E kubectl taint nodes --all node-role.kubernetes.io/master- ## Create runtime class for Kata Containers -By default, all pods are created with the default runtime configured in CRI containerd plugin. +By default, all pods are created with the default runtime configured in containerd. From Kubernetes v1.12, users can use [`RuntimeClass`](https://kubernetes.io/docs/concepts/containers/runtime-class/#runtime-class) to specify a different runtime for Pods. ```bash @@ -166,7 +166,7 @@ $ sudo -E kubectl apply -f runtime.yaml ## Run pod in Kata Containers -If a pod has the `runtimeClassName` set to `kata`, the CRI plugin runs the pod with the +If a pod has the `runtimeClassName` set to `kata`, the CRI runs the pod with the [Kata Containers runtime](../../src/runtime/README.md). - Create an pod configuration that using Kata Containers runtime diff --git a/docs/how-to/privileged.md b/docs/how-to/privileged.md index 10868f9a31..048509ff17 100644 --- a/docs/how-to/privileged.md +++ b/docs/how-to/privileged.md @@ -40,7 +40,7 @@ See below example config: ConfigPath = "/opt/kata/share/defaults/kata-containers/configuration.toml" ``` - - [Kata Containers with Containerd and CRI documentation](how-to-use-k8s-with-cri-containerd-and-kata.md) + - [How to use Kata Containers and containerd with Kubernetes](how-to-use-k8s-with-containerd-and-kata.md) - [Containerd CRI config documentation](https://github.com/containerd/containerd/blob/main/docs/cri/config.md) #### CRI-O diff --git a/docs/how-to/run-kata-with-k8s.md b/docs/how-to/run-kata-with-k8s.md index baee63bffe..4e5c58d5a2 100644 --- a/docs/how-to/run-kata-with-k8s.md +++ b/docs/how-to/run-kata-with-k8s.md @@ -15,7 +15,7 @@ After choosing one CRI implementation, you must make the appropriate configurati to ensure it integrates with Kata Containers. Kata Containers 1.5 introduced the `shimv2` for containerd 1.2.0, reducing the components -required to spawn pods and containers, and this is the preferred way to run Kata Containers with Kubernetes ([as documented here](../how-to/how-to-use-k8s-with-cri-containerd-and-kata.md#configure-containerd-to-use-kata-containers)). +required to spawn pods and containers, and this is the preferred way to run Kata Containers with Kubernetes ([as documented here](../how-to/how-to-use-k8s-with-containerd-and-kata.md#configure-containerd-to-use-kata-containers)). An equivalent shim implementation for CRI-O is planned. @@ -57,7 +57,7 @@ content shown below: To customize containerd to select Kata Containers runtime, follow our "Configure containerd to use Kata Containers" internal documentation -[here](../how-to/how-to-use-k8s-with-cri-containerd-and-kata.md#configure-containerd-to-use-kata-containers). +[here](../how-to/how-to-use-k8s-with-containerd-and-kata.md#configure-containerd-to-use-kata-containers). ## Install Kubernetes @@ -85,7 +85,7 @@ Environment="KUBELET_EXTRA_ARGS=--container-runtime=remote --runtime-request-tim Environment="KUBELET_EXTRA_ARGS=--container-runtime=remote --runtime-request-timeout=15m --container-runtime-endpoint=unix:///run/containerd/containerd.sock" ``` For more information about containerd see the "Configure Kubelet to use containerd" -documentation [here](../how-to/how-to-use-k8s-with-cri-containerd-and-kata.md#configure-kubelet-to-use-containerd). +documentation [here](../how-to/how-to-use-k8s-with-containerd-and-kata.md#configure-kubelet-to-use-containerd). ## Run a Kubernetes pod with Kata Containers