From 5ac8515bf0859074bc4f648d297bb6805cdf5699 Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Mon, 27 Apr 2020 08:19:44 +0100 Subject: [PATCH] Clarify that plugin names are long in version = 2 Otherwise it's confusing for readers who just need quick reference for plugin configurations. Signed-off-by: Dave Syer --- docs/config.md | 1 + docs/registry.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/config.md b/docs/config.md index 9f008f9d3..c6529dd9a 100644 --- a/docs/config.md +++ b/docs/config.md @@ -10,6 +10,7 @@ The explanation and default value of each configuration item are as follows: ```toml # Use config version 2 to enable new configuration fields. # Config file is parsed as version 1 by default. +# Version 2 uses long plugin names, i.e. "io.containerd.grpc.v1.cri" vs "cri". version = 2 # The 'plugins."io.containerd.grpc.v1.cri"' table contains all of the server options. diff --git a/docs/registry.md b/docs/registry.md index 6eaeba64d..6f9c042ba 100644 --- a/docs/registry.md +++ b/docs/registry.md @@ -6,6 +6,8 @@ With containerd, `docker.io` is the default image registry. You can also set up To configure image registries create/modify the `/etc/containerd/config.toml` as follows: ```toml +# Config file is parsed as version 1 by default. +# To use the long form of plugin names set "version = 2" [plugins.cri.registry.mirrors] [plugins.cri.registry.mirrors."docker.io"] endpoint = ["https://registry-1.docker.io"]