Skip to main content

Administration

Administration is split between two roles. A superuser (qodstate_user.tenant IS NULL) owns the entire control plane: creating tenants, assigning tenant admins, and operating the infrastructure. A tenant admin governs a single tenant: its databases, pools, and who can query them. Both roles work through the same RBAC model; the difference is scope. See Authentication for how sessions and API keys are issued to each role.

All administrative tasks are available through the React console at http://<host>:20900/ui/. The Admin UI guide covers every screen in detail; this page does not repeat that tour.

Task map

Use the table below to jump straight to the playbook for what you need to do.

Onboarding

TaskPlaybook
Sign in to the consoleSign in
Create a tenantCreate a tenant
Add a database to a tenantAdd a database
Create and size a poolCreate and size a pool
Confirm nodes are liveConfirm nodes are live
Hand off a connection string to usersHand off a connection string

Access control

TaskPlaybook
Give a team read access to a poolGrant a team read access
Extend a grant to DML or DDLGrant DML or DDL
Remove a grantRevoke access
Confirm a principal can or cannot query a tableVerify access

Day-2 operations

TaskPlaybook
Monitor node healthWatch the Nodes board
Scale a pool up or downScale a pool
Drain or force-stop a nodeDrain vs force-stop
Audit recent queriesRead statement history
Diagnose common failuresCommon failure modes

Lifecycle and config

TaskPlaybook
Attach an external data sourceAttach an external catalog
Rotate a federated secretRotate a federated secret
Back up and restore the control planeBack up and restore
Decommission a tenant or poolDecommission

Configuration as code

TaskPlaybook
Manage the whole config as YAMLManage by manifest