Skip to main content

Product Onboarding designed

Use this path when a new product needs platform identity, billing, audit, evidence, artifacts, SDK, status, policy, notification, or portal support.

Onboarding Flow

Checklist

DomainProduct must declare
IAM / Entitlementsscopes, roles, service accounts, product/tenant/project entitlements
Billing / Usageusage units, usage source, rating posture, ledger impact
Audit / Evidenceprivileged mutations, product invariants, release/UAT evidence
Status / Opscomponent ids, SLO posture, DLQ/outbox dependencies
Notificationstemplates, delivery intents, recipients, escalation posture
Policy / Quotaspolicy keys, defaults, overrides, entitlement snapshots
Artifactsartifact type, trust state, promotion channel, SBOM/provenance evidence
SDK / Manifestmanifest package, SDK methods, launch/connect/decommission smoke
Portaluser, developer, ops, security, product, and architecture pages
Extractionkeep/split/extract decision and service-auth/degradation gates

Required Packet Fields

Every product onboarding packet must declare product identity, owners, personas, exposure, package/route/schema/event/frontend ownership, shared-service contracts, portal pages, UAT proof, release evidence, and extraction posture.

The packet fails closed when required shared-service contracts are missing. A field can be skipped only when it is marked not_applicable with owner, reason, and review date.

Shared contractFail-closed gate
Product registryProduct stays in onboarding mode until the registry entry is active.
IAM scopesRoutes and SDK examples cannot ship with unregistered scope strings.
Usage units and resource typesBillable products cannot emit accepted usage without active registry entries and rating posture.
Audit and evidencePrivileged mutations need audit-action entries, invariant mapping, and release/UAT evidence.
Status/OpsProduct health must have component ids or an intentional missing-artifact row.
Policy/quotaQuota-changing writes need snapshot kind, dimension, parent scope, and override scope.
CredentialsProduct-owned secret custody is forbidden without security architecture approval.

Policy And Reconciliation

Policy and quota decisions compose in this order:

global/platform -> plan -> organization -> department -> project -> principal/api key -> request

The onboarding packet must identify GPU, app runtime, token/request, storage, network, and capacity-reservation dimensions that apply to the product. It must also define reconciliation proof for resources that can drift or outlive platform records, including orphan detection, quarantine, cleanup, retry, and operator-visible evidence.

Exit Criteria

The product can leave onboarding mode when the shared-service checklist is complete, Fairway evidence exists for tests and handoffs, and extraction posture is documented as keep, split, or extract.