system
The `system` group answers questions about the deployment itself. `whoami` and `version` are public and answer without a credential, which makes them a quick connectivity and credential check; `selfCheck` is a fleet administrator's health report. See [Observability](/docs/operations/observability).
The system group answers questions about the deployment itself. whoami and version are public and answer without a credential, which makes them a quick connectivity and credential check; selfCheck is a fleet administrator's health report. See Observability.
All 3 methods are served by this release.
| Method | Kind | Authorization | Phase | Status |
|---|---|---|---|---|
whoami | public | public | v0.1 | registered |
version | public | public | v0.1 | registered |
selfCheck | read | compute:fleet:admin @ compute-fleet | v0.1 | registered |
whoami
POST /api/compute/system/whoami
Reports who is calling: authenticated: false without a credential, or the authenticated identity.
Public; no IAM decision. When the call carries a credential, IAM authenticates it once and the answer holds the identity id and kind, the tenant, the session kind, whether the session used MFA, and the agent and delegation ids when present. The session id is never returned.
- Kind: public
- Authorization: public
- Module:
server - Phase: v0.1 (registered)
Input
Takes an empty object: {}.
version
POST /api/compute/system/version
Returns the server's name, release version, API base path and the agent protocol versions it speaks.
Public; no IAM decision and no input. The JoinService public keys appear only in the .well-known/better-compute document, not in this answer.
- Kind: public
- Authorization: public
- Module:
server - Phase: v0.1 (registered)
Input
Takes an empty object: {}.
selfCheck
POST /api/compute/system/selfCheck
Runs the deployment's read-only health checks and returns the findings, with ok false when any finding is an error.
Decided as compute:fleet:admin on compute-fleet/global, which resolves only in the root tenant. The report covers the method catalog, applied migrations, the btree_gist extension, compute_now() against the database clock, the operations checks (overdue work, command sweeper lag, usage dead letters and backlog, gateway headroom, stale heartbeats, daemon protocol skew, expiring node certificates) and every module's own selfCheck. A failing check becomes an error finding rather than a failed call.
- Kind: read
- Authorization:
compute:fleet:admin@compute-fleet - Module:
server - Phase: v0.1 (registered)
Input
Takes an empty object: {}.
Better Compute is created by Sean Filimon
Last updated
sites
Sites are boot and failure domains: every pool and node belongs to one site. Platform sites (`shared`, `dedicated`) belong to the root tenant; a tenant's own hardware lives on its `custom` sites. A tenant sees the sites the authorization projection holds for it. See [Sites](/docs/guides/bare-metal/sites).
tunnels
Interactive access to an instance or a node through its gateway and daemon: exec, SSH, TCP or the serial console of an instance, or the console of a node. The server's tunnels module hosts this group when the deployment configures `tunnels` with an exec ticket issuer. See [Tunnels](/docs/guides/access/tunnels).