Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1276 lines (1247 loc) · 39.4 KB
/
Copy pathopenapi.yaml
File metadata and controls
1276 lines (1247 loc) · 39.4 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
openapi: 3.0.0
info:
title: Orchard
description: Orchard orchestration API
version: 0.1.0
paths:
/controller/info:
get:
summary: "Retrieve controller's information"
tags:
- controller
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ControllerInfo'
/cluster-settings:
get:
summary: "Retrieve cluster settings"
tags:
- cluster-settings
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterSettings'
put:
summary: "Update cluster settings"
tags:
- cluster-settings
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterSettings'
responses:
'200':
description: Cluster settings were successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterSettings'
/service-accounts:
post:
summary: "Create a Service Account"
tags:
- service-accounts
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccount'
responses:
'200':
description: Service Account resource was successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccount'
'409':
description: Service Account resource with with the same name already exists
get:
summary: "List Service Accounts"
tags:
- service-accounts
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceAccount'
/service-accounts/{name}:
parameters:
- in: path
name: name
required: true
schema:
type: string
get:
summary: "Retrieve a Service Account"
tags:
- service-accounts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccount'
'404':
description: Service Account resource with the given name doesn't exist
put:
summary: "Update a Service Account"
tags:
- service-accounts
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccount'
responses:
'200':
description: Service Account object was successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccount'
'404':
description: Service Account resource with the given name doesn't exist
delete:
summary: "Delete a Service Account"
tags:
- service-accounts
responses:
'200':
description: Service Account resource was successfully deleted
'404':
description: Service Account resource with the given name doesn't exist
/workers:
get:
summary: "List Workers"
tags:
- workers
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Worker'
/workers/{name}:
parameters:
- in: path
name: name
required: true
schema:
type: string
get:
summary: "Retrieve a Worker"
tags:
- workers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Worker'
'404':
description: Worker resource with the given name doesn't exist
delete:
summary: "Delete a Worker"
tags:
- workers
responses:
'200':
description: Worker resource was successfully deleted
'404':
description: Worker resource with the given name doesn't exist
/workers/{name}/port-forward:
parameters:
- in: path
name: name
required: true
schema:
type: string
get:
summary: "Port-forward to a worker using WebSocket protocol"
tags:
- workers
parameters:
- in: query
name: port
description: Worker's TCP port number to connect to
schema:
type: integer
minimum: 1
maximum: 65535
required: true
- in: query
name: wait
description: Duration in seconds for the worker to become available if it's not available already
schema:
type: integer
minimum: 0
maximum: 65535
default: 10
required: false
- in: header
name: Connection
description: WebSocket protocol required header
required: true
schema:
type: string
- in: header
name: Upgrade
description: WebSocket protocol required header
required: true
schema:
type: string
responses:
'400':
description: Invalid port specified
'404':
description: Worker resource with the given name doesn't exist
'503':
description: Failed to establish connection with the requested worker
/vms:
post:
summary: "Create a VM"
tags:
- vms
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/VMMeta'
- $ref: '#/components/schemas/VMSpec'
responses:
'200':
description: VM resource was successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/VM'
'400':
description: Invalid VM specification
'409':
description: VM resource with the same name already exists
get:
summary: "List VMs"
tags:
- vms
parameters:
- in: query
name: filter
description: "Filter VMs using `path=value` syntax; currently only `worker=<name>` is supported to return VMs assigned to the given worker"
schema:
type: string
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VM'
/vms/{name}:
parameters:
- in: path
name: name
description: VM name to retrieve
required: true
schema:
type: string
- in: query
name: watch
description: Watch for changes a VM resource and return them a stream of ADDED, MODIFIED and DELETED notifications
schema:
type: boolean
get:
summary: "Retrieve a VM"
tags:
- vms
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VM'
application/x-ndjson:
schema:
type: object
properties:
type:
type: string
enum: [ ADDED, MODIFIED, DELETED ]
object:
$ref: '#/components/schemas/VM'
'404':
description: VM resource with the given name doesn't exist
put:
summary: "Update a VM"
tags:
- vms
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VMSpec'
responses:
'200':
description: VM object was successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/VM'
'400':
description: Invalid VM specification
'404':
description: VM resource with the given name doesn't exist
delete:
summary: "Delete a VM"
tags:
- vms
responses:
'200':
description: VM resource was successfully deleted
'404':
description: VM resource with the given name doesn't exist
/vms/{name}/events:
parameters:
- in: path
name: name
required: true
schema:
type: string
get:
summary: "Retrieve events for a given VM"
tags:
- vms
parameters:
- in: query
name: limit
description: Maximum number of events to return.
schema:
type: integer
minimum: 1
- in: query
name: order
description: Sort order of events; asc (default) or desc.
schema:
type: string
enum:
- asc
- desc
- in: query
name: cursor
description: Opaque cursor from the X-Next-Cursor response header.
schema:
type: string
responses:
'200':
description: OK
headers:
X-Next-Cursor:
description: Opaque cursor for the next page of events, if any.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Events'
'404':
description: VM resource with the given name doesn't exist
/vms/{name}/port-forward:
parameters:
- in: path
name: name
required: true
schema:
type: string
get:
summary: "Port-forward to a VM using WebSocket protocol"
description: |
Connect to a VM's TCP port, a declared host process, or its Tart Guest Agent.
Specify exactly one of `port`, `hostProcess`, or `target=tart-guest-agent`.
Connecting to Tart Guest Agent requires either the `compute:write` or `compute:connect:tart-guest-agent` role.
tags:
- vms
parameters:
- in: query
name: port
description: VM's TCP port number to connect to; mutually exclusive with `hostProcess` and `target`.
schema:
type: integer
minimum: 1
maximum: 65535
required: false
- in: query
name: hostProcess
description: Name of a host process declared in the VM's `hostProcesses` field; mutually exclusive with `port` and `target`.
schema:
type: string
required: false
- in: query
name: target
description: Forward to the specified target; mutually exclusive with `port` and `hostProcess`.
schema:
type: string
enum: [tart-guest-agent]
required: false
- in: query
name: wait
description: Duration in seconds to wait for the VM to transition into "running" state if not already running.
schema:
type: integer
minimum: 0
maximum: 65535
default: 10
required: false
- in: header
name: Connection
description: WebSocket protocol required header
required: true
schema:
type: string
- in: header
name: Upgrade
description: WebSocket protocol required header
required: true
schema:
type: string
responses:
'400':
description: Invalid query parameter or ambiguous port-forward target specified
'404':
description: VM or requested host process doesn't exist
'503':
description: Failed to establish connection with the worker responsible for the specified VM
/vms/{name}/exec:
parameters:
- in: path
name: name
required: true
schema:
type: string
get:
summary: "Execute a command inside a VM using WebSocket protocol"
tags:
- vms
parameters:
- in: query
name: command
description: Command to execute.
schema:
type: string
minLength: 1
required: true
- in: query
name: interactive
description: |
Whether to allocate an interactive standard input for the command
When enabled, make sure to close the standard input by sending a `ExecClientFrameStdin`
frame with an empty data. Otherwise the command might never terminate waiting for the
standard input to end.
schema:
type: boolean
default: false
required: false
- in: query
name: stdin
deprecated: true
description: |
Deprecated alias for `interactive`.
If both `interactive` and `stdin` are provided, their values must match.
schema:
type: boolean
default: false
required: false
- in: query
name: tty
description: Whether to allocate a pseudo-terminal for the command
schema:
type: boolean
default: false
required: false
- in: query
name: rows
description: Initial terminal row count when `tty=true`
schema:
type: integer
minimum: 0
maximum: 4294967295
required: false
- in: query
name: cols
description: Initial terminal column count when `tty=true`
schema:
type: integer
minimum: 0
maximum: 4294967295
required: false
- in: query
name: env
description: |
Environment variables to expose to the command.
Use deep object query syntax, for example `env[FOO]=bar&env[BAZ]=qux`.
style: deepObject
explode: true
schema:
type: object
additionalProperties:
type: string
required: false
- in: query
name: workdir
description: Working directory to switch to before starting the command
schema:
type: string
required: false
- in: query
name: wait
description: Duration in seconds for the VM to become available if it's not available already
schema:
type: integer
minimum: 0
maximum: 65535
default: 10
required: false
- in: header
name: Connection
description: WebSocket protocol required header
required: true
schema:
type: string
- in: header
name: Upgrade
description: WebSocket protocol required header
required: true
schema:
type: string
responses:
'101':
description: |
The connection has been upgraded to WebSocket. Messages exchanged after upgrade:
* Orchard Client → Orchard Controller: `ExecClientFrame`
* Orchard Controller → Orchard Client : `ExecControllerFrame`
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ExecClientFrame'
- $ref: '#/components/schemas/ExecControllerFrame'
'400':
description: Invalid parameters were supplied
'404':
description: VM resource with the given name doesn't exist
'503':
description: Controller failed to establish a connection with the VM
/vms/{name}/ip:
parameters:
- in: path
name: name
required: true
schema:
type: string
get:
summary: "Resolve the VM's IP address on the worker"
tags:
- vms
parameters:
- in: query
name: wait
description: Duration in seconds to wait for the VM to transition into "running" state if not already running.
schema:
type: integer
minimum: 0
maximum: 65535
default: 0
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IP'
'404':
description: VM resource with the given name doesn't exist
'503':
description: Failed to resolve the IP address on the worker responsible for the specified VM
components:
schemas:
Worker:
title: Worker node
type: object
properties:
name:
type: string
description: Node name
resources:
type: object
description: |
Dictionary that maps the resource name to the
amount of this resource provided by the worker
for running VMs.
additionalProperties:
type: integer
VM:
title: Virtual Machine
type: object
allOf:
- $ref: '#/components/schemas/VMMeta'
- $ref: '#/components/schemas/VMSpec'
- $ref: '#/components/schemas/VMState'
VMMeta:
title: Virtual Machine Metadata
type: object
properties:
name:
type: string
description: VM name
example: macos-tahoe-base
generation:
type: number
description: Incremented by the controller each time a VM's specification changes
readOnly: true
VMSpec:
title: Virtual Machine Specification
type: object
properties:
os:
type: string
description: |
Operating system used by a VM.
Set to `linux` to work around the Apple's limitation of 2 macOS VMs per host.
This field cannot be changed after the VM is created.
default: darwin
enum: [ darwin, linux ]
arch:
type: string
description: |
Hardware architecture to use for a VM.
This field cannot be changed after the VM is created.
default: arm64
enum: [ arm64, amd64 ]
runtime:
type: string
description: |
Runtime to use for a VM.
This field cannot be changed after the VM is created.
default: tart
enum: [ tart, vetu ]
image:
type: string
description: VM image for this VM
example: ghcr.io/cirruslabs/macos-tahoe-base:latest
imagePullPolicy:
type: string
description: VM image pull policy
default: IfNotPresent
enum: [ IfNotPresent, Always ]
cpu:
type: number
description: Number of CPUs assigned to this VM
default: 4
memory:
type: number
description: Amount of RAM in megabytes assigned to this VM
default: 8192
diskSize:
type: number
description: Disk size for this VM
example: 100
endpoints:
type: array
description: |
TCP or UDP services inside the VM to expose through ports on the Orchard
Worker. The worker ports assigned to the endpoints are reported in
`observedEndpoints`.
Endpoint ports listen on all worker network interfaces. Use firewall
rules to restrict access.
VMs with endpoints are scheduled only on workers that support endpoint
forwarding. Adding endpoints to a VM already assigned to an unsupported
worker succeeds, but those endpoints are reported in the `error` state.
items:
$ref: '#/components/schemas/EndpointSpec'
net-softnet:
type: boolean
description: Please use `netSoftnet` instead
default: false
deprecated: true
netSoftnet:
type: boolean
description: |
Whether to use Softnet network isolation.
See `tart run`'s help for `--net-softnet` for more details.
default: false
netSoftnetAllow:
type: array
description: |
List of CIDRs to allow the traffic to when using Softnet isolation.
See `tart run`'s help for `--net-softnet-allow` for more details.
Enables `netSoftnet`.
example:
- "192.168.0.0/24"
items:
type: string
netSoftnetBlock:
type: array
description: |
List of CIDRs to block the traffic to when using Softnet isolation.
See `tart run`'s help for `--net-softnet-block` for more details.
Enables `netSoftnet`.
example:
- "66.66.0.0/16"
items:
type: string
usbAccessories:
type: boolean
description: |
Whether to enable USB accessories in a Tart VM. When disabled, the worker
passes `--no-usb-accessories` to `tart run`. Requires a Tart version that supports
this flag. Native Mac input remains available where supported.
Changing this setting restarts the VM and is not supported for
suspendable VMs.
default: false
suspendable:
type: boolean
description: |
When set, a VM will be started with an additional
`--suspendable` command-line argument to `tart run`,
which allows suspending it.
Further generations of the VM will be `tart suspend`'ed instead of
`tart stopped`.
For example, this allows you to prepare a VM with loose Softnet settings and then
move to the next generation by tightening the settings while preserving the VM's state.
default: false
net-bridged:
type: string
description: Whether to use bridged network mode
example: en0
headless:
type: boolean
description: Whether to run without graphics
default: false
nested:
type: boolean
description: Enable nested virtualization
default: false
audio:
type: boolean
description: |
Whether to enable audio pass-through to the host for a Tart VM.
Disabled by default. This field cannot be changed after the VM is created.
default: false
clipboard:
type: boolean
description: |
Whether to enable clipboard sharing between host and guest for a Tart VM.
Disabled by default. This field cannot be changed after the VM is created.
default: false
username:
type: string
description: SSH username to use when connecting to a VM
default: admin
password:
type: string
description: SSH password to use when connecting to a VM
default: admin
startup_script:
type: object
description: Startup script to run after the VM boots
properties:
transport:
type: string
description: |
Transport used to execute the startup script.
Omitted or empty values use SSH.
`tart-guest-agent` is supported only with the Tart runtime.
enum: [ "", ssh, tart-guest-agent ]
default: ssh
script_content:
type: string
env:
type: object
additionalProperties:
type: string
example:
script_content: |
#!/bin/zsh
echo $GREETING
env:
GREETING: "Hello, World!"
restart_policy:
type: string
description: |
VM restart policy: specify "Never" to never restart or "OnFailure" to only restart when the VM fails
default: Never
enum: [ Never, OnFailure ]
resources:
type: object
description: Resources required by this VM on the worker
additionalProperties:
type: integer
example:
org.cirruslabs.logical-cores: 4
org.cirruslabs.memory-mib: 8192
labels:
type: object
description: Labels required by this VM on the worker
additionalProperties:
type: string
example:
model: macstudio
hostDirs:
type: array
description: |
Directories on the Orchard Worker host to mount to a VM.
Requires running Orchard Controller with `--insecure-allow-host-dirs`.
items:
type: object
properties:
name:
type: string
path:
type: string
ro:
type: boolean
example:
- path: /path/on/host/to/sources
ro: true
- path: /path/on/host/to/builds
hostProcesses:
type: array
description: |
Generic long-running processes run by the Orchard worker alongside this VM.
Their lifecycle is tied to the VM. Updating this field restarts the associated
host processes without restarting the VM.
items:
$ref: '#/components/schemas/HostProcess'
powerState:
type: string
description: |
Desired power state of the VM.
When set to `stopped` or `suspended`, the VM does not consume any `resources`
and can serve as a source for creating new Orchard VMs on the same worker. See
`localName` for more details.
Note that you can only transition into `stopped` or `suspended` only once
at the moment.
default: running
enum: [ running, stopped, suspended ]
localName:
type: string
description: |
Name of the local VM backing this VM resource.
`localName` is specific to a worker, whereas `name` is cluster-wide.
`localName` is useful in combination with `powerState` for creating stopped or suspended VMs
that can be used to start or resume new VMs on the same worker.
However, with great power comes great responsibility. You need to make sure:
* that these new VMs will target the same worker using `labels` or `resources`,
otherwise they will fail with the "the specified VM does not exist" error
* that there's only one cloned new VM for each suspended VM at a time;
if you clone more new VMs from a single suspended VM, Tart will give them
new MAC addresses automatically, which will stop them from booting,
since the suspend‑resume machinery expects the same MAC address
readOnly: true
tartName:
type: string
description: |
Deprecated alias for `localName`.
readOnly: true
deprecated: true
ConnectionTarget:
title: Connection target
type: object
description: A connection destination relative to the containing resource or action.
required:
- vm
properties:
vm:
$ref: '#/components/schemas/ConnectionTargetVM'
ConnectionTargetVM:
title: VM connection target
type: object
required:
- port
properties:
port:
type: integer
minimum: 1
maximum: 65535
description: Port inside the contextual VM, using the endpoint's protocol.
PortRange:
title: Port range
type: object
description: |
Inclusive bounds for selecting a network port. `min` must be less than or
equal to `max`; equal bounds identify one port.
required:
- min
- max
properties:
min:
type: integer
minimum: 1
maximum: 65535
description: Inclusive lower bound for port selection.
max:
type: integer
minimum: 1
maximum: 65535
description: Inclusive upper bound for port selection.
EndpointSpec:
title: Endpoint specification
type: object
description: A desired worker TCP or UDP endpoint backed by a connection target.
required:
- name
- protocol
- target
properties:
name:
type: string
minLength: 1
description: Stable endpoint identifier, unique within `endpoints`.
protocol:
type: string
enum: [ tcp, udp ]
description: |
Transport protocol for both the worker socket and the VM target.
TCP and UDP endpoints can use the same port number but must have different names.
target:
$ref: '#/components/schemas/ConnectionTarget'
workerPortRange:
description: |
Optional inclusive bounds for selecting the worker port. When omitted,
the operating system selects an available port. Equal bounds request
that exact port.
allOf:
- $ref: '#/components/schemas/PortRange'
EndpointStatus:
title: Endpoint status
type: object
description: Current observation for a desired endpoint.
required:
- name
- protocol
- state
properties:
name:
type: string
minLength: 1
description: Stable endpoint identifier matching the desired endpoint.
protocol:
type: string
enum: [ tcp, udp ]
description: Endpoint transport protocol.
workerPort:
type: integer
minimum: 1
maximum: 65535
description: Port assigned to this endpoint on the Orchard Worker for its protocol.
state:
type: string
enum: [ listening, error ]
description: |
Exposure state. `listening` means that the worker socket is bound; it
does not imply that the service inside the VM is healthy or responding.
message:
type: string
description: Human-readable detail, primarily populated when `state` is `error`.
HostProcess:
title: VM-associated host process
type: object
description: A long-running process run by the Orchard worker alongside a VM.
required: