Skip to content
DiaGO

Deployment Diagrams

Nodes, devices, execution environments, artifacts and communication paths - where the software actually runs and how the machines talk.

A deployment diagram shows the physical side of a system: the machines and platforms it runs on, which built files are installed where, and how those machines connect. A component diagram says what the parts are; a deployment diagram says where each one lives at run time.

The notation

ElementDrawn asMeans
NodeA 3-D boxA computational resource that software is deployed on
DeviceA node with «device»Physical hardware: a server, a phone, an IoT board
Execution environmentA node with «executionEnvironment», or a specific keyword such as «JVM»A software platform that hosts artifacts: an OS, a JVM, a container runtime, a browser
ArtifactA box with «artifact» (or a dog-eared document icon), inside its nodeA built, deployable file: a .jar, an executable, a script, a config file
Communication pathA solid line between nodes, labelled with the protocolThe two nodes exchange messages over this link

Nodes nest. A realistic drawing puts an execution environment inside a device — a «JVM» inside an «device» App server — and the artifacts inside the environment that runs them.

Reading one

[«device» Phone]
   └─ «executionEnvironment» Browser
        └─ «artifact» web-app.js
            |  HTTPS
[«device» App server]
   └─ «executionEnvironment» JVM
        └─ «artifact» library-api.jar
            |  JDBC
[«device» DB server]
   └─ «artifact» schema.sql

Read it top to bottom: the browser on a phone runs the web app, which talks HTTPS to an API running in a JVM, which talks JDBC to the database server. Every arrow of a request crosses one of those communication paths, so each label is also a list of the protocols you must secure, monitor and keep fast.

Reach for it

  • Planning or documenting where each part of a system runs
  • Discussing scaling, failover and network security between tiers
  • Showing a split into services and the protocols between them

Avoid it

  • Logical structure - that is a component or class diagram
  • Every server in a large fleet - show one representative node per role
  • Implementation details that change weekly, such as instance counts

Common mistakes

Device or environment confused. A Docker host or a JVM is an execution environment; the machine underneath is a device. Mixing them hides what you would replace in an upgrade.

Paths without protocols. An unlabelled line says "these talk somehow". The protocol is usually the most useful word on the diagram.

One node per class. A deployment diagram with dozens of nodes is often a component diagram in disguise — or a sign the system is split finer than it needs to be (see microservices trade-offs).

Practice

Draw the deployment of a small library system: a member's phone, a librarian's desktop, one application server and a database server. Choose the execution environments, place the artifacts, and label every communication path with its protocol.