design-practice-repository

Artifact/Template: Overview Diagram

also known as: Architecture Overview Diagram, Container Diagram

A container/overview diagram provides an overview of logical and physical building blocks that are refined in other types of diagrams. Unlike the context diagram, it looks inside a system, picking up all external interfaces (with human users, with other systems).

Motivation (Addressed Information Need)

Typically created during solution strategy, refined iteratively and incrementally later (as/if needed).
Illustrates Client-Server Cuts (CSCs) such as Remote User Interface or Distributed Presentation and other “big” architectural decisions (@RenzelKeller:1997).
Discloses information about interface protocols and implementation technologies.

Usage (Produced and Consumed When)

An architecture overview diagram can be used for:

Quick orientation for starters (new DevOps team member, support, and maintenance staff)
Work distribution and planning
Non-technical stakeholder communication (including project managers and sponsors)

Many more use cases for this diagram exist because a picture is worth a thousand words.

Template Structure and Notation(s)

Container diagrams often come as Informal Rich Pictures (IRPs). C4 and its tools take a slightly more formal approach, allowing designers to zoom in (coming from a Context Diagram, moving on to a Component Diagram).

Example(s)

Having decided for logical layers as primary organizing/decomposition principles, an architecture overview diagram featuring layers and their assignment to tiers may look as follows:

Example of an Overview/Container Diagram

Three conceptual tiers are shown, one for application frontends and integrated external systems (in client role), one centered on business logic, and one containing data stores and external systems (in provider role).

Note that logical layering is a common but not the only option to decompose systems and turn then into distributed applications. Workflows and pipes-and-filters are among the other options, as explained in a Cloud Computing Pattern.

Tools

Common choices include:

Any drawing tool, real-world whiteboards or whiteboarding software
C4 tools including Structurizr
UML tools, possibly with customization or profiling

Hints and Pitfalls to Avoid (Common Pitfalls)

Just a few hints (many more can be found online):

As for all diagrams, model with a clearly defined purpose and target audience in mind.
Decide for a single, consistent level of abstraction and refinement per diagram; explain which elements are included in the overview and why.
Do not confuse the abstract, conceptual notion of “container” (used here) with more concrete technical container concepts such as those in charge of dependency injection (for instance, in Spring) or orchestration and deployment containers (for instance, in Docker and Kubernetes).
Use names that unveil domain concepts and architectural roles; for example, “Policy Management Frontend” is better than “Client” (in an insurance domain/scenario).
As for all diagrams, be consistent in the use of notation and provide a legend for non-standard diagram elements.

See the section “Notation, notation, notation” on the C4 model home page and its diagram review checklist for more hints.

Origins and Signs of Use

Container Diagram is one of the four Cs in C4, but the notion and concept of providing overview diagrams is much older, going back to the beginnings of the software architecture field (and beyond).

Activities:

SMART NFR Elicitation provides design drivers and decision justifications.
Created in Architecture Modeling activities

Artifacts:

More Information

Data Provenance

title: "Design Practice Repository (DPR): Container Diagram"
author: Olaf Zimmermann (ZIO)
date: "01, 31, 2023"
copyright: Olaf Zimmermann, 2023 (unless noted otherwise). All rights reserved.
license: Creative Commons Attribution 4.0 International License