Skip to content

Conformance: the UML deployment diagram ​

Release 0.22.0 (stage 5, docs/diagrams/notes/stage-5.md). Support is claimed by level (decision D3): render and edit on the subset below. No interchange: Mermaid has no deployment notation, and there is no XMI and no UML diagram interchange (docs/diagrams/proposal.md §8.1).

A view of a version-2 model ("schemaVersion": 2) whose diagram is "uml.deployment" is a deployment diagram. It is drawn by lib/umlimator-all.js (umlimator/all), which the CLI's page inlines; lib/umlimator.js, what a map host loads, draws it as plain cards with a warning. The vocabulary is docs/diagrams/model.md §2, row 6; the example is examples/bookshop-deployment.json.

The subset, and UML 2.5.1's clauses ​

UML 2.5.1In the modelDrawn as
19.5 Nodeuml.Node; props.stereotypes; parent a node, device or execution environment (UML's nestedNode)UML's cube: a front face with a top and a right face 10 px deep; holding something shown, a box drawn as a cube, its faces inside its frame
19.5 Deviceuml.Devicethe cube with «device» on a line above its name
19.5 ExecutionEnvironmentuml.ExecutionEnvironmentthe cube with «executionEnvironment» on a line above its name
19.3 Artifactuml.Artifact; parent the target it is deployed ona rectangle with «artifact» over its name and UML's document icon
19.5 DeploymentSpecificationuml.DeploymentSpecification (an artifact, for manifest-ends)the artifact's look with «deployment spec»
19.5 Deploymentby nesting (parent), or uml.Deployment from the artifact to its targetthe artifact inside the target's box; or dashed, an open arrowhead, «deploy»
19.3 Manifestationuml.Manifestation, from an artifact to a componentdashed, an open arrowhead, «manifest»
19.5 CommunicationPathuml.CommunicationPath between two targets, its labela plain solid line with its label, cut at 280 px
11.6 Componentuml.Component, what an artifact manifeststhe component look
7.7 Dependency, 7.8 Commentuml.Dependency, uml.Comment, uml.CommentLinkdashed with an open arrowhead; a note, a dashed line

A box with a keyword or stereotypes draws them on a line above its name, as UML 2.5.1 draws a keyword (the maintainer's decision of 13 Nov 2026), so a long name is not cut by its keyword.

Rules (notes/stage-5.md §10.3): deploy-ends, path-ends (two targets, neither holding the other), manifest-ends (from an artifact; to anything but a component, a warning) (errors); nest-kinds (an error when a target's owner is not a target; a warning for the unusual pairs: a node in an execution environment, say), deployed-twice (an artifact nested in one target and deployed by a line to another), line-inside (a dependency, manifestation or comment link between a box and something it holds is not drawn), own-boxes (the view draws its own boxes: its hand-written containers are ignored) (warnings).

Departures from UML 2.5.1: «manifest» to a component only (manifest-ends warns on other targets).

Left out ​

notes/stage-5.md §17: instance-level deployment (node and artifact instances name : Type); a deployment specification attached to a deployment line; nested artifacts; communication path multiplicities; device icons; «manifest» of anything but a component; per-target deployment specification properties. And, for all three stage 5 types, XMI, copy and paste, per-type diff() writers and a reader.

Layout limits, measured on examples/bookshop-deployment.json and tests/deployment-stress.json:

  • Laid out by the host's ranking with gap: 48, rgap: 56, cut: 280 on paths, labelGaps (decision 9) and port repair off. A cube box is 10 px more padded than stage 2's box on every side (its faces are inside its frame).
  • The example lays out clean right and down: no crossing, check() finds nothing, its seven labels all placed and none cut short (decision 21; laid out down without labelGaps, "HTTP" would have no spot).
  • tests/stage5-fixtures.test.mjs pins the stress file. Its edge-cases view: clean laid out right; four crossings laid out down (the lines of the artifact deployed both ways and of the one deployed by a line, across the two paths between one pair). Six levels of nesting with a communication path from the deepest to the top (L8): the outer box is 488 × 574 px, right and down. Its generated all view (50 nodes and artifacts, 50 lines, boxes five deep): 23 crossings right (15 before audit 27, when 8 lines still ran back inside the box they leave or end on) and 15 down; three lines along a box's border and a pair of lines sharing a line laid out right, and a label on a box's border; laid out down, three pairs of lines sharing a line and nine labels on a line (eight before audit 27). Seven labels there found no spot and were left off with nothing said; since audit 6 they are drawn, on a looser spot (one on a cube's face line, right).

Writers: what each shows of a deployment diagram ​

Measured on examples/bookshop-deployment.json (0.22.0): umlimator.py stills (SVG and PNG) and umlimator.py pdf. The PNG was looked at, the SVG read, the PDF's text read back (tests/cli.py reads its tables).

What is drawnSVG: handle.toSVG(), umlimator.py stillsPNG: handle.toPNG(), umlimator.py stillsPDF: umlimator.py pdf
Cubes, boxes nested with their faces, keywords over names, artifacts with their iconsYesYesYes, in vectors
Lines, «deploy» and «manifest», path labelsYesYesYes
The legend of line kindsNo: the legend is a piece of the pageNoYes, under the picture
TextText, in the page's font family; not embedded unless fontCSS is givenPixelsSelectable text
Accessible namesEach target's, artifact's and component's aria-label kept ("Execution environment Java 21 runtime, in Application server, 3 artifacts deployed"); the lines' <title> removedNoneNone
ThemeThe page'sThe page's--theme, light by default
TablesNoneNone"Elements": each element by its kind; a target's rows, what is deployed on it by nesting or by a line ("routes.conf, by «deploy»"); an artifact's, what it manifests. "Lines": every line, from → to, its label and kind

Accessibility ​

Every piece has a name: "Device Application server, holding 1 execution environment", "Execution environment Java 21 runtime, in Application server, 3 artifacts deployed", "Artifact shop-api.jar, on Java 21 runtime, manifests Shop API", "Communication path HTTPS from Shopper's device to Edge proxy". A selected box is said by both its title lines. Tab reads what each box holds, then the rest, then the lines; a box is not a Tab stop: the keyboard reaches it through the outline of elements. Text reads at 4.5:1, lines and outlines at 3:1 in both themes (tests/deployment.html, tests/stage5.html). Every gesture has a key (docs/editing.md); a drop of an artifact into a node and the Owner field each deploy it by nesting.

Performance (P1) ​

tests/stage5-fixtures.test.mjs on tests/deployment-stress.json's all view (50 nodes and artifacts, 50 lines, boxes five deep), CPU time, best of seven after a warm-up, on an Apple laptop at a load average of 3 to 8 (13 Nov 2026): a full layout and its SVG 128 ms; a path's label 125 ms; an artifact moved into another node 112 ms; a stereotype set (it grows a header, so the view lays out again) 133 ms; a colour (an edit that moves nothing) 37 ms, against the 100 ms target. CI holds 1 s and prints the figures. Over the target on this machine; of a layout's time the second layoutPass that labelGaps runs is about 40% (5.5's measure).

Tests ​

tests/deployment.test.mjs and tests/deployment.html (the type, its rules with a passing and a failing case each, the cube and its faces, the example under three fonts, both themes and both directions, every gesture by pointer and key, six levels); tests/deployment-minimal.json and tests/deployment-stress.json with tests/stage5-fixtures.test.mjs and tests/stage5.html (notes/stage-5.md §13: every edge case, the six-level width pinned, P1); tests/notation.html («deploy» and «manifest»'s arrowheads on what they point to); tests/cli.py (render, check, stills, pdf and its tables, the diff Action's step); tests/mcp.py.