Newer
Older
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
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"service": {
"description": "Service specific configuration",
"type": "object",
"properties": {
"image": {
"description": "image docker",
"type": "object",
"properties": {
"pullPolicy": {
"type": "string",
"description": "option when pulling the docker image",
"default": "IfNotPresent",
"enum": [
"IfNotPresent",
"Always",
"Never"
]
},
"version": {
"description": "supported versions",
"type": "string",
"enum": [
"inseefrlab/onyxia-jupyter-tensorflow:py3.10.4-gpu",
"inseefrlab/onyxia-jupyter-tensorflow:py3.9.13-gpu"
],
"pattern": "^[a-z0-9-_./]+(:[a-z0-9-_.]+)?$",
"hidden": {
"value": true,
"path": "service/image/custom/enabled"
},
"default": "inseefrlab/onyxia-jupyter-tensorflow:py3.10.4-gpu"
},
"custom": {
"description": "use a custom jupyter docker image",
"type": "object",
"properties": {
"enabled": {
"title": "custom image",
"type": "boolean",
"description": "use a custom jupyter docker image",
"default": false
},
"version": {
"description": "jupyter unsupported version",
"type": "string",
"default": "inseefrlab/onyxia-jupyter-tensorflow:py3.10.4-gpu",
"pattern": "^[a-z0-9-_./]+(:[a-z0-9-_.]+)?$",
"hidden": {
"value": false,
"path": "service/image/custom/enabled"
}
}
}
}
}
}
}
},
"discovery": {
"description": "configure your service to autodetect some ressources.",
"type": "object",
"properties": {
"hive": {
"type": "boolean",
"title": "Enable hive metastore discovery",
"description": "discover your hive metastore service",
"default": true
},
"mlflow": {
"type": "boolean",
"title": "Enable mlflow discovery",
"description": "discover your mlflow service",
"default": true
}
}
},
"resources": {
"description": "Your service will have at least the requested resources and never more than its limits. No limit for a resource and you can consume everything left on the host machine.",
"type": "object",
"properties": {
"requests": {
"description": "Guaranteed resources",
"type": "object",
"properties": {
"cpu": {
"description": "The amount of cpu guaranteed",
"title": "CPU",
"type": "string",
"default": "100m",
"render": "slider",
"sliderMin": 50,
"sliderMax": 40000,
"sliderStep": 50,
"sliderUnit": "m",
"sliderExtremity": "down",
"sliderExtremitySemantic": "guaranteed",
"sliderRangeId": "cpu"
},
"memory": {
"description": "The amount of memory guaranteed",
"title": "memory",
"type": "string",
"default": "2Gi",
"render": "slider",
"sliderMin": 1,
"sliderMax": 200,
"sliderStep": 1,
"sliderUnit": "Gi",
"sliderExtremity": "down",
"sliderExtremitySemantic": "guaranteed",
"sliderRangeId": "memory"
}
}
},
"limits": {
"description": "max resources",
"type": "object",
"properties": {
"cpu": {
"description": "The maximum amount of cpu",
"title": "CPU",
"type": "string",
"default": "30000m",
"render": "slider",
"sliderMin": 50,
"sliderMax": 40000,
"sliderStep": 50,
"sliderUnit": "m",
"sliderExtremity": "up",
"sliderExtremitySemantic": "Maximum",
"sliderRangeId": "cpu"
},
"memory": {
"description": "The maximum amount of memory",
"title": "Memory",
"type": "string",
"default": "50Gi",
"render": "slider",
"sliderMin": 1,
"sliderMax": 200,
"sliderStep": 1,
"sliderUnit": "Gi",
"sliderExtremity": "up",
"sliderExtremitySemantic": "Maximum",
"sliderRangeId": "memory"
},
"nvidia.com/gpu": {
"description": "GPU to allocate to this instance. This is also requested",
"type": "string",
"default": "1",
"render": "slider",
"sliderMin": 1,
"sliderMax": 3,
"sliderStep": 1,
"sliderUnit": ""
}
}
}
}
},
"persistence": {
"description": "Configuration for persistence",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Create a persistent volume",
"default": true
},
"size": {
"type": "string",
"title": "Persistent volume size",
"description": "Size of the persistent volume",
"default": "10Gi",
"form": true,
"render": "slider",
"sliderMin": 1,
"sliderMax": 100,
"sliderStep": 1,
"sliderUnit": "Gi",
"hidden": {
"value": false,
"path": "persistence/enabled"
}
}
}
},
"security": {
"description": "security specific configuration",
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "Password",
"default": "changeme",
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
347
348
349
350
351
352
353
354
355
356
"x-form": {
"value": "{{project.password}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{project.password}}"
}
},
"allowlist": {
"type": "object",
"description": "IP protection",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enable IP protection",
"description": "Only the configured set of IPs will be able to reach the service",
"default": true,
"x-form": {
"value": "{{region.defaultIpProtection}}"
},
"x-onyxia": {
"overwriteDefaultWith": "region.defaultIpProtection"
}
},
"ip": {
"type": "string",
"description": "the white list of IP is whitespace",
"title": "Whitelist of IP",
"x-form": {
"value": "{{user.ip}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{user.ip}}"
},
"hidden": {
"value": false,
"path": "security/allowlist/enabled"
}
}
}
},
"networkPolicy": {
"type": "object",
"description": "Define access policy to the service",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enable network policy",
"description": "Only pod from the same namespace will be allowed",
"default": true,
"x-form": {
"value": "{{region.defaultNetworkPolicy}}"
},
"x-onyxia": {
"overwriteDefaultWith": "region.defaultNetworkPolicy"
}
},
"from": {
"type": "array",
"description": "Array of source allowed to have network access to your service",
"default": [],
"x-form": {
"hidden": true,
"value": "{{region.from}}"
},
"x-onyxia": {
"hidden": true,
"overwriteDefaultWith": "region.from"
}
}
}
}
}
},
"kubernetes": {
"description": "configuration of your kubernetes access",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "allow your service to access your namespace ressources",
"default": true
},
"role": {
"type": "string",
"description": "bind your service account to this kubernetes default role",
"default": "view",
"hidden": {
"value": false,
"path": "kubernetes/enabled"
},
"enum": [
"view",
"edit",
"admin"
]
}
}
},
"git": {
"description": "Git user configuration",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Add git config inside your environment",
"default": true
},
"name": {
"type": "string",
"description": "user name for git",
"default": "",
"x-form": {
"value": "{{git.name}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{git.name}}"
},
"hidden": {
"value": false,
"path": "git/enabled"
}
},
"email": {
"type": "string",
"description": "user email for git",
"default": "",
"x-form": {
"value": "{{git.email}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{git.email}}"
},
"hidden": {
"value": false,
"path": "git/enabled"
}
},
"cache": {
"type": "string",
"description": "duration in seconds of the credentials cache duration",
"default": "",
"x-form": {
"value": "{{git.credentials_cache_duration}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{git.credentials_cache_duration}}"
},
"hidden": {
"value": false,
"path": "git/enabled"
}
},
"token": {
"type": "string",
"description": "personal access token",
"default": "",
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
"x-form": {
"value": "{{git.token}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{git.token}}"
},
"hidden": {
"value": false,
"path": "git/enabled"
}
},
"repository": {
"type": "string",
"description": "Repository url",
"default": "",
"x-form": {
"value": "{{git.project}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{git.project}}"
},
"hidden": {
"value": false,
"path": "git/enabled"
}
},
"branch": {
"type": "string",
"description": "Brach automatically checkout",
"default": "",
"hidden": {
"value": "",
"path": "git/repository"
}
}
}
},
"vault": {
"description": "Configuration of vault client",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Add vault temporary identity inside your environment",
"default": true
},
"token": {
"description": "token vault",
"type": "string",
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
"x-form": {
"value": "{{vault.VAULT_TOKEN}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{vault.VAULT_TOKEN}}"
},
"hidden": {
"value": false,
"path": "vault/enabled"
}
},
"url": {
"description": "url of vault server",
"type": "string",
"x-form": {
"value": "{{vault.VAULT_ADDR}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{vault.VAULT_ADDR}}"
},
"hidden": {
"value": false,
"path": "vault/enabled"
}
},
"mount": {
"description": "mount of the v2 secret engine",
"type": "string",
"x-form": {
"value": "{{vault.VAULT_MOUNT}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{vault.VAULT_MOUNT}}"
},
"hidden": {
"value": false,
"path": "vault/enabled"
}
},
"directory": {
"description": "top level directory",
"type": "string",
"x-form": {
"value": "{{vault.VAULT_TOP_DIR}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{vault.VAULT_TOP_DIR}}"
},
"hidden": {
"value": false,
"path": "vault/enabled"
}
},
"secret": {
"description": "the path of the secret to convert into a list of environment variables",
"type": "string",
"default": "",
"hidden": {
"value": false,
"path": "vault/enabled"
}
}
}
},
"s3": {
"description": "Configuration of temporary identity",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Add S3 temporary identity inside your environment",
"default": true
},
"accessKeyId": {
"description": "AWS Access Key",
"type": "string",
"x-form": {
"value": "{{s3.AWS_ACCESS_KEY_ID}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{s3.AWS_ACCESS_KEY_ID}}"
},
"hidden": {
"value": false,
"path": "s3/enabled"
}
},
"endpoint": {
"description": "AWS S3 Endpoint",
"type": "string",
"x-form": {
"value": "{{s3.AWS_S3_ENDPOINT}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{s3.AWS_S3_ENDPOINT}}"
},
"hidden": {
"value": false,
"path": "s3/enabled"
}
},
"defaultRegion": {
"description": "AWS S3 default region",
"type": "string",
"x-form": {
"value": "{{s3.AWS_DEFAULT_REGION}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{s3.AWS_DEFAULT_REGION}}"
},
"hidden": {
"value": false,
"path": "s3/enabled"
}
},
"secretAccessKey": {
"description": "AWS S3 secret access key",
"type": "string",
"x-form": {
"value": "{{s3.AWS_SECRET_ACCESS_KEY}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{s3.AWS_SECRET_ACCESS_KEY}}"
},
"hidden": {
"value": false,
"path": "s3/enabled"
}
},
"sessionToken": {
"description": "AWS S3 session Token",
"type": "string",
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
"x-form": {
"value": "{{s3.AWS_SESSION_TOKEN}}"
},
"x-onyxia": {
"overwriteDefaultWith": "{{s3.AWS_SESSION_TOKEN}}"
},
"hidden": {
"value": false,
"path": "s3/enabled"
}
}
}
},
"ingress": {
"type": "object",
"form": true,
"title": "Ingress Details",
"properties": {
"hostname": {
"type": "string",
"form": true,
"title": "Hostname",
"x-form": {
"hidden": true,
"value": "{{project.id}}-{{k8s.randomSubdomain}}-0.{{k8s.domain}}"
},
"x-onyxia": {
"hidden": true,
"overwriteDefaultWith": "{{project.id}}-{{k8s.randomSubdomain}}-0.{{k8s.domain}}"
}
},
"userHostname": {
"type": "string",
"form": true,
"title": "Hostname",
"x-form": {
"hidden": true,
"value": "{{project.id}}-{{k8s.randomSubdomain}}-user.{{k8s.domain}}"
},
"x-onyxia": {
"hidden": true,
"overwriteDefaultWith": "{{project.id}}-{{k8s.randomSubdomain}}-user.{{k8s.domain}}"
}
},
"ingressClassName": {
"type": "string",
"form": true,
"title": "ingressClassName",
"default": "",
"x-form": {
"hidden": true,
"value": "{{k8s.ingressClassName}}"
},
"x-onyxia": {
"hidden": true,
"overwriteDefaultWith": "{{k8s.ingressClassName}}"
}
}
}
},
"networking": {
"type": "object",
"form": true,
"title": "Networking detail",
"properties": {
"user": {
"type": "object",
"description": "user defined port",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enable a custom service port",
"description": "Enable a custom service port",
"default": false
},
"port": {
"type": "integer",
"description": "port of the custom service",
"title": "Custom service port",
"hidden": {
"value": false,
"path": "networking/user/enabled"
},
"default": 5000
}
}
}
}
},
"init": {
"description": "Init parameters",
"type": "object",
"properties": {
"regionInit": {
"type": "string",
"description": "region initialization script",
"default": "",
"x-form": {
"hidden": true,
"value": "{{k8s.initScriptUrl}}"
},
"x-onyxia": {
"hidden": true,
"overwriteDefaultWith": "{{k8s.initScriptUrl}}"
}
},
"personalInit": {
"type": "string",
"description": "user initialization script",
"default": ""
},
"personalInitArgs": {
"type": "string",
"description": "args for user initialization script",
"default": ""
}
}
}
}
}