generated from gethyperos/hypr-repository
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathapp.schema.json
346 lines (346 loc) · 11.4 KB
/
app.schema.json
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
{
"$id": "https://github.com/gethyperos/hypr-repository/tree/master/schemas/app.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "App",
"type": "object",
"properties": {
"App": {
"type": "object",
"description": "HyperOS App specifications",
"properties": {
"webport": {
"type": "string",
"description": "Default port for web interface (if any)"
},
"id": {
"type": "string",
"description": "App Unique Identifier",
"pattern": "^[a-z0-9-_]+$"
},
"name": {
"type": "string",
"description": "App Name"
},
"icon": {
"type": "string",
"description": "App Icon file (relative to app.json)",
"pattern": ".*\\.(webp|png|gif)"
},
"description": {
"type": "string",
"description": "App Description",
"minItems": 1,
"uniqueItems": true
},
"categories": {
"type": "array",
"description": "App Categories (Must exist in categories.json file)",
"items": {
"type": "string"
},
"minItems": 1
},
"directory": {
"type": "string",
"description": "Directory name where this app.json is located (Usually the app name)",
"pattern": "^[a-zA-Z0-9-_]+$"
}
},
"required": [
"id",
"name",
"description",
"categories",
"icon",
"directory"
],
"examples": [
{
"id": "welcome",
"name": "HyperOS Example app",
"description": "HyperOS App Template",
"categories": ["Example"],
"icon": "example.png",
"directory": "welcome"
}
]
},
"Services": {
"description": "Docker-compose style services list but expanded to allow Volta customizability",
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"description": "Service",
"properties": {
"images": {
"type": "object",
"description": "App Docker images for supported platforms",
"properties": {
"armhf": {
"type": "string",
"description": "Arm / ArmHF image"
},
"arm64": {
"type": "string",
"description": "Arm64 image"
},
"x86_64": {
"type": "string",
"description": "Default image (32/64bit)"
}
},
"required": ["x86_64"]
},
"container_name": {
"type": "string",
"description": "Container name, which will be later prefix by vltos-",
"pattern": "^[a-zA-Z0-9-_]+$"
},
"environment": {
"type": "array",
"description": "Environment variables for the container",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Environment variable name"
},
"value": {
"type": "string",
"description": "Environment variable value"
},
"description": {
"type": "string",
"description": "Environment variable description (Used by front-end)"
}
},
"required": ["name", "value"],
"minItems": 1
}
},
"ports": {
"type": "array",
"description": "Ports for the container",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Port to be exposed on HOST"
},
"container": {
"type": "string",
"description": "Port on container"
},
"protocol": {
"type": "string",
"description": "Protocol (tcp/udp) defaults to tcp",
"enum": ["tcp", "udp"]
},
"description": {
"type": "string",
"description": "Port description (Used by front-end)"
}
},
"required": ["host", "container", "description"],
"minItems": 1
}
},
"volumes": {
"type": "array",
"description": "Volume bindings for the container",
"items": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Path on host",
"pattern": "((\\.{2}/{1})+|((\\.{1}/{1})?)|(/{1}))([a-zA-Z0-9])+$"
},
"container": {
"type": "string",
"description": "Path on container",
"pattern": "((\\.{2}/{1})+|((\\.{1}/{1})?)|(/{1}))([a-zA-Z0-9])+$"
},
"description": {
"type": "string",
"description": "Volume description (Used by front-end)"
}
},
"required": ["host", "container"],
"minItems": 1
}
},
"devices": {
"type": "array",
"description": "Devices for the container",
"items": [
{
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Path on host",
"pattern": "((\\.{2}/{1})+|((\\.{1}/{1})?)|(/{1}))(([a-zA-Z0-9]+/{1})+)([a-zA-Z0-9])+$"
},
"container": {
"type": "string",
"description": "Path on container",
"pattern": "((\\.{2}/{1})+|((\\.{1}/{1})?)|(/{1}))(([a-zA-Z0-9]+/{1})+)([a-zA-Z0-9])+$"
},
"description": {
"type": "string",
"description": "Device description (Used by front-end)"
}
},
"required": ["host", "container"],
"minItems": 1
}
]
},
"cap_add": {
"type": "array",
"description": "Capabilities to add to the container",
"items": {
"type": "string",
"description": "Capability name",
"pattern": "^[a-zA-Z0-9-_]+$"
},
"minItems": 1
},
"cap_drop": {
"type": "array",
"description": "Capabilities to drop from the container",
"items": {
"type": "string",
"description": "Capability name",
"pattern": "^[a-zA-Z0-9-_]+$"
},
"minItems": 1
},
"restart": {
"type": "string",
"description": "Restart policy for the container",
"enum": ["no", "always", "on-failure", "unless-stopped"]
},
"network_mode": {
"type": "object",
"description": " set service containers network mode.",
"properties": {
"mode": {
"description": "Network mode (must include service name if using service mode)",
"enum": ["host", "none", "service"],
"type": "string"
},
"service": {
"description": "Service name in case mode = service",
"type": "string"
}
},
"required": ["mode"]
},
"logging": {
"type": "object",
"description": "logging defines the logging configuration for the service.",
"properties": {
"driver": {
"type": "string",
"description": "Logging driver",
"enum": [
"json-file",
"syslog",
"journald",
"gelf",
"fluentd",
"fluentbit"
]
},
"options": {
"type": "object",
"description": "Logging driver options",
"properties": {
"tag": {
"type": "string",
"description": "Logging tag"
}
},
"minItems": 1
}
},
"required": ["driver"]
},
"security_opt": {
"type": "array",
"description": "security_opt overrides the default labeling scheme for each container.",
"items": {
"type": "string",
"description": "Security option",
"pattern": "^[a-zA-Z0-9-_]+$"
},
"minItems": 1
},
"command": {
"type": "string",
"description": "Overrides the command executed on container start-up"
},
"depends_on": {
"type": "array",
"items": {
"type": "string",
"description": "Expresses startup and shutdown dependencies between services (the name must match the service key).",
"pattern": "^[a-zA-Z0-9_-]+$"
}
}
},
"required": ["images", "container_name", "restart"],
"minProperties": 1,
"additionalProperties": false
}
},
"examples": [
{
"myapp": {
"images": {
"x86_64": "myapp:latest",
"armhf": "myapp:latest",
"arm64": "myapp:latest"
},
"container_name": "myapp_container_name",
"environment": [
{
"name": "variable_name",
"value": "variable_value",
"description": "Description of what this env does"
}
],
"ports": [
{
"host": "8080",
"container": "8080",
"protocol": "tcp",
"description": "description of what this port is for"
}
],
"volumes": [
{
"host": "/path/on/host",
"container": "/path/on/container",
"description": "Description of what is this volume for"
}
],
"devices": [
{
"host": "/dev/dri",
"container": "/dev/dri",
"description": "GPU Device for hardware acceleration"
}
]
}
}
]
}
},
"required": ["App", "Services"]
}