Settings & the General Tab
Settings is the platform's administrative console. The whole surface defaults to Admin/Owner only (with narrow read carve-outs), so most tabs are gated by role. This page orients you to the tab set and covers the General tab in detail.
The tab set
Settings is a set of tabs, each an entry point to one management area. Most map to a dedicated doc:
| Tab | What it does | Docs |
|---|---|---|
| General | Platform version hero, live storage usage, theme. | This page ↓ |
| Users | Create/manage users, roles, and base projects. | Authentication & Access |
| Groups | Group membership for resource permissions. | Authentication & Access |
| Projects | The tenancy boundary — create/manage projects and members (Owner-only). | Authentication & Access |
| Tokens | API/client tokens and the per-project discovery token. | Authentication & Access |
| AI | The per-project OpenRouter key for AI features. | AI Analysis |
| Clouds | OpenStack cloud registration. | Cloud & OpenStack |
| LDAP | Directory (LDAP/AD) login configuration, per project. | Authentication & Access |
| GSLB | GSLB zone defaults and the DNS zone secret. | GSLB Nodes & CoreDNS |
| API-Discovery | Runtime config for the discovery collector. | API Discovery |
| Audit-Forwarding | Forward the audit trail to a SIEM over syslog. | Audit & Syslog Forwarding |
| License | License activation and status. | Licensing |
| Maintenance | Backup/restore and maintenance tooling. | Backup & Restore |
Two-factor auth (TOTP) is managed per user under Profile, not Settings. Project-enforced 2FA is toggled from Settings, but enrollment is personal. See Authentication & Access.
The General tab
General is the platform's at-a-glance status page — version identity, live storage, and appearance.
Version hero
A banner surfaces the three versions that define what this deployment can manage:
- UI Version — the frontend build.
- API Version — the Controller/backend version (from the license status).
- Envoy Builds — the count of supported Envoy versions this control plane can manage.
A Supported Envoy Versions card below lists each build as a tag. This is the set the control plane can compile and validate config against — see Supported Envoy Versions for the versioning model.
Storage usage
A live Storage card (Owner/Admin-gated, same as the backing endpoint) shows real ClickHouse + MongoDB usage and a retention-window projection, polled every 30 seconds. It is backed by GET /api/v3/setting/storage-stats, which measures usage live from each store's system tables.
ClickHouse (the request-volume-bound store):
- Used now — on-disk bytes, split into Discovery (
api_events) and Security (Shield audit). - Written last 1h and the 24h average/day rate.
- Projected Nd — the steady-state size the TTL'd tables converge to at the current rate (default 7-day window, matching the collector's
RETENTION_DAYSand Shield's audit TTL). - Free disk, a used/total bar with a reserve marker, and a fit verdict — whether the projected steady state fits in free disk, with the headroom (or shortfall).
MongoDB (the cardinality-bound store — it grows with distinct endpoints, not traffic):
- Storage (data + index bytes).
- Inventory endpoints — the
api_inventorydocument count, plus new in the last 1h / 24h as the meaningful growth signal.
If ClickHouse isn't configured the card degrades gracefully — MongoDB stats still render and ClickHouse is marked unavailable.
ClickHouse grows with req/s but is TTL-capped, so it converges to a steady-state size. MongoDB grows with distinct endpoints and has no TTL (it is cardinality-capped instead). The General tab shows both so you can size disk against the right signal for each. Full schema detail: Collector Reference.
Appearance
A Light / Dark / System theme toggle, applied immediately and remembered per browser.
See also
- Authentication & Access — the roles, projects, tokens, LDAP, and 2FA behind most tabs.
- Security Model — where each secret configured here is stored and trusted.
- Supported Envoy Versions — the build set shown in the version hero.