Skip to content

Commit 0b113d7

Browse files
committed
doc: add the description of sandboxer and io_type
Signed-off-by: Abel Feng <[email protected]>
1 parent 7cead88 commit 0b113d7

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/cri/config.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,17 @@ version = 2
369369
# See https://github.com/containerd/containerd/issues/6657 for context.
370370
snapshotter = ""
371371

372+
# sandboxer is the sandbox controller for the runtime.
373+
# The default sandbox controller is the podsandbox controller, which create a "pause" container as a sandbox.
374+
# We can create our own "shim" sandbox controller by implementing the sandbox api defined in runtime/sandbox/v1/sandbox.proto in our shim, and specifiy the sandboxer to "shim" here.
375+
# We can also run a grpc or ttrpc server to serve the sandbox controller API defined in services/sandbox/v1/sandbox.proto, and define a ProxyPlugin of "sandbox" type, and specify the name of the ProxyPlugin here.
376+
sandboxer = ""
377+
378+
# io_type is the way containerd get stdin/stdout/stderr from container or the execed process.
379+
# The default value is "fifo", in which containerd will create a set of named pipes and transfer io by them.
380+
# Currently the value of "streaming" is supported, in this way, sandbox should serve streaming api defined in services/streaming/v1/streaming.proto, and containerd will connect to sandbox's endpoint and create a set of streams to it, as channels to transfer io of container or process.
381+
io_type = ""
382+
372383
# 'plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options' is options specific to
373384
# "io.containerd.runc.v1" and "io.containerd.runc.v2". Its corresponding options type is:
374385
# https://github.com/containerd/containerd/blob/v1.3.2/runtime/v2/runc/options/oci.pb.go#L26 .

0 commit comments

Comments
 (0)