Skip to content

Commit 904ab30

Browse files
author
HsuanChi (Austin) Kuo
committed
Fix doc for runtime specifc options
Signed-off-by: Hsuan-Chi Kuo <[email protected]>
1 parent 0fa3cfd commit 904ab30

1 file changed

Lines changed: 22 additions & 22 deletions

File tree

docs/config.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -156,38 +156,38 @@ version = 2
156156
# "io.containerd.runc.v1" and "io.containerd.runc.v2". Its corresponding options type is:
157157
# https://github.com/containerd/containerd/blob/v1.3.2/runtime/v2/runc/options/oci.pb.go#L26 .
158158
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
159-
# NoPivotRoot disables pivot root when creating a container.
160-
NoPivotRoot = false
159+
# no_pivot_root disables pivot root when creating a container.
160+
no_pivot_root = false
161161

162-
# NoNewKeyring disables new keyring for the container.
163-
NoNewKeyring = false
162+
# no_new_keyring disables new keyring for the container.
163+
no_new_keyring = false
164164

165-
# ShimCgroup places the shim in a cgroup.
166-
ShimCgroup = ""
165+
# shim_cgroup places the shim in a cgroup.
166+
shim_cgroup = ""
167167

168-
# IoUid sets the I/O's pipes uid.
169-
IoUid = 0
168+
# io_uid sets the I/O's pipes uid.
169+
io_uid = 0
170170

171-
# IoGid sets the I/O's pipes gid.
172-
IoGid = 0
171+
# io_gid sets the I/O's pipes gid.
172+
io_gid = 0
173173

174-
# BinaryName is the binary name of the runc binary.
175-
BinaryName = ""
174+
# binary_name is the binary name of the runc binary.
175+
binary_name = ""
176176

177-
# Root is the runc root directory.
178-
Root = ""
177+
# root is the runc root directory.
178+
root = ""
179179

180-
# CriuPath is the criu binary path.
181-
CriuPath = ""
180+
# criu_path is the criu binary path.
181+
criu_path = ""
182182

183-
# SystemdCgroup enables systemd cgroups.
184-
SystemdCgroup = false
183+
# systemd_cgroup enables systemd cgroups.
184+
systemd_cgroup = false
185185

186-
# CriuImagePath is the criu image path
187-
CriuImagePath = ""
186+
# criu_image_path is the criu image path
187+
criu_image_path = ""
188188

189-
# CriuWorkPath is the criu work path.
190-
CriuWorkPath = ""
189+
# criu_work_path is the criu work path.
190+
criu_work_path = ""
191191

192192
# 'plugins."io.containerd.grpc.v1.cri".cni' contains config related to cni
193193
[plugins."io.containerd.grpc.v1.cri".cni]

0 commit comments

Comments
 (0)