-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapplication.schema.json
More file actions
2554 lines (2554 loc) · 107 KB
/
Copy pathapplication.schema.json
File metadata and controls
2554 lines (2554 loc) · 107 KB
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
347
348
349
350
351
352
353
354
355
356
357
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
407
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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
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
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$id": "https://onebox.run/schemas/application/v1alpha1/application.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "One application, its workloads, the services it needs, and how a release rolls out.",
"properties": {
"apiVersion": {
"const": "onebox.run/v1alpha1",
"description": "Authored Application API identity.",
"type": "string"
},
"kind": {
"const": "Application",
"description": "Authored resource kind.",
"type": "string"
},
"metadata": {
"additionalProperties": false,
"description": "Application identity and opaque user metadata.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Opaque user metadata that never affects plans or runtime behavior.",
"type": "object"
},
"name": {
"description": "The application's name. Expects lower-case letters, digits and hyphens, starting with a letter, at most 40 characters, and may not begin \"ob-\" or be a name the host layout reserves. Stable application name used in generated runtime identities.",
"examples": [
"shop"
],
"not": {
"anyOf": [
{
"pattern": "^ob-"
},
{
"const": "ob"
},
{
"const": "onebox-proxy"
},
{
"const": "_host"
}
]
},
"pattern": "^[a-z]([a-z0-9-]{0,38}[a-z0-9])?$"
}
},
"required": [
"name"
],
"type": "object"
},
"spec": {
"additionalProperties": false,
"description": "Desired Onebox application configuration.",
"properties": {
"backupTargets": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"bucket": {
"description": "Existing destination bucket used by this target. Expects a lower-case S3-compatible bucket name between 3 and 63 characters.",
"examples": [
"onebox-backups"
],
"pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
},
"credentials": {
"additionalProperties": false,
"description": "Trusted encrypted-file entries containing destination credentials; values never appear in the project.",
"properties": {
"accessKeyEntry": {
"description": "Variable name containing the destination access key. Expects a variable name of letters, digits and underscores, not starting with a digit.",
"examples": [
"BACKUP_ACCESS_KEY_ID"
],
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
"type": "string"
},
"file": {
"description": "Repository-relative encrypted credential file staged through the trusted secret flow. Expects a path inside the repository, with no control character or shell metacharacter.",
"examples": [
"secrets/backup.env"
],
"pattern": "^[^/\\x00-\\x1f'\"$`\\\\][^\\x00-\\x1f'\"$`\\\\]*$",
"type": "string"
},
"provider": {
"default": "Sops",
"description": "Trusted secret provider. Only sops is currently executable.",
"enum": [
"Sops"
],
"type": "string"
},
"secretKeyEntry": {
"description": "Variable name containing the destination secret key. Expects a variable name of letters, digits and underscores, not starting with a digit.",
"examples": [
"BACKUP_SECRET_ACCESS_KEY"
],
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
"type": "string"
},
"sessionTokenEntry": {
"description": "Optional variable name containing a temporary destination session token. Expects a variable name of letters, digits and underscores, not starting with a digit.",
"examples": [
"BACKUP_SESSION_TOKEN"
],
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
"type": "string"
}
},
"type": "object"
},
"encryption": {
"additionalProperties": false,
"description": "Required encryption mode for each recovery kind this target may store.",
"properties": {
"cold": {
"description": "Encryption mode required for cold recovery: client-side or server-side.",
"enum": [
"ClientSide",
"ServerSide"
],
"type": "string"
},
"pitr": {
"description": "Encryption mode required for point-in-time recovery: client-side or server-side.",
"enum": [
"ClientSide",
"ServerSide"
],
"type": "string"
},
"snapshot": {
"description": "Encryption mode required for snapshot recovery: client-side or server-side.",
"enum": [
"ClientSide",
"ServerSide"
],
"type": "string"
}
},
"type": "object"
},
"endpoint": {
"description": "Destination API endpoint. HTTPS is required unless tls is explicitly insecure. Expects an http or https URL.",
"examples": [
"https://objects.example.com"
],
"pattern": "^https?://",
"type": "string"
},
"failureDomain": {
"additionalProperties": false,
"description": "Operator-declared identity used to prove the destination does not share the protected host.",
"properties": {
"host": {
"description": "Destination host identity used to refuse a target on the protected host. Expects a stable identifier of letters, digits, dots, colons, slashes, underscores and hyphens.",
"examples": [
"backup-01.example.net"
],
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$",
"type": "string"
},
"identity": {
"description": "Stable operator-owned failure-domain identity, distinct from the protected host. Expects a stable identifier of letters, digits, dots, colons, slashes, underscores and hyphens.",
"examples": [
"provider-a/us-east-1/account-42"
],
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$",
"type": "string"
}
},
"type": "object"
},
"kind": {
"description": "Destination kind. Only s3-compatible is supported.",
"enum": [
"S3Compatible"
],
"examples": [
"s3-compatible"
],
"type": "string"
},
"prefix": {
"description": "Non-secret object prefix reserved for Onebox backup data. Expects a relative object prefix with no empty leading component or shell metacharacter.",
"examples": [
"production/shop"
],
"pattern": "^[A-Za-z0-9][A-Za-z0-9._/-]{0,511}$",
"type": "string"
},
"region": {
"description": "S3-compatible region when the endpoint requires one. Expects a lower-case S3-compatible region of letters, digits and hyphens.",
"examples": [
"us-east-1"
],
"pattern": "^[a-z0-9][a-z0-9-]{0,62}$",
"type": "string"
},
"tls": {
"default": "Verify",
"description": "Transport policy: verify, or skip-verify to accept a plaintext http endpoint.",
"enum": [
"Verify",
"SkipVerify"
],
"type": "string"
}
},
"type": "object"
},
"description": "User-owned off-host repositories available to service backup policies.",
"type": "object"
},
"basePath": {
"default": "/var/lib/ob",
"description": "Absolute host directory beneath which Onebox stores application state and releases. Expects an absolute path with no control character or shell metacharacter.",
"examples": [
"/srv/ob"
],
"pattern": "^/[^\\x00-\\x1f'\"$`\\\\]*$",
"type": "string"
},
"checks": {
"additionalProperties": false,
"description": "Assertions that must pass before a release becomes current unless marked advisory.",
"properties": {
"exec": {
"description": "Commands run inside a named workload.",
"items": {
"additionalProperties": false,
"properties": {
"advisory": {
"default": false,
"description": "Report a failure without blocking release activation.",
"type": "boolean"
},
"run": {
"description": "Shell command verified inside the workload.",
"examples": [
"test -f /srv/ready"
],
"type": "string"
},
"workload": {
"description": "Workload the command runs inside.",
"examples": [
"web"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"http": {
"description": "HTTP paths probed inside a named workload.",
"items": {
"additionalProperties": false,
"properties": {
"advisory": {
"default": false,
"description": "Report a failure without blocking release activation.",
"type": "boolean"
},
"path": {
"description": "HTTP path verified inside the workload. Expects a path beginning with /.",
"examples": [
"/healthz"
],
"pattern": "^/[^\\x00-\\x1f'\"$` \\\\]*$",
"type": "string"
},
"port": {
"description": "Container port to probe.",
"examples": [
3000
],
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"workload": {
"description": "Workload the path is probed inside.",
"examples": [
"web"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"migrations": {
"description": "Migration revisions checked against captured job evidence.",
"items": {
"additionalProperties": false,
"properties": {
"advisory": {
"default": false,
"description": "Report a failure without blocking release activation.",
"type": "boolean"
},
"appliedRevisions": {
"description": "Revisions the job must report as applied.",
"items": {
"type": "string"
},
"type": "array"
},
"job": {
"description": "Job workload whose captured evidence is checked.",
"examples": [
"migrate"
],
"type": "string"
},
"provider": {
"description": "Migration tool that produced the revisions.",
"examples": [
"alembic"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"url": {
"description": "External URLs probed from the operator side.",
"items": {
"additionalProperties": false,
"properties": {
"advisory": {
"default": false,
"description": "Report a failure without blocking release activation.",
"type": "boolean"
},
"contains": {
"description": "Text the response body must contain.",
"type": "string"
},
"jsonAssertions": {
"description": "Scalar JSON response values that must match exactly.",
"items": {
"additionalProperties": false,
"properties": {
"equals": {
"description": "Exact scalar value required at path."
},
"path": {
"description": "Dot-separated path to a scalar value in the JSON response.",
"examples": [
"service.ready"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"requiredHeaders": {
"additionalProperties": {
"type": "string"
},
"description": "Exact response headers required for success.",
"type": "object"
},
"statusCodes": {
"description": "Allowed response status codes. A successful 2xx response is expected when omitted.",
"items": {
"maximum": 599,
"minimum": 100,
"type": "integer"
},
"type": "array"
},
"url": {
"description": "External HTTP or HTTPS URL verified from the operator side. Expects an http or https URL.",
"examples": [
"https://shop.example.com/healthz"
],
"pattern": "^https?://",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"deployment": {
"additionalProperties": false,
"description": "Release ordering, retention, and migration behavior.",
"properties": {
"migrationPolicy": {
"default": "Manual",
"description": "Policy for migration jobs during release and recovery.",
"enum": [
"Manual",
"Auto",
"ExpandOnly"
],
"type": "string"
},
"order": {
"description": "Explicit workload release order. Dependency order is derived when omitted.",
"items": {
"type": "string"
},
"type": "array"
},
"retainReleases": {
"default": 5,
"description": "Number of completed release directories retained for inspection and rollback.",
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"environments": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"basePath": {
"description": "Environment-specific replacement for the Application basePath. Expects an absolute path with no control character or shell metacharacter.",
"examples": [
"/srv/ob"
],
"pattern": "^/[^\\x00-\\x1f'\"$`\\\\]*$",
"type": "string"
},
"envFiles": {
"description": "Default ordered environment-file list for application, worker, and job workloads in this environment.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"description": "Repository-relative environment file path. Expects a path inside the repository, with no control character or shell metacharacter.",
"examples": [
".env.production"
],
"pattern": "^[^/\\x00-\\x1f'\"$`\\\\][^\\x00-\\x1f'\"$`\\\\]*$",
"type": "string"
},
"provider": {
"description": "Decryptor used before staging the file. The supported encrypted provider is sops.",
"enum": [
"Sops"
],
"examples": [
"sops"
],
"type": "string"
}
},
"required": [
"file"
],
"type": "object"
}
],
"description": "Also accepts a path to an environment file."
},
"type": "array"
},
"jump": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"description": "Optional SSH jump host tunnelling the connection to this server, written as user@host or as an object with host, user, and port. Onebox verifies and authenticates both hops and never forwards the SSH agent.",
"examples": [
"deploy@bastion.example.com"
],
"properties": {
"host": {
"description": "Jump host name or IP address.",
"examples": [
"bastion.example.com"
],
"type": "string"
},
"port": {
"description": "SSH port on the jump host. The SSH default is used when omitted.",
"examples": [
2222
],
"type": "integer"
},
"user": {
"description": "SSH user on the jump host. $USER is used when omitted; ob does not read ~/.ssh/config.",
"examples": [
"deploy"
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Optional SSH jump host tunnelling the connection to this server, written as user@host or as an object with host, user, and port. Onebox verifies and authenticates both hops and never forwards the SSH agent. Also accepts user@host or user@host:port."
},
"overrides": {
"additionalProperties": false,
"description": "Environment-specific operational tuning. Overrides cannot change workload identity or data semantics.",
"properties": {
"services": {
"additionalProperties": {
"additionalProperties": {},
"type": "object"
},
"description": "Allowed service tuning keyed by service name: resources and settings.",
"type": "object"
},
"workloads": {
"additionalProperties": {
"additionalProperties": {},
"type": "object"
},
"description": "Allowed workload tuning keyed by workload name: replicas, resources, env, envFiles, strategy, and routes.",
"type": "object"
}
},
"type": "object"
},
"policy": {
"additionalProperties": false,
"description": "Approval, runner compatibility, and migration-backup requirements for this environment.",
"properties": {
"allowAgentProposals": {
"default": true,
"description": "Declared permission for agent-authored proposals. The current CLI does not distinguish agent identity; execution remains approval-gated.",
"type": "boolean"
},
"migrations": {
"additionalProperties": false,
"description": "What this environment requires of a release carrying migration risk.",
"properties": {
"backupKeyMaterial": {
"description": "Key-material identities the backup report must name.",
"examples": [
[
"BACKUP_ACCESS_KEY_ID"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"backupMaxAge": {
"default": "24h",
"description": "Maximum age of a backup report accepted for a migration. Expects a duration such as 30s, 5m, 1h30m or 14d.",
"examples": [
"24h"
],
"pattern": "^(([0-9]+([.][0-9]+)?(ns|us|µs|ms|s|m|h))+|[0-9]+d)$",
"type": "string"
},
"requireBackup": {
"default": false,
"description": "Require a plan-bound backup report before a release with migration risk.",
"type": "boolean"
},
"requireRestoreTest": {
"default": false,
"description": "Require the backup report to state that a restore test succeeded.",
"type": "boolean"
}
},
"type": "object"
},
"minOneboxVersion": {
"description": "Oldest released Onebox runner allowed to operate this environment. Expects a CalVer release such as v2026.8.0.",
"examples": [
"v2026.8.0"
],
"pattern": "^v([1-9][0-9]{3})\\.([1-9]|1[0-2])\\.(0|[1-9][0-9]{0,18})$",
"type": "string"
},
"minPlanSchema": {
"description": "Oldest executable plan schema accepted by this environment. Expects a plan schema identity such as onebox.run/executable-deploy-plan/v1alpha2.",
"examples": [
"onebox.run/executable-deploy-plan/v1alpha2"
],
"pattern": "^onebox\\.run/executable-deploy-plan/v[1-9][0-9]*((alpha|beta)[1-9][0-9]*)?$",
"type": "string"
},
"requireApproval": {
"default": true,
"description": "Require a plan-bound local confirmation before mutating this environment.",
"type": "boolean"
}
},
"type": "object"
},
"server": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"description": "SSH server, written as user@host or as an object with host, user, and port.",
"examples": [
"root@203.0.113.10"
],
"properties": {
"host": {
"description": "SSH hostname or IP address.",
"examples": [
"203.0.113.10"
],
"type": "string"
},
"port": {
"description": "SSH port. The SSH default is used when omitted.",
"examples": [
2222
],
"type": "integer"
},
"user": {
"description": "SSH user. $USER is used when omitted; ob does not read ~/.ssh/config.",
"examples": [
"root"
],
"type": "string"
}
},
"type": "object"
}
],
"description": "SSH server, written as user@host or as an object with host, user, and port. Also accepts user@host."
}
},
"type": "object"
},
"description": "Named environments, each naming the server it deploys to and the policy applied to it.",
"minProperties": 1,
"type": "object"
},
"externalServices": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"backupOwner": {
"description": "Operator or provider responsible for backup, restore, upgrades, credentials, and durability. Expects a stable operator or provider identity of letters, digits, dots, @, colons, slashes, underscores and hyphens.",
"examples": [
"platform-team/rds"
],
"pattern": "^[A-Za-z0-9][A-Za-z0-9._@:/-]{0,127}$",
"type": "string"
},
"connection": {
"additionalProperties": false,
"description": "Trusted connection source and driver-shaped entry mapping.",
"properties": {
"entries": {
"additionalProperties": {
"description": "Expects a variable name of letters, digits and underscores, not starting with a digit.",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
"type": "string"
},
"description": "Maps driver connection parts such as host, port, user, password, database, or url to variable names in the trusted source.",
"type": "object"
},
"source": {
"additionalProperties": false,
"description": "Trusted encrypted file containing the connection values.",
"properties": {
"file": {
"description": "Repository-relative encrypted environment file staged through the trusted secret flow. Expects a path inside the repository, with no control character or shell metacharacter.",
"examples": [
"secrets/production-db.env"
],
"pattern": "^[^/\\x00-\\x1f'\"$`\\\\][^\\x00-\\x1f'\"$`\\\\]*$",
"type": "string"
},
"provider": {
"default": "Sops",
"description": "Trusted secret provider. Only sops is currently executable.",
"enum": [
"Sops"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"driver": {
"description": "Built-in connection shape used to validate and project this dependency.",
"enum": [
"clickhouse",
"mariadb",
"meilisearch",
"minio",
"mongodb",
"mysql",
"nats",
"postgres",
"rabbitmq",
"redis",
"valkey"
],
"examples": [
"postgres"
],
"type": "string"
},
"probe": {
"additionalProperties": false,
"description": "Optional bounded read-only health observation; it never creates or repairs provider resources.",
"properties": {
"kind": {
"default": "DriverHealth",
"description": "Read-only observation kind: driver-health.",
"enum": [
"DriverHealth"
],
"type": "string"
},
"maxAge": {
"default": "5m",
"description": "Maximum age of a probe observation bound into a plan. Expects a duration such as 30s, 5m, 1h30m or 14d.",
"examples": [
"5m"
],
"pattern": "^(([0-9]+([.][0-9]+)?(ns|us|µs|ms|s|m|h))+|[0-9]+d)$",
"type": "string"
},
"timeout": {
"default": "5s",
"description": "Maximum duration of one read-only probe. Expects a duration such as 30s, 5m, 1h30m or 14d.",
"examples": [
"5s"
],
"pattern": "^(([0-9]+([.][0-9]+)?(ns|us|µs|ms|s|m|h))+|[0-9]+d)$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Typed dependencies operated outside Onebox. Their connection projection is trusted, but their lifecycle and backup remain external.",
"type": "object"
},
"hooks": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"local": {
"default": false,
"description": "Run on the operator machine instead of the server.",
"type": "boolean"
},
"run": {
"description": "Command executed at the lifecycle seam.",
"examples": [
"./scripts/notify.sh"
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Also accepts the command to run."
},
"description": "Lifecycle commands keyed by seam: bootstrap, pre_release, post_release, or post_deploy.",
"type": "object"
},
"notifications": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"format": {
"default": "Text",
"description": "Notification payload format.",
"enum": [
"Text",
"JSON"
],
"type": "string"
},
"on": {
"default": [
"success",
"failure"
],
"description": "Operation outcomes that trigger this notification.",
"items": {
"enum": [
"Success",
"Failure"
],
"type": "string"
},
"type": "array"
},
"webhook": {
"description": "HTTP endpoint that receives outcome notifications.",
"examples": [
"https://hooks.example.com/onebox"
],
"type": "string"
}
},
"type": "object"
},
"description": "Named webhooks that receive selected operation and scheduled-job outcomes.",
"type": "object"
},
"proxy": {
"additionalProperties": false,
"description": "Ownership and configuration of the host ingress proxy.",
"properties": {
"config": {
"description": "Repository-relative proxy configuration directory. Dynamic YAML or TOML files extend Onebox's managed configuration. A managed DNS challenge may use a directory containing only .env for provider credentials. Including traefik.yml or traefik.yaml instead takes ownership of the static configuration, which must use the watched file-provider directory /etc/traefik/dynamic, must not enable the Docker provider, must define certificatesResolvers.letsencrypt for exact terminating routes, and must define the DNS-01 certificatesResolvers.onebox-wildcard for wildcard terminating routes. Dynamic files may not reuse Onebox-generated router or service names or redefine the managed onebox-compress middleware. Expects a path inside the repository, with no control character or shell metacharacter.",
"pattern": "^[^/\\x00-\\x1f'\"$`\\\\][^\\x00-\\x1f'\"$`\\\\]*$",
"type": "string"
},
"dnsChallenge": {
"additionalProperties": false,
"description": "Managed ACME DNS-01 challenge used to issue wildcard certificates. Provider credentials belong in proxy.config/.env; Onebox continues to own the static proxy configuration.",
"properties": {
"provider": {
"description": "Traefik DNS challenge provider name. Its credential variables must be supplied through proxy.config/.env. Expects a lower-case Traefik DNS provider name such as cloudflare or route53.",
"examples": [
"cloudflare"
],
"pattern": "^[a-z][a-z0-9_-]*$",
"type": "string"
},
"resolvers": {
"description": "DNS resolvers used to verify challenge propagation, written as host:port.",
"examples": [
[
"1.1.1.1:53"
]
],
"items": {
"description": "Expects a lower-case DNS name, IPv4 address, or bracketed IPv6 address followed by a port.",
"pattern": "^([a-z0-9]([a-z0-9.-]*[a-z0-9])?|\\[[0-9A-Fa-f:.]+\\]):[0-9]{1,5}$",
"type": "string"
},
"type": "array"
}
},
"required": [
"provider"
],
"type": "object"
},
"entrypoints": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"port": {
"description": "Host and proxy-container TCP port used by this listener.",
"examples": [
4317
],
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"description": "Additional named TCP listeners published by the managed proxy. Onebox adds them to its generated static configuration; a proxy.config containing custom traefik.yml or traefik.yaml must define matching Traefik entrypoints.",
"propertyNames": {
"pattern": "^[a-z]([a-z0-9-]{0,38}[a-z0-9])?$"
},
"type": "object"
},
"image": {
"description": "Container image used for the managed proxy. Expects a registry reference such as nginx:1.27 or ghcr.io/acme/app@sha256:….",
"pattern": "^((?:(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*|\\[(?:[a-fA-F0-9:]+)\\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*)*)(?::([\\w][\\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]{32,}))?$",
"type": "string"
},
"kind": {
"default": "TraefikDocker",
"description": "Proxy implementation, or none to disable routing.",
"enum": [
"TraefikDocker",
"None"
],
"type": "string"
},
"managed": {
"description": "Let Onebox converge the host-scoped proxy when routes are declared.",
"type": "boolean"
},
"network": {
"default": "ob-ingress",
"description": "External container network shared with routed workloads; default and Onebox's derived application and service network names are reserved.",
"type": "string"
}
},
"type": "object"
},
"registries": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"passwordEnv": {
"description": "Local environment-variable name containing the registry password or token. Expects a variable name of letters, digits and underscores, not starting with a digit.",
"examples": [
"GHCR_TOKEN"
],
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
"type": "string"
},
"server": {
"description": "Registry hostname, optionally with a port. Expects a host with an optional port and path, such as ghcr.io or registry.example.com:5000.",
"examples": [
"ghcr.io"
],
"pattern": "^[A-Za-z0-9][A-Za-z0-9.-]*(:[0-9]{1,5})?(/[A-Za-z0-9._/-]*)?$",
"type": "string"
},
"username": {
"description": "Registry login username. Expects a username of letters, digits and . _ @ + -.",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._@+-]*$",
"type": "string"
}
},
"type": "object"
},
"description": "Named container registries and the environment variables holding their credentials.",
"type": "object"
},
"runtime": {
"additionalProperties": false,
"description": "Project-wide environment files and local environment-file requirements.",
"properties": {
"envChecks": {
"description": "Local environment-file assertions checked before planning or deploying.",
"items": {
"additionalProperties": false,
"properties": {
"file": {
"description": "Repository-relative dotenv file whose declared keys are checked. Expects a path inside the repository, with no control character or shell metacharacter.",
"examples": [
".env.production"
],
"pattern": "^[^/\\x00-\\x1f'\"$`\\\\][^\\x00-\\x1f'\"$`\\\\]*$",
"type": "string"
},
"present": {
"description": "Environment keys that must be declared but may be empty.",
"items": {
"type": "string"
},
"type": "array"
},
"require": {
"description": "Environment keys that must be declared with non-empty values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},