Platform
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.
Docs for Database administrator
Documentation · reading as
Database administrator
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.
What you own
Start here
Common tasks
- Create the roles and databases of a first deployment
- Run migrations and detect driftData: migrations and driftAccess spec §3.8
- Back up, restore and rehearse
- Apply retention and remove a workspace's dataData: retentionData: remove a workspace
- Clean up failed event deliveries
- Size pools and timeoutsData configuration: budgetsAccess operations: tuningGateway configuration: shared state
- Upgrade with new migrations, or roll back
- Rotate database passwords
Reference
- What does each Access table hold, and which indexes serve decisions?Access spec §3§8.5
- Which fields does Data maintain itself, and how does a collection change?
- How does Data scope every statement to one workspace?
- What does Data keep, and for how long?
- Why does Data's SQL look the way it does?
- How do the two gateway backends compare?
When the database is the problem
Task guides
Step-by-step guides for jobs that cross several services. All guides
All documentation, by area
Gateway
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
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
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.
Console
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.
Command line
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.