Saltar a contenido

Multi-Tenant Documentation Standard

Estado: activo
Scope: global
tenant_id: global
Owner: OpenClaw Platform Governance
Fuente de verdad: docs/governance/standards/MULTI-TENANT-DOCUMENTATION-STANDARD.md

Objetivo

Definir como se documenta cualquier activo nuevo en una plataforma multi-tenant, manteniendo separacion entre contenido global y contenido por tenant.

Regla general

Todo documento nuevo debe declarar:

  • scope
  • tenant_id
  • owner
  • estado
  • fuente de verdad

Decision de ubicacion

  • Si el activo es compartido de plataforma, documentarlo en una ruta global.
  • Si el activo pertenece a una empresa, documentarlo bajo docs/tenants/<tenant_id>/.
  • Si el activo cruza varias capas, enlazar siempre al contrato MULTI-TENANT-FOUNDATION.md.

Como documentar un dashboard

Todo dashboard nuevo debe declarar:

  • tenant_id
  • datasource
  • owner
  • permisos
  • si es global o tenant

Plantilla minima:

text scope: tenant tenant_id: alpuntodeventa owner: Nombre o equipo responsable estado: draft|active|deprecated fuente_de_verdad: ruta del dashboard o JSON fuente datasource: PostgreSQL|Thanos|otro aprobado permisos: quienes lo ven y quienes lo editan

Como documentar una API

Toda API nueva debe declarar:

  • tenant_id
  • scopes
  • OpenAPI
  • permisos

Plantilla minima:

text scope: tenant|global tenant_id: global|ladirecta owner: Nombre o equipo responsable estado: draft|active|deprecated fuente_de_verdad: archivo OpenAPI o repo fuente scopes: lectura, escritura, admin permisos: roles habilitados

Como documentar un workflow

Todo workflow nuevo debe declarar:

  • tenant_id
  • entradas
  • salidas
  • credenciales usadas

Plantilla minima:

text scope: tenant tenant_id: ladirecta owner: Nombre o equipo responsable estado: draft|active|deprecated fuente_de_verdad: ruta del workflow entradas: eventos, formularios o tablas salidas: tablas, APIs, alertas o acciones credenciales_usadas: inventario sin secretos

Reglas complementarias

  • No publicar secretos, tokens, passwords ni claves privadas.
  • No crear activos scope=tenant fuera de la carpeta de su tenant.
  • Toda fuente de datos futura debe declarar si es exclusiva del tenant o compartida con filtro por tenant_id.
  • Todo ejemplo debe usar datos ficticios o placeholders.
  • Si un activo cambia de global a tenant o viceversa, debe actualizarse el documento origen y la navegacion visible del portal.

Checklist rapido

  • scope declarado
  • tenant_id declarado
  • owner declarado
  • estado declarado
  • fuente de verdad declarada
  • permisos declarados si aplica
  • datasource o credenciales declaradas si aplica
  • sin secretos reales