Skip to content

Commit db15cb8

Browse files
committed
man: update docs to use new --linux-namespace-* flags
Signed-off-by: Aleksa Sarai <asarai@suse.de>
1 parent 72c1ef7 commit db15cb8

File tree

1 file changed

+15
-43
lines changed

1 file changed

+15
-43
lines changed

man/oci-runtime-tool-generate.1.md

Lines changed: 15 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,6 @@ read the configuration from `config.json`.
4545
**--cap-drop**=[]
4646
Drop Linux capabilities
4747

48-
**--cgroup**=*PATH*
49-
Use a Cgroup namespace where *PATH* is an existing Cgroup namespace file
50-
to join. The special *PATH* empty-string creates a new namespace.
51-
The special *PATH* `host` removes any existing Cgroup namespace from
52-
the configuration.
53-
5448
**--cgroups-path**=""
5549
Specifies the path to the cgroups relative to the cgroups mount point.
5650

@@ -65,7 +59,7 @@ read the configuration from `config.json`.
6559
This option allows you to specify arbitrary environment variables
6660
that are available for the process that will be launched inside of
6761
the container.
68-
62+
6963
**--env-file**=[]
7064
Set environment variables from a file.
7165
This option sets environment variables in the container from the
@@ -88,12 +82,6 @@ read the configuration from `config.json`.
8882
**--hostname**=""
8983
Set the container host name that is available inside the container.
9084

91-
**--ipc**=*PATH*
92-
Use an IPC namespace where *PATH* is an existing IPC namespace file
93-
to join. The special *PATH* empty-string creates a new namespace.
94-
The special *PATH* `host` removes any existing IPC namespace from the
95-
configuration.
96-
9785
**--label**=[]
9886
Add annotations to the configuration e.g. key=value.
9987

@@ -130,6 +118,20 @@ read the configuration from `config.json`.
130118
**--linux-mems**=MEMS
131119
Sets the list of memory nodes in the cpuset (default is to use any available memory node).
132120

121+
**--linux-namespace-add**=NSNAME[:PATH]
122+
Adds or replaces the given linux namespace NSNAME with a namespace entry that
123+
has a path of PATH. Omitting PATH means that a new namespace will be created
124+
by the container.
125+
126+
**--linux-namespace-remove**=NSNAME
127+
Removes a namespace from the set of namespaces configured in the container,
128+
so that the host's namespace will be used by the container instead of
129+
creating or joining another namespace.
130+
131+
**--linux-namespace-remove-all**
132+
Removes all namespaces from the set of namespaces configured for a container,
133+
such that the container will effectively run on the host.
134+
133135
**--linux-network-classid**=CLASSID
134136
Specifies network class identifier which will be tagged by container's network packets.
135137

@@ -152,12 +154,6 @@ read the configuration from `config.json`.
152154
Specifies paths can not be read inside container. e.g. --masked-paths=/proc/kcore
153155
This option can be specified multiple times.
154156

155-
**--mount**=*PATH*
156-
Use a mount namespace where *PATH* is an existing mount namespace file
157-
to join. The special *PATH* empty-string creates a new namespace.
158-
The special *PATH* `host` removes any existing mount namespace from the
159-
configuration.
160-
161157
**--mount-cgroups**=[rw|ro|no]
162158
Mount cgroups. The default is `no`.
163159

@@ -173,12 +169,6 @@ read the configuration from `config.json`.
173169
"system_u:object_r:usr_t:s0" might be a good label for a readonly container,
174170
"system_u:system_r:svirt_sandbox_file_t:s0:c1,c2" for a read/write container.
175171

176-
**--network**=*PATH*
177-
Use a network namespace where *PATH* is an existing network namespace file
178-
to join. The special *PATH* empty-string creates a new namespace.
179-
The special *PATH* `host` removes any existing network namespace from the
180-
configuration.
181-
182172
**--no-new-privileges**=true|false
183173
Set no new privileges bit for the container process. Setting this flag
184174
will block the container processes from gaining any additional privileges
@@ -196,12 +186,6 @@ read the configuration from `config.json`.
196186
file at *PATH* (overwriting the existing content if a file already
197187
exists at *PATH*).
198188

199-
**--pid**=*PATH*
200-
Use a PID namespace where *PATH* is an existing PID namespace file
201-
to join. The special *PATH* empty-string creates a new namespace.
202-
The special *PATH* `host` removes any existing PID namespace from
203-
the configuration.
204-
205189
**--poststart**=CMD[:ARGS...]
206190
Set command to run in poststart hooks. Can be specified multiple times.
207191
The multiple commands will be run in order before the container process
@@ -329,18 +313,6 @@ read the configuration from `config.json`.
329313
**--uidmappings**
330314
Add UIDMappings e.g HostUID:ContainerID:Size. Implies **--user=**.
331315

332-
**--user**=*PATH*
333-
Use a user namespace where *PATH* is an existing user namespace file
334-
to join. The special *PATH* empty-string creates a new namespace.
335-
The special *PATH* `host` removes any existing user namespace from
336-
the configuration.
337-
338-
**--uts**=*PATH*
339-
Use a UTS namespace where *PATH* is an existing UTS namespace file
340-
to join. The special *PATH* empty-string creates a new namespace.
341-
The special *PATH* `host` removes any existing UTS namespace from
342-
the configuration.
343-
344316
# EXAMPLES
345317

346318
## Generating container in read-only mode

0 commit comments

Comments
 (0)