7. Deployment View¶

Help: The deployment view describes:

1. The technical infrastructure used to execute the system, with infrastructure elements like geographical locations, environments, computers, processors, channels, and net topologies as well as other infrastructure elements.
2. The mapping of (software) building blocks to that infrastructure elements.

Often systems are executed in different environments, e.g., development, test, staging, production. In such cases, you should document all relevant environments.

Especially document the deployment view when your software is executed as a distributed system with more than one computer, processor, server, or container, or when you design and construct your own hardware/infrastructure.

Motivation: Software does not run without hardware. This underlying infrastructure can and will influence your system and/or some cross-cutting concepts. Therefore, you need to know the infrastructure.

Form: UML deployment diagrams, C4 deployment diagrams, or similar infrastructure-aware notations. Use tables to map building blocks to infrastructure nodes.

7.1 Infrastructure Level 1¶

Help: Describe (usually in a combination of diagrams, tables, and text):

• The distribution of your system to multiple locations, environments, computers, processors, etc., as well as the physical connections between them
• Important justification or motivation for this deployment structure
• Quality and/or performance features of the infrastructure
• The mapping of software artifacts to elements of the infrastructure

Deployment Overview Diagram¶

\<Insert a deployment diagram showing the production infrastructure. Consider using PlantUML, Mermaid, or C4 deployment notation.>

┌───────────────────────────────────────────────────────────────────┐
│                        Cloud Provider (AWS)                       │
│                                                                   │
│  ┌─────────────────────────┐  ┌─────────────────────────┐        │
│  │    Availability Zone A   │  │    Availability Zone B   │        │
│  │                         │  │                         │        │
│  │  ┌───────────────────┐  │  │  ┌───────────────────┐  │        │
│  │  │  K8s Node Pool    │  │  │  │  K8s Node Pool    │  │        │
│  │  │  ┌─────┐ ┌─────┐ │  │  │  │  ┌─────┐ ┌─────┐ │  │        │
│  │  │  │Svc A│ │Svc B│ │  │  │  │  │Svc A│ │Svc B│ │  │        │
│  │  │  └─────┘ └─────┘ │  │  │  │  └─────┘ └─────┘ │  │        │
│  │  └───────────────────┘  │  │  └───────────────────┘  │        │
│  │                         │  │                         │        │
│  │  ┌───────────────────┐  │  │  ┌───────────────────┐  │        │
│  │  │  Database (Primary)│  │  │  │  Database (Replica)│  │        │
│  │  └───────────────────┘  │  │  └───────────────────┘  │        │
│  └─────────────────────────┘  └─────────────────────────┘        │
│                                                                   │
│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐            │
│  │  CDN / WAF    │  │  Load        │  │  Object      │            │
│  │              │  │  Balancer    │  │  Storage     │            │
│  └──────────────┘  └──────────────┘  └──────────────┘            │
└───────────────────────────────────────────────────────────────────┘

Motivation¶

\<Why was this deployment topology chosen? What are the key drivers (availability, cost, compliance, latency)?>

Quality and Performance Features¶

Mapping of Building Blocks to Infrastructure¶

7.2 Infrastructure Level 2¶

Help: Here you can include the internal structure of (some) infrastructure elements from Level 1. Copy the structure from Level 1 for each selected element.

7.2.1 \<Kubernetes Cluster Detail>¶

\<Provide more detailed information about the Kubernetes cluster configuration, namespace strategy, resource quotas, network policies, etc.>

7.3 Environments¶

Help: Document the different environments if they differ significantly in structure or if the differences are architecturally relevant.

Based on the arc42 architecture template (https://arc42.org).
Created by Dr. Peter Hruschka and Dr. Gernot Starke.
Licensed under CC BY-SA 4.0.