Choose the job you do, and the documentation arranges itself around it: where to start, your tasks, your reference and what to do when something breaks.
You deploy the gateway, Access, Data and the console, keep them healthy and roll them forward or back. This page gathers what you need for that: the order to read things in, the tasks you will repeat, the reference you will look values up in, and where to go when something breaks.
Common tasks
You answer for the platform's trust: who may sign in, what a signed-in caller may reach, which secrets exist and who holds them, and what happens when one leaks. This page maps those questions to the pages that answer them and to the playbooks you run.
Common tasks
You own the PostgreSQL that the platform keeps its lasting state in: Access's tables, Data's records with their audit, events and version history, and, when the gateway is configured for it, the gateway's shared state. This page lists what you are responsible for, what to read first and where each database task is documented.
Common tasks
You write code that uses the platform: an application that reads and writes workspace data, a service you put behind the gateway, or a tool that administers tenants. Callers only ever reach the gateway, which asks Access before it forwards anything; this page shows where each part of that conversation is documented and which guide to follow for each job.
What are you building?
You change the platform's own code: the three services, the console, the CLI and the tooling around them. They live in one repository with one lockfile, one CI and one release line. This page is your map of the rules you work under and the pages that record how the code is built, tested and released.
Common tasks
You do the day's work on the platform through its two clients: the web console and the platformctl command line. Both ask the services and show what they answer; neither decides anything on its own, so when one of them refuses, the reason comes from a service. This page points you to the help for each task.
Everyday tasks
Step-by-step guides for jobs that cross several services. All guides
What the platform is, how its processes connect, and where to read next. Start here if you are new to the repository, whatever your role.
The gateway is the platform's application gateway: for every request it identifies the caller, asks Access what the caller may do, and forwards the request to the route's upstream with a signed identity. This page is the overview for everyone; it links to the page for each task.
Access is the platform's OpenID Connect broker and access decision service: it authenticates callers against each tenant's identity provider, maps them to principals, and answers the gateway's existing decision contract. Start here to learn what it does and where to find each task.
Data is the platform's headless data backend: a permission-aware API for workspace records behind the gateway, which takes each caller's capabilities from Access. This page is the overview for everyone; it says what Data does and where to read next.
The console is the platform's web interface: people read and change workspace data, operators administer tenants, and anyone can check service status or read these docs. This page explains what it is for and where to go next.
platformctl is the platform's command line: operators and developers use it to check a deployment, publish route tables, administer Access and work with workspace records. This page explains what it is and where to read next.