Architecture Diagrams

What are Architecture Diagrams?

Architecture diagrams help you visualize relationships between services and resources in your data infrastructure. They're particularly useful for documenting cloud deployments, data pipelines, and system integrations. You can group related services together and show how different components connect and interact.

Creating Your First Architecture Diagram

1. From the Code IDE, Click Apps and Agents from the lefthand panel

2. Select Mermaid. Paradime will automatically start a new mermaid project

3. In the terminal that appears, use the arrow keys to select "Architecture Diagrams"

4. A new architecture.mmd file will be created in your editor with this starter template:

architecture-beta
    group api(cloud)[API]

    service db(database)[Database] in api
    service disk1(disk)[Storage] in api
    service disk2(disk)[Storage] in api
    service server(server)[Server] in api

    db:L -- R:server
    disk1:T -- B:server
    disk2:T -- B:db

1. Click the eye icon (👁️) in the top right corner of your Mermaid file to preview the diagram

[screenshot]

1. Edit and update your .mmd file as needed - the preview will update automatically

Diagram Syntax Guide

Basic Components

1. Groups: Container for related services

group data_warehouse(cloud)[Data Warehouse]

1. Services: Individual components

service analytics_db(database)[Analytics DB]

1. Edges: Connections between services

db:R -- L:server  # Right of db to Left of server

Building Blocks

Groups

Create a group with:

group {group_id}({icon})[{label}]

Add services to a group using in:

service my_service(database)[My Service] in my_group

Services

Define services with:

service {service_id}({icon})[{label}]

Available icons:

• cloud

• database

• disk

• internet

• server

Connections

Connect services using edges:

• Direction options: T(top), B(bottom), L(left), R(right)

• Arrow types: -->, --, <--

Data Team Examples

Data Warehouse Architecture

architecture-beta
    group warehouse(cloud)[Data Warehouse]
    service raw(database)[Raw Data] in warehouse
    service processed(database)[Processed Data] in warehouse
    
    group analytics(cloud)[Analytics]
    service bi(server)[BI Tool] in analytics
    
    raw:R --> L:processed
    processed:R --> L:bi

ETL Pipeline

architecture-beta
    service source(database)[Source DB]
    group transform(cloud)[Transform]
    service etl(server)[ETL Service] in transform
    service target(database)[Target DB]
    
    source:R --> L:etl
    etl:R --> L:target

Best Practices

1. Group related services logically

2. Use clear, descriptive labels

3. Keep connections simple and readable

4. Use consistent naming conventions

5. Add appropriate icons for services

Additional Resources

For more syntax options and advanced features, visit the official Mermaid documentation