Add docs for customize CRI. (#2107)

Signed-off-by: huaiyou <huaiyou.cyz@alibaba-inc.com>
sealerio · Mar 16, 2023 · 431b361 · 431b361
1 parent 3572e8b
commit 431b361
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/docs/api/cloudrootfs.md b/docs/api/cloudrootfs.md
@@ -111,6 +111,24 @@ The follow files are reserved by the system, you can override them to realize th
 - init-registry.sh, for installing registry.
 - init-kube.sh, for installing kube*.
 
+If you want to add a new CRI type, you can put packages in this directory, and add a couple of scripts named ${CRI_NAME}.sh and uninstall-${CRI_NAME}.sh in directory $rootfs/scripts:
+
+- ${CRI_NAME}.sh: used to install this CRI, and write the CRI socket info into /etc/sealerio/cri/socket-path
+- uninstall-${CRI_NAME}.sh: used to uninstall this CRI
+
+Users can specify container runtime type to use customized CRI:
+
+Clusterfile:
+
+```yaml
+apiVersion: sealer.io/v1
+kind: Cluster
+spec:
+  containerRuntime:
+    type: ${CRI_NAME}
+...
+```
+
 ## Hooks
 
 ```shell script

diff --git a/docs/api/clusterfile.md b/docs/api/clusterfile.md
@@ -24,7 +24,8 @@ spec:
   certSANS:
     - aliyun-inc.com
     - 10.0.0.2
-
+  containerRuntime:
+    type: docker
   masters: # if provider is ALI_CLOUD or CONTAINER, you can specify the number of server, if BAREMETAL using ipList.
     cpu: 4
     memory: 8