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
{
"lexicon": 1,
"id": "computer.socialweb.infra",
"description": "A long-lived deployment: a set of compute contracts, each declared with the state its author wants. Any client of the account may change the declaration; the socialweb-computer requester that runs the deployment writes the status. When the deployment ends its record is kept with status.endedAt.",
"defs": {
"main": {
"type": "record",
"key": "any",
"record": {
"type": "object",
"required": ["createdAt"],
"properties": {
"description": { "type": "string", "maxLength": 1024 },
"contracts": {
"type": "array",
"maxLength": 64,
"items": { "type": "ref", "ref": "#contract" },
"description": "The declared contracts. Names are unique within the record."
},
"status": { "type": "ref", "ref": "#status" },
"index": {
"type": "ref",
"ref": "#index",
"description": "Only at rkey self: the account's index of live deployments. A record with index is not a deployment."
},
"createdAt": { "type": "string", "format": "datetime" }
}
}
},
"contract": {
"type": "object",
"required": ["name", "state"],
"properties": {
"name": { "type": "string", "maxLength": 63, "description": "A DNS-1123 label, unique within the deployment." },
"state": {
"type": "string",
"knownValues": ["staged", "requested", "released"],
"description": "staged: declared, no RFP is sent. requested: the requester runs the RFP flow and holds the guest. released: the guest is released."
},
"releaseRequestedAt": { "type": "string", "format": "datetime", "description": "With state released: the time of the newest release request; a newer one asks a failed release again." },
"vmName": { "type": "string", "maxLength": 253 },
"bidderDids": { "type": "array", "items": { "type": "string", "format": "did" } },
"denyBidderDids": { "type": "array", "items": { "type": "string", "format": "did" } },
"sshAuthorizedKeys": { "type": "array", "items": { "type": "string" } },
"userData": { "type": "string", "maxLength": 65536, "description": "cloud-init user_data; never a secret, it is public here." },
"computeKind": { "type": "string", "knownValues": ["vm", "deno"], "description": "What the bidder runs: a firecracker virtual machine (the default when absent), or a deno sandbox that runs spec.userData as its program." },
"policy": { "type": "string" },
"policyArgs": { "type": "string" },
"vmReadyTimeoutSec": { "type": "integer", "minimum": 0 },
"tunnels": {
"type": "array",
"items": { "type": "ref", "ref": "#tunnel" },
"description": "Guest ports the requester reaches over a tunnel transport. Tags are unique within the contract."
},
"agent": { "type": "ref", "ref": "#agent" },
"association": { "type": "ref", "ref": "#association" },
"guestTools": {
"type": "array",
"items": { "type": "string", "knownValues": ["socialweb-computer"] },
"description": "Tools the bidder installs on the guest from its own downloads. socialweb-computer is the bidder's own running binary, linux/amd64 bidders only, installed as /usr/local/bin/socialweb-computer."
}
}
},
"tunnel": {
"type": "object",
"required": ["tag", "port"],
"properties": {
"tag": { "type": "string", "maxLength": 32, "description": "A DNS-1123 label naming the tunnel." },
"port": { "type": "integer", "minimum": 1, "maximum": 65535, "description": "The guest port, on 127.0.0.1." },
"server": { "type": "string", "format": "uri", "description": "The opentunnel server; absent means the requester's default." },
"shell": { "type": "ref", "ref": "#shell" },
"transport": {
"type": "string",
"knownValues": ["opentunnel", "webrtc"],
"description": "opentunnel (the default) gives an https URL; webrtc gives a datachannel to the guest agent."
}
}
},
"shell": {
"type": "object",
"description": "A web shell served on the tunnel's port; its token arrives through the contract's secrets bundle, never here.",
"properties": {
"envFile": { "type": "string", "maxLength": 256, "description": "The guest path of the shell's env file; absent means /etc/wootty/wootty.env." }
}
},
"agent": {
"type": "object",
"description": "An atirc agent on the guest, started on demand; its token arrives through the contract's secrets bundle, never here.",
"properties": {
"envFile": { "type": "string", "maxLength": 256, "description": "The guest path of the agent's env file; absent means /etc/atirc/atirc.env." }
}
},
"association": {
"type": "object",
"description": "A requester the guest runs: after the accept the requester writes a contract-scoped com.publicdomainrelay.temp.market.association naming subject and puts its at-uri#cid into the secrets bundle at refFile.",
"properties": {
"subject": { "type": "string", "format": "did", "description": "The repo DID of the requester the guest runs, when it is known before the RFP." },
"fromGuest": { "type": "boolean", "description": "The subject is the DID the guest reports in a compute.events.guest.requesterDid event; set instead of subject." },
"refFile": { "type": "string", "maxLength": 256, "description": "The guest path of the ref file, under /etc/socialweb-computer/; absent means /etc/socialweb-computer/association-ref." }
}
},
"status": {
"type": "object",
"required": ["phase"],
"properties": {
"phase": {
"type": "string",
"knownValues": ["pending", "staged", "deploying", "deployed", "releasing", "released", "degraded", "ending", "deleting", "ended"]
},
"contracts": { "type": "array", "items": { "type": "ref", "ref": "#contractStatus" } },
"endedAt": { "type": "string", "format": "datetime", "description": "Set once, when the deployment ends; the record is kept and an ended record is never live again." },
"endReason": { "type": "string", "knownValues": ["deleted"] }
}
},
"index": {
"type": "object",
"required": ["updatedAt"],
"properties": {
"live": { "type": "array", "maxLength": 256, "items": { "type": "ref", "ref": "#indexEntry" }, "description": "Absent means no live deployment." },
"recentEnded": {
"type": "array",
"maxLength": 32,
"items": { "type": "ref", "ref": "#indexEnded" },
"description": "Newest first; the oldest drops off. The records themselves are kept."
},
"updatedAt": { "type": "string", "format": "datetime" }
}
},
"indexEntry": {
"type": "object",
"required": ["collection", "rkey", "createdAt", "addedAt"],
"properties": {
"collection": { "type": "string", "format": "nsid", "knownValues": ["computer.socialweb.infra", "computer.socialweb.ephemeralInfra"] },
"rkey": { "type": "string", "format": "record-key" },
"createdAt": { "type": "string", "format": "datetime" },
"expiresAt": { "type": "string", "format": "datetime", "description": "EphemeralInfra only: createdAt plus ttlSeconds." },
"addedAt": { "type": "string", "format": "datetime" },
"writer": { "type": "string", "maxLength": 64, "description": "A public label of the kcp that runs it: page:<origin host>, ios, gateway:<host>, cli." }
}
},
"indexEnded": {
"type": "object",
"required": ["collection", "rkey", "endedAt"],
"properties": {
"collection": { "type": "string", "format": "nsid" },
"rkey": { "type": "string", "format": "record-key" },
"endedAt": { "type": "string", "format": "datetime" },
"endReason": { "type": "string" }
}
},
"contractStatus": {
"type": "object",
"required": ["name", "phase"],
"properties": {
"name": { "type": "string" },
"phase": {
"type": "string",
"knownValues": ["staged", "requesting", "deployed", "releasing", "released", "failed"]
},
"winner": { "type": "string", "format": "did" },
"receipt": { "type": "string", "format": "at-uri" },
"message": { "type": "string", "maxLength": 1024 }
}
}
}
}
