Skip to main content

Product status and safety

Service Admin pages use the same status language in Help Center docs so operators can tell whether a surface is backed by a live runtime contract, static metadata, a preview contract, development-only scaffolding, or a planned backend.

Do not describe a page as live, durable, runtime-backed, or production-ready unless the implementation and tests prove that contract. When a page is useful but not fully backed by a service API, describe what is safe to inspect and which backend contract is still required.

Status categories​

StatusMeaningDocumentation rule
Runtime-backedThe page reads or writes through a live Service Lasso runtime or service API contract.Name the API boundary and describe the durable evidence operators can trust.
Metadata-onlyThe page shows refs, states, ids, timestamps, health, audit, or policy metadata without raw secret, credential, or payload material.State that the page is for inspection or review and does not mutate backend state.
Preview/static contractThe page models a planned or versioned contract with fixtures, static examples, or dry-run output.Mark examples as preview evidence and avoid claiming live backend durability.
Stub/dev-onlyThe page or behavior is available only for local development, tests, or placeholder flows.Call out the dev-only source and block operator actions that would imply a real backend.
Planned/backend contract requiredThe page has a product direction but still needs a backend route, storage contract, worker, or service integration.Name the missing contract and link future docs to the owning issue when one exists.

Current Service Admin page status​

SurfaceCurrent statusOperator note
DashboardRuntime-backedReads runtime dashboard metadata through the Service Admin runtime proxy. Treat service state, health, Broker ready, lockout counts, and lifecycle metadata as the operator-visible runtime summary. Never show secret values or auto-onboard because home loaded.
ServicesRuntime-backedLists Service Lasso service metadata and lifecycle state from the runtime. Service actions must keep returning operation ids, safe status, and recovery guidance.
RuntimeRuntime-backedShows runtime health and readiness signals. Health rows are operational status evidence, not raw process logs or secret-bearing diagnostics.
LogsRuntime-backedReads runtime log metadata and safe log lines through the runtime boundary. Docs must continue to describe redaction and retention limits.
VariablesMetadata-onlyShows environment and secret-ref posture without raw values. It is not a secrets viewer or credential editor.
DependenciesMetadata-onlyShows service dependency and secret-ref relationships derived from safe metadata. It does not prove credential validity by itself.
InstalledMetadata-onlyShows install paths, manifests, and local availability metadata. It does not install or mutate services unless a separate action explicitly provides that contract.
Network and Service RoutesMetadata-onlyShows route and network posture from configured service metadata. It should not imply public reachability unless a runtime check proves it.
Operations / TelemetryMetadata-onlyShows Service Lasso runtime and Secrets Broker telemetry status through runtime APIs. It does not configure exporters, send telemetry, or reveal OTLP endpoints, headers, tokens, cookies, raw request bodies, raw response bodies, or environment values.
Operations / Audit LoggingMetadata-only with runtime-backed events where exposedShows durable action and broker audit metadata when the runtime exposes it, and fallback status when unavailable. It must not claim immutable audit durability unless the backend audit sink and tests prove it.
Secrets Broker SecretsPreview/static contract with guarded runtime reads where exposed/secrets-broker redirects here. Secret rows, previews, receipts, and operation trails are metadata-only. Reveal, rotate, reset, policy, and migration actions require broker operation ids, audit reasons, confirmation, and terminal status evidence before docs can call them applied. Home shows Broker ready and lockout counts.
Secrets Broker SourcesMetadata-only setup guidanceShows provider setup and source posture. Authentication status may be shown, but provider tokens and credential material must never appear.
Secrets Broker TopologyMetadata-onlyShows service-to-secret-ref relationships and validation state. It does not prove secret value availability.
Support Bundle and DiagnosticsExcluded from Release 1 GANo route, navigation item, preview, or export ships in the GA surface. A future release requires a redacted backend export API and released-artifact evidence that bundles omit secrets.
SettingsStub/dev-only or local preference backed, depending on pageAppearance and display settings are local UI preferences. Account, profile, and notification pages must not claim external identity or notification durability without a live backend contract.

Writing future Help Center docs​

  • Start each operator article with a status statement using one of the categories above.
  • Say exactly which API, fixture, local preference, or static contract the surface uses.
  • Include the safe evidence an operator can trust, such as service id, operation id, audit id, correlation id, health state, version, provider ref, or timestamp.
  • Include a negative claim when needed: no raw secrets, provider credentials, tokens, cookies, private keys, request bodies, response bodies, recovery material, or environment values.
  • If a backend contract is missing, say what is missing instead of presenting the workflow as live.

Component guides · Imported from lasso-serviceadmin. The migration inventory records ownership and remaining work.