Tenant Onboarding Runbook
How to take a new brand live from configuration — the operational proof of the white-label promise. No code changes required.
Prerequisites
- Brand assets: logo (SVG), favicon, hero images, color tokens, fonts.
- Legal/finance: legal entity, GSTIN, invoice details.
- Domains: primary domain + DNS access.
- Integration creds: payment (Hyperswitch + gateway keys), courier (Shiprocket), SMS/WhatsApp/email, (optional) marketplace, (optional) Zapier/Pabbly secrets.
- Locales: default + supported.
Steps
1. Provision infrastructure
- Create namespace
tenant-<id>; provision Postgres, Mongo, Redis, object-storage bucket. - Create k8s Secret
<id>-secretswith all secret env (see Multi-Tenancy).
2. Upload branding assets
- Push logo/favicon/hero to the tenant bucket.
3. Create the values file
# values-<id>.yaml
tenantId: <id>
domain: <brand-domain>
image: { tag: "<release>" }
locales: [<default>, ...]
featureFlags: { amc: <bool>, loyalty: <bool>, affiliate: <bool>,
amazonChannel: <bool>, flipkartChannel: <bool>,
crossVendorService: <bool>, subsidyWorkflow: <bool> }
secretsRef: <id>-secrets
bucket: <id>-assets
4. Seed the Tenant Config document
- Insert
TenantConfig(branding tokens, contact, service SLA, behavior) into Mongo. Editable later in admin.
5. Deploy
helm upgrade --install <id> ./chart -f values-<id>.yaml(or GitOps commit).- Run migrations (Medusa CLI + Mongo scripts) as one-off jobs.
6. Configure DNS + TLS
- Point domain to ingress; issue TLS cert.
7. Load commerce data
- Import catalog (products/variants/kits, technical specs, docs), price lists per tier, sales channels.
8. Configure integrations
- Payments: set routing + verify a sandbox transaction.
- Courier: set pickup locations; verify a test shipment.
- Notifications: providers + templates (localized).
- (Optional) marketplaces, Zapier/Pabbly subscriptions.
9. Set up users & roles
- Create admins (marketing/finance/service-head), managers (with scope), dealers, service partners, technicians.
10. Smoke test (go-live checklist)
- Storefront branded (logo/colors) on the brand domain.
- Locale switch works; localized content renders.
- Place a test order → payment captured → invoice (GST) generated.
- Shipment created + tracking.
- Warranty registration + "My Products".
- Raise a complaint → assign → technician app job.
- (if enabled) AMC purchase + reminder scheduling.
- Dashboards show scoped data.
- Lighthouse budget met on storefront.
Rollback
- Helm rollback to previous release; data migrations are forward-safe/reversible where possible.
What must NOT require code
If onboarding ever needs a code change, that variation belongs in the Tenant Config Contract — add a flag/field and document it (Multi-Tenancy).