Console
Sign in
Docs for Database administrator
On this page
  1. New here
  2. By role
  3. By task
  4. By service
  5. How to read the pages

Documentation

The documentation of the platform's gateway, Access, Data, console and command line. Find your way in by the job you do, by the task in front of you, or by the service you are working with.

New here#

  1. Platform overview: what the four processes are and how one request crosses them.
  2. Concepts: the shared vocabulary, from tenant to policy bundle.
  3. Quickstart: the whole platform on your machine in a few minutes.
  4. Atlas: the platform drawn on one page.

By role#

You areStart at
A platform operatorsysops
A security engineersecops
A database administratordba
An application developerdeveloper
A repository maintainermaintainer
A console or CLI userend-user

All roles and the pages each one reads: By role.

By task#

You want toGuide
Deploy the platform for the first timeDeploy the platform
Bring a new customer onOnboard a tenant
Grant or revoke accessManage access
Expose your own service through the gatewayPut a service behind the gateway
Build an application on DataBuild an app on Data
Set up monitoring and alertsMonitor the platform
Find out why a request failedTroubleshoot a request
Rotate a secretRotate secrets
Back up or restore the databasesBack up and restore
Ship a new release, or back it outUpgrade and roll back
Handle a suspected compromiseRespond to an incident

All guides: Guides.

By service#

Every service directory uses the same page names, so the same kind of answer is in the same place.

ServiceOverviewSpecificationAPIConfigurationOperationsTroubleshootingInternalsDecisions
GatewayREADMEspecupstream identityconfigurationoperationstroubleshootinginternalsdecisions
AccessREADMEspecapiconfigurationoperationstroubleshootinginternalsdecisions
DataREADMEspecapi, clientconfigurationoperationstroubleshootinginternalsdecisions
ConsoleREADMEspec—configurationoperations—workspace README—
CLIREADMEspec—spec: profilesusageusage: refusalsworkspace README—
PlatformREADME——operationsoperations—internalsdecisions

Service-specific guides: Data getting started, Data modeling, Console user guide, CLI usage, Development, Security.

How to read the pages#

Page kindWhat it isNormative?
SpecificationThe contract of a service's behaviorYes: where another page disagrees, the spec wins
API, configurationExact reference for endpoints, variables and filesDescribes the spec and the code
Operations, troubleshooting, guidesHow to run, repair and use the platformAdvice that links to the rules
Internals, decisionsHow the code is built and why it is that wayFor maintainers

Where each kind of content belongs, and the writing rules for these pages: CONTRIBUTING.md.