Deployment View Block
Embed deployment view diagrams showing infrastructure topology, server placement, and deployment targets. Useful for cloud architecture and infrastructure documentation.
Deployment view blocks embed infrastructure topology diagrams directly into your documentation pages. These diagrams show how systems are deployed across servers, containers, cloud regions, and availability zones, giving readers a clear picture of the runtime environment and its physical or virtual structure.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Diagram Path | Yes | Path to the .diagram.json file containing the deployment view |
| Title | No | Optional title displayed above the diagram |
Deployment View Features
| Feature | Description |
|---|---|
| Cloud Icons | AWS, Azure, GCP, and Kubernetes icons for accurate infrastructure representation |
| Nested Groups | Group elements within regions, zones, or clusters to show containment hierarchy |
| Connection Labels | Annotate connections with protocols, ports, or traffic descriptions |
| Interactive Navigation | Zoom, pan, and select individual nodes to explore large deployments |
| Theme Matching | Automatically adapts colours and styling to match your site theme |
Deployment View vs Standard Diagram
| Aspect | Deployment View | Standard Diagram |
|---|---|---|
| Focus | Runtime infrastructure and placement | Logical architecture and relationships |
| Grouping | Regions, zones, clusters | Swimlanes, components, boundaries |
| Icons | Infrastructure-specific (servers, databases, load balancers) | General-purpose shapes and cloud icons |
| Best For | Operations and infrastructure teams | Development and architecture teams |