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#
- Platform overview: what the four processes are and how one request crosses them.
- Concepts: the shared vocabulary, from tenant to policy bundle.
- Quickstart: the whole platform on your machine in a few minutes.
- Atlas: the platform drawn on one page.
By role#
| You are | Start at |
|---|---|
| A platform operator | sysops |
| A security engineer | secops |
| A database administrator | dba |
| An application developer | developer |
| A repository maintainer | maintainer |
| A console or CLI user | end-user |
All roles and the pages each one reads: By role.
By task#
| You want to | Guide |
|---|---|
| Deploy the platform for the first time | Deploy the platform |
| Bring a new customer on | Onboard a tenant |
| Grant or revoke access | Manage access |
| Expose your own service through the gateway | Put a service behind the gateway |
| Build an application on Data | Build an app on Data |
| Set up monitoring and alerts | Monitor the platform |
| Find out why a request failed | Troubleshoot a request |
| Rotate a secret | Rotate secrets |
| Back up or restore the databases | Back up and restore |
| Ship a new release, or back it out | Upgrade and roll back |
| Handle a suspected compromise | Respond 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.
| Service | Overview | Specification | API | Configuration | Operations | Troubleshooting | Internals | Decisions |
|---|---|---|---|---|---|---|---|---|
| Gateway | README | spec | upstream identity | configuration | operations | troubleshooting | internals | decisions |
| Access | README | spec | api | configuration | operations | troubleshooting | internals | decisions |
| Data | README | spec | api, client | configuration | operations | troubleshooting | internals | decisions |
| Console | README | spec | — | configuration | operations | — | workspace README | — |
| CLI | README | spec | — | spec: profiles | usage | usage: refusals | workspace README | — |
| Platform | README | — | — | operations | operations | — | internals | decisions |
Service-specific guides: Data getting started, Data modeling, Console user guide, CLI usage, Development, Security.
How to read the pages#
| Page kind | What it is | Normative? |
|---|---|---|
| Specification | The contract of a service's behavior | Yes: where another page disagrees, the spec wins |
| API, configuration | Exact reference for endpoints, variables and files | Describes the spec and the code |
| Operations, troubleshooting, guides | How to run, repair and use the platform | Advice that links to the rules |
| Internals, decisions | How the code is built and why it is that way | For maintainers |
Where each kind of content belongs, and the writing rules for these pages: CONTRIBUTING.md.