From 43d128362fd88c82ca6123fd63cf473f91a5c16a Mon Sep 17 00:00:00 2001
From: Mathieu Parent <mathieu.parent@insee.fr>
Date: Wed, 12 Jan 2022 00:35:24 +0100
Subject: [PATCH] Document image_command_tool and
image_command_tool_on_localhost (#8409)
Signed-off-by: Mathieu Parent <mathieu.parent@insee.fr>
---
docs/containerd.md | 9 +++++++++
docs/vars.md | 6 +++++-
2 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/docs/containerd.md b/docs/containerd.md
index 7504f5752..32de17683 100644
--- a/docs/containerd.md
+++ b/docs/containerd.md
@@ -30,4 +30,13 @@ containerd_registries:
- "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/
diff --git a/docs/vars.md b/docs/vars.md
index 638ffd11c..11e33f555 100644
--- a/docs/vars.md
+++ b/docs/vars.md
@@ -52,7 +52,11 @@ Kubernetes needs some parameters in order to get deployed. These are the
following default cluster parameters:
* *cluster_name* - Name of cluster (default is cluster.local)
-* *container_manager* - Container Runtime to install in the nodes (default is docker)
+* *container_manager* - Container Runtime to install in the nodes (default is containerd)
+* *image_command_tool* - Tool used to pull images (default depends on `container_manager`
+ and is `nerdctl` for `containerd`, `crictl` for `crio`, `docker` for `docker`)
+* *image_command_tool_on_localhost* - Tool used to pull images on localhost
+ (default is equal to `image_command_tool`)
* *dns_domain* - Name of cluster DNS domain (default is cluster.local)
* *kube_network_plugin* - Plugin to use for container networking
* *kube_service_addresses* - Subnet for cluster IPs (default is
--
GitLab