Diagrammi di architettura in Confluence

Un diagramma di architettura mostra i servizi e le risorse di un sistema e i collegamenti tra loro.

Ultimo aggiornamento

Quando usarlo

Usa un diagramma di architettura per la vista d’insieme di un sistema cloud: l’app web, l’API, il database, la coda, raggruppati per dove girano. I servizi hanno icone e stanno dentro gruppi; i collegamenti uniscono un lato di un servizio a un lato di un altro.

Esempio

Questo è il codice del modello Web application: app web, API, database e archivio di file in un solo cloud.

architecture-beta
  group cloud(cloud)[Cloud]
  service web(internet)[Web app] in cloud
  service api(server)[API] in cloud
  service db(database)[Database] in cloud
  service files(disk)[File storage] in cloud
  web:R -- L:api
  api:R -- L:db
  api:B -- T:files

Vellnar Diagrams lo disegna così:

Cambia una riga e il diagramma cambia con lei. A nessuno serve il file originale del disegno, perché non esiste: il codice è il diagramma.

Aggiungerlo a una pagina di Confluence

  1. Modifica una pagina di Confluence e scrivi /mermaid dove vuoi il diagramma.
  2. Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
  3. Scegli un modello, oppure Start blank e incolla il codice qui sopra. L’anteprima segue ogni tasto.
  4. Scegli Save. Il diagramma compare nella pagina.

La documentazione spiega l’editor, le impostazioni e le esportazioni.

Modelli

Il pulsante Templates dell’editor ha 6 modelli pronti per questo tipo:

  • Web application: App web, API, database e archivio di file in un solo cloud.
  • Microservices: Un gateway davanti a due servizi, ciascuno con il proprio database.
  • Data pipeline: Sorgenti, collettore, data lake, warehouse e dashboard.
  • Serverless: CDN, funzioni, coda, tabelle e archivio di oggetti.
  • Multi-tenant SaaS: Tenant in comune su risorse condivise e un livello dedicato per i clienti grandi.
  • Observability pipeline: Metriche, log e tracce dai carichi di lavoro attraverso un solo collettore.

Sintassi

Il codice inizia con architecture-beta. La documentazione di Mermaid (in inglese) descrive ogni elemento della sintassi. Vellnar Diagrams lo disegna con Mermaid 12.3; se una riga ha un errore, l’editor segna la riga e tiene a schermo l’ultimo diagramma valido.

Altro

  • Mermaid in Confluence: come funzionano i diagrammi scritti come codice in una pagina, e tutti i tipi di diagramma.
  • Sicurezza: l’app non chiede nessun permesso e non manda nulla fuori da Atlassian.