Files
tenant-registry/README.md
T
sharang 6a6cd76426
ci / shared (pull_request) Successful in 4s
ci / test (pull_request) Has been skipped
ci / image (pull_request) Has been skipped
feat(server): tenant-registry skeleton boots against dev stack
Minimal Go service so platform/portal has something to resolve in local
dev. Stdlib net/http with Go 1.22 enhanced ServeMux (method+path
patterns); no third-party deps yet.

Layout:
  cmd/server/main.go               entry point with graceful shutdown
  internal/config/                 env-driven config (APP_ENV, ADDR, KC issuer)
  internal/server/                 http handlers + request-logging middleware
  internal/store/memory.go         in-memory tenant store, seeded with acme
  migrations/0001_init.up.sql      schema for the M4.1 follow-up (unapplied)
  Makefile                         dev/test/build/lint/docker targets
  Dockerfile                       multi-stage distroless build

Endpoints (under :8080 in dev):
  GET /healthz
  GET /v1/tenants/by-slug/{slug}   200 acme | 404
  GET /v1/tenants/{id}             200 by uuid | 404

JWT validation and the real Postgres-backed store land in the M4.1
follow-up PR — keeping this PR strictly to 'boots, replies, tests pass'.

Refs: M4.1 (skeleton)
2026-05-18 22:40:49 +02:00

4.1 KiB

tenant-registry

Multi-tenant glue: orgs, entitlements, API keys, audit.

Part of the Breakpilot Platform. For the big picture see platform/docs: Architecture · Infrastructure · Product Integration Spec · Implementation Plan

What this is

Multi-tenant glue: orgs, entitlements, API keys, audit. Scaffolded under milestone M4.1. See platform/docs for the full architecture context.

Plane: Control Owner: @sharang Status: pre-alpha Linked milestone: M4.1

Run locally

# Prerequisites: Go 1.25+
# Dependencies (Keycloak, pg-app) come from the dev stack — see platform/orca-platform/dev.

# In one terminal — bring up dev dependencies (in the orca-platform clone):
cd /path/to/platform/orca-platform && make dev-up

# In another — run the service:
make dev          # APP_ENV=dev, listens on :8080
make test         # unit tests
make build        # compile to ./bin/tenant-registry

Env vars (override at the shell):

Var Default Purpose
APP_ENV dev one of dev, stage, prod
ADDR :8080 listen address
KEYCLOAK_ISSUER http://localhost:8080/realms/breakpilot-dev OIDC issuer URL
DATABASE_URL empty (in-memory store in skeleton) Postgres DSN, wired up in the M4.1 schema PR

Endpoints

Method Path Returns
GET /healthz {"status":"ok"} — liveness probe
GET /v1/tenants/by-slug/{slug} 200 with tenant JSON, 404 if missing
GET /v1/tenants/{id} 200 with tenant JSON, 404 if missing

The skeleton's store is in-memory and pre-seeded with one tenant:

{
  "id": "00000000-0000-0000-0000-000000000001",
  "slug": "acme",
  "name": "Acme Inc.",
  "status": "active",
  "plan": "professional",
  "products": ["certifai", "compliance"]
}

So curl http://localhost:8080/v1/tenants/by-slug/acme works the moment make dev is up.

The full schema (tenants, tenant_products, audit_log) is committed at migrations/0001_init.up.sql for review, but unapplied until the M4.1 follow-up PR swaps the in-memory store for pgx-backed Postgres.

Deployment

Env URL How
dev http://localhost:8080 make dev
stage https://tenant-registry.stage.breakpilot.com auto on merge to main
prod https://tenant-registry.breakpilot.com manual: tag vX.Y.Z + sign-off

Rollback: orca rollout undo tenant-registry --env={{env}}.

Observability

  • Traces, logs, metrics: SigNoz — service name tenant-registry
  • Audit events: Tenant Registry /audit (Retraced-shape schema)
  • On-call: oncall@breakpilot.com · runbook at platform/docs/runbooks/tenant-registry.md

Contributing

See CONTRIBUTING.md. TL;DR: branch from main, open a PR, 1 review + green CI, squash-merge.

License

Proprietary — all rights reserved. Copyright (c) 2026 Sharang Parnerkar and Benjamin Boenisch. See LICENSE.