Guides
Step-by-step guides for jobs that cross more than one service, written in the order you do the work. Each one says who usually runs it, what must be true before you start, the steps with their commands, how to check the result and where to go when a step fails; the rules behind each step stay in the services' own pages.
Set up#
| Guide | Outcome |
|---|---|
| Deploy the platform | A first production deployment of all four processes, verified end to end |
| Onboard a tenant | A new customer signed in through its own identity provider, with a first grant |
| Monitor the platform | Probes, metrics, alerts and request tracing in place |
Build#
| Guide | Outcome |
|---|---|
| Put a service behind the gateway | Your service reachable through a route, verifying the signed identity |
| Build an app on Data | Collections, policies and a workspace, called from code |
Run#
| Guide | Outcome |
|---|---|
| Manage access | Grants, groups and roles changed, with an audit trail |
| Troubleshoot a request | The service and the cause behind a failing request |
| Rotate secrets | Every secret replaced without dropping traffic |
| Back up and restore | Backups of Access and Data, and a rehearsed restore |
| Upgrade and roll back | A new release rolled out, or the last one restored |
| Respond to an incident | An account or tenant cut off, secrets replaced, the facts gathered |
For jobs inside one service, use that service's pages: for example Data modeling, Upstream identity, the console user guide or CLI usage.