Fix GC failure of CRI plugin

Signed-off-by: Kohei Tokunaga <[email protected]>
containerd · Dec 10, 2024 · 0a97344 · 0a97344
1 parent efb9325
commit 0a97344
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -62,14 +62,17 @@ version = 2
   [proxy_plugins.stargz]
     type = "snapshot"
     address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+  [proxy_plugins.stargz.exports]
+    root = "/var/lib/containerd-stargz-grpc/"
 
 # Use stargz snapshotter through CRI
 [plugins."io.containerd.grpc.v1.cri".containerd]
   snapshotter = "stargz"
   disable_snapshot_annotations = false
 ```
 
-**Note that `disable_snapshot_annotations = false` is required since containerd > v1.4.2**
+> NOTE1: `disable_snapshot_annotations = false` is required since containerd > v1.4.2
+> NOTE2: `root` field of `proxy_plugins` requires containerd >= v1.6.32 or v1.7.16 or v2.0.0
 
 You can try our [prebuilt](/Dockerfile) [KinD](https://github.com/kubernetes-sigs/kind) node image that contains the above configuration.
 

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -44,9 +44,13 @@ We assume that you are using containerd (> v1.4.2) as a CRI runtime.
     [proxy_plugins.stargz]
       type = "snapshot"
       address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+    [proxy_plugins.stargz.exports]
+      root = "/var/lib/containerd-stargz-grpc/"
 
   ```
 
+> NOTE: `root` field of `proxy_plugins` requires containerd >= v1.6.32 or v1.7.16 or v2.0.0
+
 - Install fuse
 
   ###### centos
@@ -145,6 +149,8 @@ We assume that you are using CRI-O newer than https://github.com/cri-o/cri-o/pul
     [proxy_plugins.stargz]
       type = "snapshot"
       address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+    [proxy_plugins.stargz.exports]
+      root = "/var/lib/containerd-stargz-grpc/"
   ```
 
 - Install fuse

diff --git a/docs/overview.md b/docs/overview.md
@@ -44,13 +44,17 @@ version = 2
   [proxy_plugins.stargz]
     type = "snapshot"
     address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+  [proxy_plugins.stargz.exports]
+    root = "/var/lib/containerd-stargz-grpc/"
 
 # Use stargz snapshotter through CRI
 [plugins."io.containerd.grpc.v1.cri".containerd]
   snapshotter = "stargz"
   disable_snapshot_annotations = false
 ```
 
+> NOTE: `root` field of `proxy_plugins` requires containerd >= v1.6.32 or v1.7.16 or v2.0.0
+
 This repo contains [a Dockerfile as a KinD node image](/Dockerfile) which includes the above configuration.
 
 ## State directory

diff --git a/script/benchmark/config-containerd/etc/containerd/config.toml b/script/benchmark/config-containerd/etc/containerd/config.toml
@@ -4,3 +4,5 @@ version = 2
   [proxy_plugins.stargz]
     type = "snapshot"
     address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+  [proxy_plugins.stargz.exports]
+    root = "/var/lib/containerd-stargz-grpc/"
diff --git a/script/config/etc/containerd/config.toml b/script/config/etc/containerd/config.toml
@@ -22,3 +22,5 @@ version = 2
   [proxy_plugins.stargz]
     type = "snapshot"
     address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+  [proxy_plugins.stargz.exports]
+    root = "/var/lib/containerd-stargz-grpc/"
diff --git a/script/demo/config.containerd.toml b/script/demo/config.containerd.toml
@@ -4,3 +4,5 @@ version = 2
   [proxy_plugins.stargz]
     type = "snapshot"
     address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+  [proxy_plugins.stargz.exports]
+    root = "/var/lib/containerd-stargz-grpc/"
diff --git a/script/integration/containerd/entrypoint.sh b/script/integration/containerd/entrypoint.sh
@@ -243,6 +243,8 @@ if [ "${BUILTIN_SNAPSHOTTER}" != "true" ] ; then
   [proxy_plugins.stargz]
     type = "snapshot"
     address = "/run/containerd-stargz-grpc/containerd-stargz-grpc.sock"
+  [proxy_plugins.stargz.exports]
+    root = "/var/lib/containerd-stargz-grpc/"
 EOF
 fi