Skip to content
341 linesCodeBlameRaw
1// Everything g1t deploys to Cloudflare, in one place. Read by
2// scripts/deploy.mjs (plan, deploy), deploy/self-host/configs.mjs (what a
3// self-hosted installation runs) and the tests in scripts/deploy/.
4// docs/DEPLOYING.md explains each field and how to add a unit.
5//
6// What is written here is what the Wrangler configs cannot say. The rest is
7// read from each unit's wrangler.jsonc, never copied: its D1 databases and
8// migrations, the services it binds to, its KV, R2, queues and routes. The
9// shared crates and packages a unit is built from are read from Cargo's and
10// npm's workspace metadata. `worker` and `d1` are written here too, so the
11// file reads as an inventory, and a test checks they match the configs.
12{
13 // Deployed in this order. A stage starts only when the one before it
14 // succeeded. A unit binds only to units in its own stage or an earlier
15 // one (a test checks it), so new code never calls a service that has
16 // not shipped yet. Within a stage, units go out in parallel.
17 //
18 // migrations: every pending D1 migration, before any code.
19 // core: the services, reached through service bindings.
20 // edge: public endpoints other than the site: API, MCP, g1t.page, status
21 // (models is public too, but in core: agents binds to it).
22 // front: the site, sudo and the docs.
23 "stages": ["migrations", "core", "edge", "front"],
24
25 // Names for the resources the configs refer to by id, for setup
26 // commands and the docs. A test checks every KV id in a config is here.
27 "resources": {
28 "kv": {
29 "16a4232cb746418db53782aa068be693": "g1t-actions-blobs",
30 "e627b571f07047e187c03e1fc2b3bbdd": "g1t-avatars",
31 "14bc5c233d4c46a5bbf23b5367cce5fd": "g1t-domains",
32 "be765052d0124c2a935b3db4dff99f1f": "g1t-repos-git-cache"
33 }
34 },
35
36 // Each deployable unit, by short name (`--only events,web`).
37 //
38 // kind: rust-worker (worker-build), ts-worker (Wrangler bundles it),
39 // react-router (vite build first), astro (astro build first).
40 // secrets: names only; set with `npx wrangler secret put NAME` in its folder.
41 // setup: one-time steps no config can say, for a first deploy.
42 // self_host: what deploy/self-host does with it: "run" (in the one
43 // workerd), "off" (bound to the off Worker), "separate" (a
44 // process of its own), or "none".
45 // inputs: files outside its folder it is built from that no workspace
46 // metadata names (a test finds such imports).
47 // image: a Containers image (docs/DEPLOYING.md, "The runner's images"):
48 // dockerfile the image a deploy ships: the base plus the binary
49 // crate the crate that binary is built from (and what it uses)
50 // base { context: the base's folder, lock: the file that
51 // records the base that was pushed }; the base is
52 // rebuilt only when its folder changes
53 // repository where both are pushed in Cloudflare's registry
54 "units": {
55 "events": {
56 "path": "services/events",
57 "kind": "rust-worker",
58 "worker": "g1t-events",
59 "d1": { "database": "g1t-events", "migrations": "migrations" },
60 "stage": "core",
61 "secrets": [],
62 "setup": [
63 "The dead-letter queue every queue consumer sends what it gave up on to, before any unit that names it deploys: npx wrangler queues create g1t-events-dlq"
64 ],
65 "self_host": "run"
66 },
67 "identity": {
68 "path": "services/identity",
69 "kind": "rust-worker",
70 "worker": "g1t-identity",
71 "d1": { "database": "g1t", "migrations": "migrations" },
72 "stage": "core",
73 "secrets": ["GITHUB_APP_CLIENT_SECRET", "IDENTITY_KEY"],
74 "setup": ["Email Sending on g1t.sh (the EMAIL binding)"],
75 "self_host": "run"
76 },
77 "repos": {
78 "path": "services/repos",
79 "kind": "rust-worker",
80 "worker": "g1t-repos",
81 "d1": { "database": "g1t-repos", "migrations": "migrations" },
82 "stage": "core",
83 "secrets": ["REPOS_KEY"],
84 "setup": [
85 "The Artifacts namespace `g1t` (the ARTIFACTS binding)",
86 "The R2 bucket `g1t-git-packs` (GIT_PACKS) with its lifecycle rule: `npx wrangler r2 bucket create g1t-git-packs`, then `npx wrangler r2 bucket lifecycle add g1t-git-packs expire-packs packs/ --expire-days 7 --abort-multipart-days 1`",
87 "The R2 bucket for nightly backups: npx wrangler r2 bucket create g1t-backups"
88 ],
89 "self_host": "run"
90 },
91 "work": {
92 "path": "services/work",
93 "kind": "rust-worker",
94 "worker": "g1t-work",
95 "d1": { "database": "g1t-work", "migrations": "migrations" },
96 "stage": "core",
97 "secrets": [],
98 "self_host": "run"
99 },
100 "search": {
101 "path": "services/search",
102 "kind": "rust-worker",
103 "worker": "g1t-search",
104 "d1": { "database": "g1t-search", "migrations": "migrations" },
105 "stage": "core",
106 "secrets": [],
107 "self_host": "run"
108 },
109 "projects": {
110 "path": "services/projects",
111 "kind": "ts-worker",
112 "worker": "g1t-projects",
113 "d1": { "database": "g1t-projects", "migrations": "migrations" },
114 "stage": "core",
115 "secrets": [],
116 "self_host": "run"
117 },
118 "chat": {
119 "path": "services/chat",
120 "kind": "ts-worker",
121 "worker": "g1t-chat",
122 "d1": { "database": "g1t-chat", "migrations": "migrations" },
123 "stage": "core",
124 "secrets": [],
125 "setup": [
126 "The D1 database, before the first deploy: npx wrangler d1 create g1t-chat, then put its id in services/chat/wrangler.jsonc"
127 ],
128 "self_host": "run"
129 },
130 "agents": {
131 "path": "services/agents",
132 "kind": "ts-worker",
133 "worker": "g1t-agents",
134 "d1": { "database": "g1t-agents", "migrations": "migrations" },
135 "stage": "core",
136 "secrets": [],
137 "setup": [
138 "The D1 database, before the first deploy: npx wrangler d1 create g1t-agents, then put its id in services/agents/wrangler.jsonc"
139 ],
140 // Replies route and gate model work exactly as runs do, with the
141 // runner's own modules: its routing policy and who may use hosted models.
142 "inputs": ["services/runner/src/model-env.ts", "services/runner/src/hosted.ts"],
143 "self_host": "run"
144 },
145 "billing": {
146 "path": "services/billing",
147 "kind": "rust-worker",
148 "worker": "g1t-billing",
149 "d1": { "database": "g1t-billing", "migrations": "migrations" },
150 "stage": "core",
151 "secrets": ["STRIPE_SECRET_KEY", "STRIPE_WEBHOOK_SECRET", "CLOUDFLARE_USAGE_TOKEN"],
152 "self_host": "run"
153 },
154 "integrations": {
155 "path": "services/integrations",
156 "kind": "rust-worker",
157 "worker": "g1t-integrations",
158 "d1": { "database": "g1t-integrations", "migrations": "migrations" },
159 "stage": "core",
160 "secrets": ["INTEGRATIONS_KEY", "GITHUB_APP_PRIVATE_KEY", "GITHUB_APP_WEBHOOK_SECRET"],
161 "self_host": "run"
162 },
163 "webhooks": {
164 "path": "services/webhooks",
165 "kind": "rust-worker",
166 "worker": "g1t-webhooks",
167 "d1": { "database": "g1t-webhooks", "migrations": "migrations" },
168 "stage": "core",
169 "secrets": ["WEBHOOKS_KEY"],
170 "self_host": "run"
171 },
172 "actions": {
173 "path": "services/actions",
174 "kind": "rust-worker",
175 "worker": "g1t-actions",
176 "d1": { "database": "g1t-actions", "migrations": "migrations" },
177 "stage": "core",
178 "secrets": ["ACTIONS_KEY"],
179 "self_host": "run"
180 },
181 "packages": {
182 "path": "services/packages",
183 "kind": "rust-worker",
184 "worker": "g1t-packages",
185 "d1": { "database": "g1t-packages", "migrations": "migrations" },
186 "stage": "core",
187 "secrets": ["PACKAGES_TOKEN_SECRET", "R2_ACCESS_KEY_ID", "R2_SECRET_ACCESS_KEY"],
188 "setup": [
189 "The D1 database: npx wrangler d1 create g1t-packages, its id in services/packages/wrangler.jsonc",
190 "The R2 bucket for packages' files: npx wrangler r2 bucket create g1t-packages",
191 "The events queue: npx wrangler queues create g1t-events-packages",
192 "For signed downloads: an R2 API token with read access to g1t-packages, as R2_ACCESS_KEY_ID and R2_SECRET_ACCESS_KEY"
193 ],
194 "self_host": "run"
195 },
196 "security": {
197 "path": "services/security",
198 "kind": "rust-worker",
199 "worker": "g1t-security",
200 "d1": { "database": "g1t-security", "migrations": "migrations" },
201 "stage": "core",
202 "secrets": [],
203 "self_host": "run"
204 },
205 "deployments": {
206 "path": "services/deployments",
207 "kind": "ts-worker",
208 "worker": "g1t-deployments",
209 "d1": { "database": "g1t-deployments", "migrations": "migrations" },
210 "stage": "core",
211 "secrets": ["CLOUDFLARE_API_TOKEN"],
212 "setup": [
213 "Workers for Platforms, and the dispatch namespace: scripts/setup-deployments.sh",
214 "Custom domains (Cloudflare for SaaS on g1t.page): scripts/setup-custom-domains.sh"
215 ],
216 "self_host": "run"
217 },
218 "runner": {
219 "path": "services/runner",
220 "kind": "ts-worker",
221 "worker": "g1t-runner",
222 "stage": "core",
223 "secrets": ["AI_GATEWAY_TOKEN"],
224 "setup": [
225 "Containers on the account; Docker on the machine that builds a new image",
226 "The base image, once: node scripts/deploy.mjs build-base"
227 ],
228 "image": {
229 "dockerfile": "services/runner/Dockerfile",
230 // The binary the image adds to its base (scripts/build-runner.mjs).
231 "crate": "g1t-runner",
232 "base": { "context": "services/runner/base", "lock": "services/runner/base.json" },
233 "repository": "g1t-runner"
234 },
235 "self_host": "off"
236 },
237 "context": {
238 "path": "services/context",
239 "kind": "ts-worker",
240 "worker": "g1t-context",
241 "d1": { "database": "g1t-context", "migrations": "migrations" },
242 "stage": "core",
243 "secrets": [],
244 "setup": [
245 "The Vectorize index: npx wrangler vectorize create g1t-context --dimensions=768 --metric=cosine, with metadata indexes on workspace, kind, project and private"
246 ],
247 "self_host": "off"
248 },
249 "og": {
250 "path": "services/og",
251 "kind": "ts-worker",
252 "worker": "g1t-og",
253 "stage": "core",
254 "secrets": [],
255 "setup": ["Browser Rendering on the account (the BROWSER binding)"],
256 // The roadmap cards read the site's roadmap.
257 "inputs": ["apps/web/app/lib/roadmap.ts"],
258 "self_host": "none"
259 },
260 "api": {
261 "path": "apps/api",
262 "kind": "rust-worker",
263 "worker": "g1t-api",
264 "stage": "edge",
265 // ACTIONS_OIDC_KEY signs workflow jobs' OIDC tokens; without it the
266 // issuer answers 404 and jobs are not offered tokens.
267 // ACTIONS_OIDC_KEY_PREVIOUS only while rotating. docs/DEPLOYING.md.
268 "secrets": ["ACTIONS_OIDC_KEY"],
269 "setup": [
270 "The OIDC signing key for workflow jobs: an RSA key made with `openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048`, stored with `npx wrangler secret put ACTIONS_OIDC_KEY` (docs/DEPLOYING.md, \"OIDC tokens for workflow jobs\")",
271 "The actions cache bucket's lifecycle rule limited to `c/`, so artifacts under `a/` are kept their retention-days (docs/DEPLOYING.md)"
272 ],
273 "self_host": "separate"
274 },
275 "models": {
276 "path": "services/models",
277 "kind": "ts-worker",
278 "worker": "g1t-models",
279 // Core, though it is public at models.g1t.sh: the agents service
280 // reaches it by service binding for chat replies. It binds only to
281 // core services itself.
282 "stage": "core",
283 "secrets": ["AI_GATEWAY_TOKEN"],
284 "setup": ["The AI Gateway `g1t`"],
285 // Not run self-hosted, but bound to the off Worker: agents binds to it.
286 "self_host": "off"
287 },
288 "pages": {
289 "path": "services/pages",
290 "kind": "ts-worker",
291 "worker": "g1t-pages",
292 "stage": "edge",
293 "secrets": [],
294 "setup": ["A proxied wildcard DNS record on g1t.page (`*`, AAAA 100::): scripts/setup-deployments.sh"],
295 "self_host": "none"
296 },
297 "status": {
298 "path": "apps/status",
299 "kind": "ts-worker",
300 "worker": "g1t-status",
301 "d1": { "database": "g1t-status", "migrations": "migrations" },
302 "stage": "edge",
303 "secrets": ["STATUS_SECRET"],
304 "setup": ["Email Sending on g1t.sh (the EMAIL binding)"],
305 "self_host": "separate"
306 },
307 "web": {
308 "path": "apps/web",
309 "kind": "react-router",
310 "worker": "g1t",
311 "stage": "front",
312 // USERCONTENT_KEY signs the short-lived addresses of private
313 // repositories' files on g1tusercontent.com; without it they are
314 // served from g1t.sh instead.
315 "secrets": ["USERCONTENT_KEY"],
316 "setup": [
317 "The R2 bucket g1t-downloads, for the self-hosted runner's releases: npx wrangler r2 bucket create g1t-downloads",
318 "The zone g1tusercontent.com on the account; the Worker's custom domain on it is made by the deploy",
319 "The key for private files' addresses: `node -e \"console.log(require('crypto').randomBytes(32).toString('hex'))\" | npx wrangler secret put USERCONTENT_KEY` in apps/web"
320 ],
321 "self_host": "run"
322 },
323 "sudo": {
324 "path": "apps/sudo",
325 "kind": "react-router",
326 "worker": "g1t-sudo",
327 "stage": "front",
328 "secrets": [],
329 "setup": ["A Cloudflare Access application on sudo.g1t.sh; its AUD tag is ACCESS_AUD"],
330 "self_host": "none"
331 },
332 "docs": {
333 "path": "apps/docs",
334 "kind": "astro",
335 "worker": "g1t-docs",
336 "stage": "front",
337 "secrets": [],
338 "self_host": "none"
339 }
340 }
341}