blob: 85231b50cb40f1b530efc6f7c5f4b7af63a53b6e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
<?xml version="1.0"?>
<interfaceDefinition>
<node name="container" owner="${vyos_conf_scripts_dir}/containers.py">
<properties>
<help>Container applications</help>
<priority>1280</priority>
</properties>
<children>
<tagNode name="name">
<properties>
<help>Container name</help>
<constraint>
<regex>[-a-zA-Z0-9]+</regex>
</constraint>
<constraintErrorMessage>Container name must be alphanumeric and can contain hyphens</constraintErrorMessage>
</properties>
<children>
<leafNode name="allow-host-networks">
<properties>
<help>Allow host networks in container</help>
<valueless/>
</properties>
</leafNode>
<leafNode name="cap-add">
<properties>
<help>Container capabilities/permissions</help>
<completionHelp>
<list>net-admin net-bind-service net-raw setpcap sys-admin sys-time</list>
</completionHelp>
<valueHelp>
<format>net-admin</format>
<description>Network operations (interface, firewall, routing tables)</description>
</valueHelp>
<valueHelp>
<format>net-bind-service</format>
<description>Bind a socket to privileged ports (port numbers less than 1024)</description>
</valueHelp>
<valueHelp>
<format>net-raw</format>
<description>Permission to create raw network sockets</description>
</valueHelp>
<valueHelp>
<format>setpcap</format>
<description>Capability sets (from bounded or inherited set)</description>
</valueHelp>
<valueHelp>
<format>sys-admin</format>
<description>Administation operations (quotactl, mount, sethostname, setdomainame)</description>
</valueHelp>
<valueHelp>
<format>sys-time</format>
<description>Permission to set system clock</description>
</valueHelp>
<constraint>
<regex>(net-admin|net-bind-service|net-raw|setpcap|sys-admin|sys-time)</regex>
</constraint>
<multi/>
</properties>
</leafNode>
#include <include/generic-description.xml.i>
<tagNode name="device">
<properties>
<help>Add a host device to the container</help>
</properties>
<children>
<leafNode name="source">
<properties>
<help>Source device (Example: "/dev/x")</help>
<valueHelp>
<format>txt</format>
<description>Source device</description>
</valueHelp>
</properties>
</leafNode>
<leafNode name="destination">
<properties>
<help>Destination container device (Example: "/dev/x")</help>
<valueHelp>
<format>txt</format>
<description>Destination container device</description>
</valueHelp>
</properties>
</leafNode>
</children>
</tagNode>
#include <include/generic-disable-node.xml.i>
<tagNode name="environment">
<properties>
<help>Add custom environment variables</help>
<constraint>
<regex>[-_a-zA-Z0-9]+</regex>
</constraint>
<constraintErrorMessage>Environment variable name must be alphanumeric and can contain hyphen and underscores</constraintErrorMessage>
</properties>
<children>
<leafNode name="value">
<properties>
<help>Set environment option value</help>
<valueHelp>
<format>txt</format>
<description>Set environment option value</description>
</valueHelp>
</properties>
</leafNode>
</children>
</tagNode>
<leafNode name="image">
<properties>
<help>Image name in the hub-registry</help>
</properties>
</leafNode>
<leafNode name="memory">
<properties>
<help>Constrain the memory available to a container</help>
<valueHelp>
<format>u32:0</format>
<description>Unlimited</description>
</valueHelp>
<valueHelp>
<format>u32:1-16384</format>
<description>Container memory in megabytes (MB)</description>
</valueHelp>
<constraint>
<validator name="numeric" argument="--range 0-16384"/>
</constraint>
<constraintErrorMessage>Container memory must be in range 0 to 16384 MB</constraintErrorMessage>
</properties>
<defaultValue>512</defaultValue>
</leafNode>
<tagNode name="network">
<properties>
<help>Attach user defined network to container</help>
<completionHelp>
<path>container network</path>
</completionHelp>
</properties>
<children>
<leafNode name="address">
<properties>
<!-- PODMAN currently does not support more then one IPv4 or IPv6 address assignments to a container -->
<help>Assign static IP address to container</help>
<valueHelp>
<format>ipv4</format>
<description>IPv4 address</description>
</valueHelp>
<constraint>
<validator name="ipv4-address"/>
</constraint>
</properties>
</leafNode>
</children>
</tagNode>
<tagNode name="port">
<properties>
<help>Publish port to the container</help>
</properties>
<children>
<leafNode name="source">
<properties>
<help>Source host port</help>
<valueHelp>
<format>u32:1-65535</format>
<description>Source host port</description>
</valueHelp>
<valueHelp>
<format>start-end</format>
<description>Source host port range (e.g. 10025-10030)</description>
</valueHelp>
<constraint>
<validator name="port-range"/>
</constraint>
</properties>
</leafNode>
<leafNode name="destination">
<properties>
<help>Destination container port</help>
<valueHelp>
<format>u32:1-65535</format>
<description>Destination container port</description>
</valueHelp>
<valueHelp>
<format>start-end</format>
<description>Destination container port range (e.g. 10025-10030)</description>
</valueHelp>
<constraint>
<validator name="port-range"/>
</constraint>
</properties>
</leafNode>
<leafNode name="protocol">
<properties>
<help>Protocol tcp/udp</help>
<completionHelp>
<list>tcp udp</list>
</completionHelp>
<constraint>
<regex>(tcp|udp)</regex>
</constraint>
</properties>
</leafNode>
</children>
</tagNode>
<leafNode name="restart">
<properties>
<help>Restart options for container</help>
<completionHelp>
<list>no on-failure always</list>
</completionHelp>
<valueHelp>
<format>no</format>
<description>Do not restart containers on exit</description>
</valueHelp>
<valueHelp>
<format>on-failure</format>
<description>Restart containers when they exit with a non-zero exit code, retrying indefinitely</description>
</valueHelp>
<valueHelp>
<format>always</format>
<description>Restart containers when they exit, regardless of status, retrying indefinitely</description>
</valueHelp>
<constraint>
<regex>(no|on-failure|always)</regex>
</constraint>
</properties>
<defaultValue>on-failure</defaultValue>
</leafNode>
<tagNode name="volume">
<properties>
<help>Mount a volume into the container</help>
</properties>
<children>
<leafNode name="source">
<properties>
<help>Source host directory</help>
<valueHelp>
<format>txt</format>
<description>Source host directory</description>
</valueHelp>
</properties>
</leafNode>
<leafNode name="destination">
<properties>
<help>Destination container directory</help>
<valueHelp>
<format>txt</format>
<description>Destination container directory</description>
</valueHelp>
</properties>
</leafNode>
</children>
</tagNode>
</children>
</tagNode>
<tagNode name="network">
<properties>
<help>Network name</help>
</properties>
<children>
<leafNode name="description">
<properties>
<help>Network description</help>
</properties>
</leafNode>
<leafNode name="prefix">
<properties>
<help>Prefix which allocated to that network</help>
<valueHelp>
<format>ipv4net</format>
<description>IPv4 network prefix</description>
</valueHelp>
<valueHelp>
<format>ipv6net</format>
<description>IPv6 network prefix</description>
</valueHelp>
<constraint>
<validator name="ipv4-prefix"/>
<validator name="ipv6-prefix"/>
</constraint>
<multi/>
</properties>
</leafNode>
</children>
</tagNode>
<leafNode name="registry">
<properties>
<help>Registry Name</help>
<multi/>
</properties>
<defaultValue>docker.io quay.io</defaultValue>
</leafNode>
</children>
</node>
</interfaceDefinition>
|
