Directories
¶
| Path | Synopsis |
|---|---|
|
Package api implements the connect services of the orchestrator (SPEC §6.1, §6.4, §6.5).
|
Package api implements the connect services of the orchestrator (SPEC §6.1, §6.4, §6.5). |
|
Package auth handles principals, tokens and OAuth/OIDC login.
|
Package auth handles principals, tokens and OAuth/OIDC login. |
|
Package buildctl is the build controller of an orchestrator (SPEC §05.6.2, §05.7, §06 §6.9.4–§6.9.5): it creates builds (webhook, API, remote, retry, rerun), plans their jobs through the fleet queue, follows the jobs to their results, verifies evaluation reports (pipeline match, R-PIPE-003), applies the concurrency rule (R-PIPE-005), keeps the build indexes (bidx, bpage, bbr, bnodes) and reports per-pipeline commit statuses.
|
Package buildctl is the build controller of an orchestrator (SPEC §05.6.2, §05.7, §06 §6.9.4–§6.9.5): it creates builds (webhook, API, remote, retry, rerun), plans their jobs through the fleet queue, follows the jobs to their results, verifies evaluation reports (pipeline match, R-PIPE-003), applies the concurrency rule (R-PIPE-005), keeps the build indexes (bidx, bpage, bbr, bnodes) and reports per-pipeline commit statuses. |
|
jobspec
Package jobspec is the contract between the build controller and the workers: the target selection a JobSpec carries, the pipeline matcher (SPEC §6.9.4 pipeline.Match) and the evaluation report a job stages.
|
Package jobspec is the contract between the build controller and the workers: the target selection a JobSpec carries, the pipeline matcher (SPEC §6.9.4 pipeline.Match) and the evaluation report a job stages. |
|
Package cache serves the Nix binary cache of an orchestrator (SPEC §6.6, ADR 0014): the /nix/ endpoints, the per-object visibility documents (D58) and the streaming download proxy (D61).
|
Package cache serves the Nix binary cache of an orchestrator (SPEC §6.6, ADR 0014): the /nix/ endpoints, the per-object visibility documents (D58) and the streaming download proxy (D61). |
|
Package fleet holds the wire formats and the cryptography that workers and orchestrators share (SPEC §05.9.2, S11 §5.2/§5.3): worker ids, registration documents, sealed worker tokens, proofs of possession, signed heartbeats, signed job specs and job results, and the sealed checkout credential.
|
Package fleet holds the wire formats and the cryptography that workers and orchestrators share (SPEC §05.9.2, S11 §5.2/§5.3): worker ids, registration documents, sealed worker tokens, proofs of possession, signed heartbeats, signed job specs and job results, and the sealed checkout credential. |
|
Package fleetsrv is the fleet side of a bob-server orchestrator (SPEC §05.6–§05.11): the orchestrator signing key, the fleet controllers of internal/orchestrator run as server components (registrar, job-reconciler, forge-sweeper), the Attach hub and wake-up dispatch, and the FleetService and WorkerControlService handlers.
|
Package fleetsrv is the fleet side of a bob-server orchestrator (SPEC §05.6–§05.11): the orchestrator signing key, the fleet controllers of internal/orchestrator run as server components (registrar, job-reconciler, forge-sweeper), the Attach hub and wake-up dispatch, and the FleetService and WorkerControlService handlers. |
|
Package forge defines forge.Adapter and the GitHub, GitLab and Forgejo adapters.
|
Package forge defines forge.Adapter and the GitHub, GitLab and Forgejo adapters. |
|
forgejo
Package forgejo is the Forgejo adapter of internal/forge.
|
Package forgejo is the Forgejo adapter of internal/forge. |
|
github
Package github is the GitHub adapter of internal/forge, built on the official SDK google/go-github (D48).
|
Package github is the GitHub adapter of internal/forge, built on the official SDK google/go-github (D48). |
|
gitlab
Package gitlab is the GitLab adapter of internal/forge, built on GitLab's official Go client gitlab.com/gitlab-org/api/client-go.
|
Package gitlab is the GitLab adapter of internal/forge, built on GitLab's official Go client gitlab.com/gitlab-org/api/client-go. |
|
integration
Package integration runs bob's forge integrations on an orchestrator (SPEC §6.9): the integration records and their adapters, the webhook intake (POST /hooks/<id>, §6.9.3), ForgeService, repository links (§05.4.5) and the forge side of checkout credentials (§6.9.6).
|
Package integration runs bob's forge integrations on an orchestrator (SPEC §6.9): the integration records and their adapters, the webhook intake (POST /hooks/<id>, §6.9.3), ForgeService, repository links (§05.4.5) and the forge side of checkout credentials (§6.9.6). |
|
gen
|
|
|
Package http runs the server listeners, the endpoint map and the middleware (SPEC §6.2).
|
Package http runs the server listeners, the endpoint map and the middleware (SPEC §6.2). |
|
Package isolation is the worker's build isolation (SPEC §05.8, R-FLEET-008 / R-SEC-000, ADR 0015 decision 4): the host check a root worker runs before it starts, the job container every job runs in (bob's own namespace code: no OCI runtime, no daemon), and the root-mode configuration of the embedded Nix inside it.
|
Package isolation is the worker's build isolation (SPEC §05.8, R-FLEET-008 / R-SEC-000, ADR 0015 decision 4): the host check a root worker runs before it starts, the job container every job runs in (bob's own namespace code: no OCI runtime, no daemon), and the root-mode configuration of the embedded Nix inside it. |
|
Package logstore stores and reads build logs and package runs in the lake (SPEC §05.10, ADR 0012, ADR 0019).
|
Package logstore stores and reads build logs and package runs in the lake (SPEC §05.10, ADR 0012, ADR 0019). |
|
Package netguard keeps the server's outgoing requests to configured URLs (forge APIs, notification webhooks) away from internal addresses (I-R2 F8, decision A396): loopback, private, link-local (the cloud metadata service), shared, unspecified, multicast and reserved addresses are refused at connect time, after name resolution, unless the operator allows the host or range (server.outbound_allow, BOB_SERVER_OUTBOUND_ALLOW).
|
Package netguard keeps the server's outgoing requests to configured URLs (forge APIs, notification webhooks) away from internal addresses (I-R2 F8, decision A396): loopback, private, link-local (the cloud metadata service), shared, unspecified, multicast and reserved addresses are refused at connect time, after name resolution, unless the operator allows the host or range (server.outbound_allow, BOB_SERVER_OUTBOUND_ALLOW). |
|
Package notify sends bob's outgoing webhooks (SPEC §6.9.8, R-PIPE-006): NotifyService manages the receivers, Publish queues an event for every matching receiver in a durable outbox, and the notify controller delivers it, signed, with retries at 0, 10 s, 1 min, 10 min and 1 h after the event.
|
Package notify sends bob's outgoing webhooks (SPEC §6.9.8, R-PIPE-006): NotifyService manages the receivers, Publish queues an event for every matching receiver in a durable outbox, and the notify controller delivers it, signed, with retries at 0, 10 s, 1 min, 10 min and 1 h after the event. |
|
Package orchestrator runs the orchestrator controllers.
|
Package orchestrator runs the orchestrator controllers. |
|
Package overview serves the read-mostly RPCs of the UI's overview, analytics, cache and settings pages (SPEC §6.5.10, §6.5.13, §6.5.16) over the §05 index documents.
|
Package overview serves the read-mostly RPCs of the UI's overview, analytics, cache and settings pages (SPEC §6.5.10, §6.5.13, §6.5.16) over the §05 index documents. |
|
Package project owns projects on the server (SPEC §6.5.6, §05.4.2): the proj/ records, the projects index, ProjectService, the Projects provider of the build controller and the pipelines cache behind ListPipelines.
|
Package project owns projects on the server (SPEC §6.5.6, §05.4.2): the proj/ records, the projects index, ProjectService, the Projects provider of the build controller and the pipelines cache behind ListPipelines. |
|
Package promote verifies the staged outputs of succeeded jobs and promotes them into the binary cache (SPEC §6.6.4, R-REG-002, R-REG-152, R-REG-005), deletes the promoted staging by known key (R-STORE-105), and manages the cache signing keys and their rotation (R-REG-153).
|
Package promote verifies the staged outputs of succeeded jobs and promotes them into the binary cache (SPEC §6.6.4, R-REG-002, R-REG-152, R-REG-005), deletes the promoted staging by known key (R-STORE-105), and manages the cache signing keys and their rotation (R-REG-153). |
|
Package rbac is bob's authorization (SPEC §6.4, M15.4): role permissions evaluated per RPC and project, the built-in role admin, the permission catalogue read from the methods' bob.authz.v1.rule options, the escalation check of role bindings, OIDC claim → role mapping evaluation, and the resolution of build/job/release/repository ids to projects.
|
Package rbac is bob's authorization (SPEC §6.4, M15.4): role permissions evaluated per RPC and project, the built-in role admin, the permission catalogue read from the methods' bob.authz.v1.rule options, the escalation check of role bindings, OIDC claim → role mapping evaluation, and the resolution of build/job/release/repository ids to projects. |
|
Package registry serves the OCI pull registry.
|
Package registry serves the OCI pull registry. |
|
Package release manages release state on the server.
|
Package release manages release state on the server. |
|
Package safe starts goroutines that cannot crash the process (AGENTS.md §5.3).
|
Package safe starts goroutines that cannot crash the process (AGENTS.md §5.3). |
|
Package server is the process frame of `bob-server orchestrator` and `bob-server worker`: configuration from the environment, start-up checks through internal/store, the components a process runs (listeners, controllers, the worker loop) and graceful shutdown.
|
Package server is the process frame of `bob-server orchestrator` and `bob-server worker`: configuration from the environment, start-up checks through internal/store, the components a process runs (listeners, controllers, the worker loop) and graceful shutdown. |
|
Package store is the only dynamitedb access of the server (R-STORE-106).
|
Package store is the only dynamitedb access of the server (R-STORE-106). |
|
s3client
Package s3client builds the AWS S3 clients of the store and its sweeps: path-style addressing, SDK retries only where a caller asks for them (the store's dynamitedb buckets, which resolve a retried write themselves, R-STORE-103 rule 7) and plain payload checksums so that signed requests stay simple.
|
Package s3client builds the AWS S3 clients of the store and its sweeps: path-style addressing, SDK retries only where a caller asks for them (the store's dynamitedb buckets, which resolve a retried write themselves, R-STORE-103 rule 7) and plain payload checksums so that signed requests stay simple. |
|
sweep
Package sweep runs the cold sweeps, the only LIST calls of the server (R-STORE-101): only on the analytics and artifacts buckets, at most once per hour per controller, and every request carries the User-Agent suffix bob-sweep/<controller>.
|
Package sweep runs the cold sweeps, the only LIST calls of the server (R-STORE-101): only on the analytics and artifacts buckets, at most once per hour per controller, and every request carries the User-Agent suffix bob-sweep/<controller>. |
|
Package ui serves the embedded web UI (SPEC §6.10, R-UI-001): the static SvelteKit build of web/ (adapter-static, web/build) on the main listener at "/" with the SPA fallback 200.html.
|
Package ui serves the embedded web UI (SPEC §6.10, R-UI-001): the static SvelteKit build of web/ (adapter-static, web/build) on the main listener at "/" with the SPA fallback 200.html. |
|
Package worker runs the root worker loop and job containers.
|
Package worker runs the root worker loop and job containers. |
Click to show internal directories.
Click to hide internal directories.