Stand-ins¶
Every workaround is a feature waiting for the platform (#113): what the project does by hand until the platform offers it (#269).
Every pull request and issue says which stand-in it creates or retires; a feature that retires one carries the dogfood label.
| Stand-in | Replaced by |
|---|---|
The CLI reaches people through a second, public repository, getnereus/install (its install script, GitHub Pages and one Release per version), published by make cli-publish from the owner's machine, because getnereus/nereus stays private until a first version (#1782, #9) |
The releases of getnereus/nereus itself once it is public, published by the release line |
claude-peers (the owner's linux repository, #1360) reads Claude Code's own session registry (~/.claude/sessions/) and the process tree to tell a hook's headless helper session from a peer (#1340) |
ListAgents showing a session's parent, or the hook naming the session it starts (claude --name); then Triton's room (#618) |
An authentication Mandate's allow covers a whole namespace, builds, which every tenant shares, and a team writes its own Workload's repository; so a Token is asked only when the Workload's owner, and the Build's when it names one, are in the buildkit Nereid's BUILD_TOKEN_OWNERS (empty by default), and any other Build of a repository a Mandate covers stays Pending, TenantTokenNotSupported (#1070, spec 0009) |
#1331: a tenant's Build gets a clone token only for a repository its own Organization is allowed |
A namespace that asks Tokens is labelled authentication.<domain>/tokens=true, and the Role of each Nereid serving the Token there is applied by the CLI: by nereid apply of a Nereid that serves it, by nereid apply catalog, by nereid apply buildkit (in builds, #1070), and by nereus authentication token create (#1274); which Nereids serve the Token, a kind only some Nereids of the reef serve, is pinned in contracts.KINDS_SOME_NEREIDS_SERVE |
The API granting a Nereid what a requester's namespace asks of it (ADR 0018), and a reef saying which of its kinds are optional |
scripts/deploy/line run verifies a main by hand with make scene-core, and make release publishes it from the owner's machine (#1611, walkthrough) |
The line on the platform: naxos mirrors main and builds it (#1613, #1614, #1615), publishes the release (#1616) and upgrades itself (#1531) |
The notes of the ideas reef reach the cluster as a host folder that rclone sync fills every hour from the owner's machine, mounted on the k3d nodes (NEREUS_K3D_NOTES) and read by doris (#1106, controllers/doris) |
doris reading the notes' store itself with a credential from the secrets reef (its own issue, opened when #1106 closes) |
leagore's memory store (STORE=memory), for unit tests and make scene-core, which install no database: a Session and its deck last as long as the process (#1695, controllers/leagore) |
the PostgreSQL store, a Database of the database reef, which is what every installation runs (STORE=postgres) |
| Who may publish to a Repository is not enforced: whoever reaches its Secret may push (#1013) | The registry's token service asking the authorization reef's check (after #1644, whose first slice covers the Nereus API only) |
nereus registry repository publish reads the push Secret and port-forwards through the person's kubeconfig (#1013) |
The Nereus API, ADR 0018 (the one door between the platform and the world) |
One read credential per Registry serves every Environment the vault registries allows (#1015) |
A credential per Environment (#953) |
The zot Nereid issues each Registry's certificate from the platform's registry CA, whose key it reads from the Secret registry-ca (#1064) |
The certificate reef, with cert-manager as its reference Nereid (#1101) |
nereus doctor reads a developer's failing Releases with that person's own kube context, not through the Nereus API, since a Release has no owner and the API no per-person route (#854) |
The authorization reef (ADR 0015), so GET /v1/doctor answers each person what they may read |
OpenBao's unseal key in the Kubernetes Secret openbao-seal, read by its static seal (#797, controllers/openbao) |
Auto-unseal by a cloud KMS, the key outside the cluster |
The reefs with no kinds by design, pinned in the CLI (contracts.REEFS_WITHOUT_KINDS, #794) |
Each reef's own kinds (#535 for authentication) |
The portal's client nereus-portal written by the keycloak Nereid, its redirects from the portal Mandates' publicUrl (#731) |
The authentication reef's Client kind (#535) |
The scm reef's webhook receiver, POST /scm/webhook on the github Nereid's Service, is reached only inside the cluster (#1281) |
The receiver exposed to GitHub through the edge reef (#577) |
The other reefs a local Nereid may serve next to its own, opt-in, in the CLI's table of the local Nereids (local_nereids.TOOLS, also: the github Nereid's scm reef, #1281) |
A Nereid that looks after several reefs, declared by its image (#72) |
The reefs a local Nereid requires, in the CLI's table of the local Nereids (local_nereids.TOOLS), since one image runs them all (#420) |
Each Nereid's image label core.getnereus.dev/requires (ADR 0014) |
LOCAL_REGISTRY of the catalog Nereid: the one address its lookups call outside their rules, because an entry names the local registry as localhost:5111 (#904) |
A public registry for the images |
LOCAL_REGISTRY of thetis, the installer Nereid: the address it reads the local Nereids' images at from its Pod, because their references name the local registry as localhost:5111 (#1053) |
A public registry for the images |
ingress.address of the chart nereus (NEREUS_INGRESS_ADDRESS of thetis): the address the portal's Mandate gets as publicUrl, and the keycloak Mandate with auth. before its host (#1933), because thetis, in its Pod, cannot ask k3d for the ingress port (#1079) |
The edge reef owning routes (#470) |
LOCAL_REGISTRY of the kubernetes Nereid: the one address its digest and port lookups call outside their rules, because a Delivery names the local registry as localhost:5111 (#845) |
A public registry for the images |
The kubeconfig of nereus workload deploy and nereus delivery: they write to the cluster directly, until ADR 0018 (the Nereus API, the one door) serves them (#845) |
The Nereus API |
The kubeconfig of nereus registry: it writes to the cluster directly, until ADR 0018 (the Nereus API, the one door) serves it (#1011) |
The Nereus API |
The kubeconfig of nereus nereid apply and create and of nereus system access: they resolve an image's labels from the registry the person reaches and run a cloud plan with the person's own login, so they stay on the kubeconfig while nereus reef and nereus nereid delete go through the API (#1322) |
The Nereus API |
| Who may create a Build is not enforced: whoever may create one pushes to the Repository of any Workload (#1067) | The containment probes and the ValidatingAdmissionPolicy (#1069), then a rule on the Workload's owner in the authorization reef (#1644 holds the API's check) |
The first identity of a User is linked by the token's verified e-mail, trusting the email_verified claim of the instance's own issuer, also when it brokered another identity provider; the User's id is the object's name (spec 0011, decision 4, ADR 0027) |
An e-mail code that links a new sub, and an id the platform generates (ADR 0006), once a notification reef exists |
A binding's position is a free name on the Member, and nereus-admins is the emergency exit that passes when the check does not (ADR 0027) |
The Position kind with its skills and places (#1307), and a root User with MFA (#1306) |
A build's Pod runs with seccomp and AppArmor Unconfined and hostUsers: true, in a namespace at Pod Security privileged: rootless BuildKit fails with hostUsers: false on today's nodes (spec 0009, #1067) |
A VM with its own small cluster for builds (#1007) |
The kubeconfig of nereus build: it writes to the cluster directly, until ADR 0018 (the Nereus API, the one door) serves it (#1067) |
The Nereus API |
The kubeconfig and a kubectl port-forward of nereus workload logs: it reads inside the Environment with the Environment's own kubeconfig, over a forward the person's kubeconfig opens, until ADR 0018 (the Nereus API, the one door) serves it (#846) |
The Nereus API |
The gaps of nereus catalog check, in the CLI's table (catalog.USES, EDGE_ISSUE, #903) |
The edge reef (#470) and the messaging reef (#576): a gap disappears once the cluster serves the reef |
| Session metrics recorded in the private repository | An always-on environment that receives them (#159) |
| One YAML as a blob, no package, for a deck (spec 0012) | The package: the YAML and what it points to, one revision by digest (#1699 (J2, the deck's package)) |
| A rehearsal records each slide's time, but nothing compares a talk with it yet (#1710 (a rehearsal records each slide's time)) | The pace against the last rehearsal (#1711 (the speaker sees the pace slide by slide)) |
| One API replica serves the follow stream | More replicas, with the stream relayed from leagore (ADR 0028, open questions) |
leagore's memory store, for unit tests and make scene-core only; until #1695 the API's tests stand a fake Nereid in for it |
The PostgreSQL store, a Database of the database reef (#1695 (leagore, the presentations reef's Nereid)) |
| The board skill renders a local HTML page | The board inside the Platform API, through its MCP tools (#137) |
scripts/board/queue and the issue skill |
The board reef: nereus board item next, claim, doctor, list, GitHub first and Jira swappable (#137) |
| Decisions taken on the brainstorming visual companion, written by hand as "(owner, date)" | Decisions as records of the platform, cited by specs and issues (#275) |
| A shell loop polling the visual companion's events file | A decision answered emits decision.answered, and the agent subscribes (#274) |
| Subagents launched by hand in worktrees, results only in the conversation | Agent runs as Instances, linked to their issue and feature, with agent-hours (#276) |
Tokens counted from session transcripts (scripts/metrics/session, #271) |
The AI-usage Nereid of the cost reef (#277) |
Each order's performance, cost and rating in a CSV (scripts/metrics/order, #803) |
Agent runs as Instances (#276) and the AI-usage Nereid of the cost reef (#277) |
The speak command, on the owner's machine only |
Spoken summaries as notifications: a notifications reef and a piper Nereid (#278) |
| Talks dictated and edited in YAML | Talks as a capability of the platform (#218, #219) |
cloud-azure-controller set up by hand |
The catalog's first template, a new Nereid repository (#268), created and protected by the repository reef (#279) |
| Spec 0005's scene run by hand in the Azure sandbox (#266) | The sandbox as an Environment the platform creates and destroys (#280) |
test/secrets-probe, a test Nereid of secrets that reads the Key Vault the scene creates with the person's login (#266) |
The secrets reef and the Key Vault Nereid, adopting the vault (#81) |
nereus nereid apply <name> --reef <reef> with no --image takes <reef>-<name>-controller from the local registry (#307) |
The Nereid registry (#22) |
| The CLI builds the release reef's commands from the contract it pins (#445) | Commands built from any reef's schema (ADR 0010, open questions; #18) |
| The CLI builds the environment reef's commands from the contract it pins (#620) | Commands built from any reef's schema (ADR 0010, open questions; #18) |
The k3d Nereid knows only the cluster it runs in and adopts it as naxos (#575, ADR 0026) |
A Nereid that makes clusters, behind its own Mandate |
An Environment's kubeconfig names https://localhost:8443, reached with kubectl port-forward to its vcluster's service (#620) |
The edge reef publishes each Environment's API server as a Route (#470) |
| The "raft" channel: work orders from the voice session as files on Google Drive (Beach) | The first Nereid, the interlocutor exposed as a remote MCP connector, running on a Nereus instance |
scripts/beach/watch: each machine's agent polls the beach with rclone and starts claude -p on its own orders (Beach) |
An event bus on Nereus: an order is a message of the messaging reef, and the agent subscribes |
Triton applied with kubectl from controllers/triton/deploy (order 20261028-1712); a Nereid of the messaging reef since #1894, NATS the nats Nereid's since #1599 |
Triton as a Nereid of the messaging reef (controllers/triton) |
Triton reads its NATS password from the Secret nats-triton of nereus-system; its account AGENTS is written by the nats Nereid into its own config when the Mandate says agents=true (#1954) |
A binding of the messaging reef that carries its own credential, one per owner |
The named tunnel nereus (renamed from triton, #1931), cloudflared a plain Deployment of nereus-system with its credential in the secrets reef, with its hostnames (triton.getnereus.dev, auth.getnereus.dev for the keycloak Nereid's realm, #495, and portal.getnereus.dev for the portal, its DNS record made once with cloudflared tunnel route dns, #732) set up by hand with cloudflared (the shared token retired by #495: Triton takes Keycloak logins) |
m15 as an Agent of the ai reef, and the edge reef with a cloudflare Nereid publishing each hostname as a Route (#470) (deploy/edge) |
The m15 channel session started in tmux by nereus messaging session create m15 (#1160; scripts/triton/listen-orders and agent-login retired), with Synadia's nats-channel plugin loaded through --dangerously-load-development-channels and NATS reached on the host's loopback with a 10-hour login of the client nereus-nats (order 20261028-1749, #497) |
A channel on the approved list (or the organisation's), with a login renewed without a restart and NATS over TLS |
test/conformance <reef> --nereid <nereid>, a script on the throwaway cluster of make scene-release, checks a Nereid's answers kind by kind (#528) |
nereus nereid conformance <reef> --image <ref>, the suite of layer 3 with a report per digest, gating the Nereid registry (#109) |
scripts/triton/orders-follow: follows Triton's orders live from the terminal, calling Triton's follow_orders in a loop with test/mcp-call (#516) |
A nereus command of the messaging reef that follows its orders (controllers/triton) |
Sessions on one machine coordinate through Claude Code's cross-session messaging, by the protocol and the room skill of the owner's linux repository, with this repository's shared resources in Peers (#621) |
Triton's room: centurions of several users and machines agree on each command through a mediator, with a record (#618) |
The login theme of Keycloak (the honeycomb, a black card, PT | EN) inside the keycloak Nereid's image, copied by an init container of its Release (#598) |
Appearance as a reef: a default theme Nereid, swappable by installing another (#74) |
Cloudflare's rate limiting rule login-rate-limit on auth.getnereus.dev's login form, made by hand in the dashboard (deploy/edge) |
The edge reef with a cloudflare Nereid owning the zone's rules (#470) |
The Gateway API CRDs v1.7.0 (standard channel), from the release's standard-install.yaml, and the Gateway ingress (class istio, one HTTP listener on port 80), applied outside the release reef: by the internal-developer-platform profile's entrance through the CLI's own client (#951), and by hand with kubectl in make scene-ingress on core. The HTTPRoute of triton.getnereus.dev stays applied by hand from deploy/ingress/ (#745, #728); the realm's, deploy/ingress/auth.yaml, is retired: the keycloak Nereid writes it for the host of its Mandate's publicUrl (#1933). The CRDs also come in the kinds step of the profile's init, so the chart nereus renders the API's HTTPRoute (only /.well-known/nereus-configuration, the instance's URL nereus login asks) on a new cluster (#1301) |
The release reef installs manifests from git (#751), and the edge reef owns the routes (#470) |
docker build and docker push on the developer's machine, to the k3d registry, in make scene-golden-path (#826) |
Building a Package from a Workload's source (#578), and the build and registry reefs of #835 |
kubectl get pods for the reason of a failed start, in the golden path (#826; the app's kubectl logs retired by nereus workload logs, #846) |
nereus delivery logs, on the steps of #567 |
The seed images and the charts reach ghcr.io/getnereus/nereus from make promote on the owner's machine, with the owner's token in GHCR_TOKEN (#850) |
Publishing through the platform, nereus release source publish, with the platform's credential (#1229) |
Each new package make promote creates on ghcr.io is made public by a click in its settings, the link make promote prints (#1338, Publishing on ghcr.io) |
A package's visibility set by the publish itself, once GitHub's API exposes it or the repository is public (#9) |
A change to what is published goes out as the next patch from main's HEAD with scripts/registry/release publish (make release) on the owner's machine, which tags that commit v0.1.N and pushes the tag, with no version-bump commit (#1350, #1337); no file in git holds the version, the CLI (nereus --version) and the images read it from the tag (#186) |
Each image named by the hash of its inputs, so a release restarts only the Nereids that changed (#1574) |