add kubespray to the XTesting as it provides newer version of kubenetes and can be...

[it/test.git] / XTesting / kubespray / docs / containerd.md

diff --git a/XTesting/kubespray/docs/containerd.md b/XTesting/kubespray/docs/containerd.md
new file mode 100644 (file)
index 0000000..32de176
--- /dev/null
+++ b/XTesting/kubespray/docs/containerd.md
@@ -0,0 +1,42 @@
+# containerd
+
+[containerd] An industry-standard container runtime with an emphasis on simplicity, robustness and portability
+Kubespray supports basic functionality for using containerd as the default container runtime in a cluster.
+
+_To use the containerd container runtime set the following variables:_
+
+## k8s_cluster.yml
+
+When kube_node contains etcd, you define your etcd cluster to be as well schedulable for Kubernetes workloads. Thus containerd and dockerd can not run at same time, must be set to bellow for running etcd cluster with only containerd.
+
+```yaml
+container_manager: containerd
+```
+
+## etcd.yml
+
+```yaml
+etcd_deployment_type: host
+```
+
+## Containerd config
+
+Example: define registry mirror for docker hub
+
+```yaml
+containerd_registries:
+  "docker.io":
+    - "https://mirror.gcr.io"
+    - "https://registry-1.docker.io"
+```
+
+`containerd_registries` is ignored for pulling images when `image_command_tool=nerdctl`
+(the default for `container_manager=containerd`). Use `crictl` instead, it supports
+`containerd_registries` but lacks proper multi-arch support (see
+[#8375](https://github.com/kubernetes-sigs/kubespray/issues/8375)):
+
+```yaml
+image_command_tool: crictl
+```
+
+[containerd]: https://containerd.io/