Skip to content

What Nereus is

Nereus is a composable API platform: reefs add the APIs, Nereids look after them, both installed at runtime, and one API and one CLI serve them all.

Example

nereus --help groups the commands: the platform's own, the model's, and one group per reef the installation knows:

nereus --help
output
Usage: nereus [OPTIONS] COMMAND [ARGS]...

  nereus: a composable API platform: reefs add the APIs, Nereids look after
  them, installed at runtime.

Model:
  mandate         Mandates: each binds one reef to one Nereid.
  nereid          Nereids: the controllers that look after reefs.
  reef            Reefs: the capabilities of the platform, each an API group.
  user            Users: one per person, whatever the login.

Reefs:
  authentication  Reef authentication, looked after by nereid keycloak.
  release         Reef release, looked after by nereid flux.
  secrets         Reef secrets, looked after by nereid openbao.

Picture

IDE, CLI, Portal, AgentsNereus installationAskControl planeNereus APIreefs, one per planeNereidscluster stateEnvironmentsWorkloadsapps from a golden paththeir routesDatabasesMessage streamsreconcileImages and secrets(registry, vault)Outside(Cloudflare, GitHub, the cloud)LaptopVirtualPrivate cloudPublic cloudEdgeUnderlying infrastructure IDE, CLI, Portal, AgentsAskNereus installationControl planeNereus APIreefs, one per planeNereidsreconcileEnvironmentsapps from a golden paththeir routesDatabasesMessage streamsImages and secretsregistry, vaultOutsideCloudflare, GitHub, the cloudUNDERLYING INFRASTRUCTURELaptopVirtualPrivate cloudPublic cloudEdge

One installation: the control plane reconciles the environments, beside the services it uses, on any infrastructure.

How it works

  • The engine is core, the kinds Reef, Nereid, Mandate and Profile, and nothing else; the words are in Reef, Nereid and Mandate.
  • Every capability arrives at runtime as a reef, and a Nereid fills it with the tool you pick (Runtime install and profiles).
  • The CLI, the portal and agents go through one door, the Nereus API, and never name a tool.
  • Swapping a tool means adding another Nereid to the reef and moving its default Mandate: no command, client or app declaration changes.
  • Whose each thing is, and who may act on it, belongs to the platform itself (Tenancy and access).

Not this

  • Not only an Internal Developer Platform: that is one profile, internal-developer-platform; a reef can serve any recurring knowledge work.
  • Not a portal: the portal is one reef, portal, and one client of the API.
  • Not a wrapper around one tool: Flux, Keycloak or OpenBao stay behind a Nereid, and a reef outlives the tool.
  • Not a replacement for Kubernetes: it runs on a cluster, and each reef is an API group there.

Next

Reef, Nereid and Mandate: the three words the rest of the docs use.