Initial pattern catalog.

Author: simonbrowndotje

dsl/patterns/api-gateway/example-1.dsl

@@ -0,0 +1,70 @@
+workspace extends https://docs.structurizr.com/dsl/patterns/workspace.dsl {
+
+    model {
+        ss = softwareSystem "Name" {
+            ui = container "UI" {
+                technology "JavaScript"
+            }
+            service1 = container "Service 1" {
+                technology "Java and Spring Boot"
+            }
+            service2 = container "Service 2" {
+                technology "Java and Spring Boot"
+            }
+
+            ui -> service1 "Makes API calls to"
+            ui -> service2 "Makes API calls to"
+        }
+
+        env = deploymentEnvironment "Environment" {
+            deploymentNode "User's Computer" {
+                deploymentNode "Web Browser" {
+                    instanceOf ss.ui
+                }
+            }
+
+            apiGatewayServer = deploymentNode "API Gateway Server" {
+                apiGateway = infrastructureNode "API Gateway"
+            }
+
+            server1 = deploymentNode "Server 1" {
+                deploymentNode "Java Virtual Machine" {
+                    technology "Eclipse Temurin"
+
+                    instanceof ss.service1
+                }
+            }
+
+            server2 = deploymentNode "Server 2" {
+                deploymentNode "Java Virtual Machine" {
+                    technology "Eclipse Temurin"
+
+                    instanceof ss.service2
+                }
+            }
+
+            ss.ui -/> ss.service1 {
+                ss.ui -> apiGatewayServer.apiGateway
+                apiGatewayServer.apiGateway -> ss.service1
+            }
+
+            ss.ui -/> ss.service2 {
+                apiGatewayServer.apiGateway -> ss.service2
+            }
+        }
+    }
+
+    views {
+        deployment * env {
+            include *
+            autolayout lr 100 100 100
+        }
+
+        styles {
+            element "Infrastructure Node" {
+                shape ellipse
+            }
+        }
+    }
+
+}

dsl/patterns/api-gateway/example-1.png

@@ -0,0 +1,66 @@
+workspace extends https://docs.structurizr.com/dsl/patterns/workspace.dsl {
+
+    model {
+        ss = softwareSystem "Name" {
+            ui = container "UI" {
+                technology "JavaScript"
+            }
+            service1 = container "Service 1" {
+                technology "Java and Spring Boot"
+            }
+            service2 = container "Service 2" {
+                technology "Java and Spring Boot"
+            }
+
+            ui -> service1 "Makes API calls to"
+            ui -> service2 "Makes API calls to"
+        }
+
+        env = deploymentEnvironment "Environment" {
+            deploymentNode "User's Computer" {
+                deploymentNode "Web Browser" {
+                    instanceOf ss.ui
+                }
+            }
+
+            server1 = deploymentNode "Server 1" {
+                deploymentNode "Java Virtual Machine" {
+                    technology "Eclipse Temurin"
+
+                    instanceof ss.service1
+                }
+            }
+
+            server2 = deploymentNode "Server 2" {
+                deploymentNode "Java Virtual Machine" {
+                    technology "Eclipse Temurin"
+
+                    instanceof ss.service2
+                }
+            }
+
+
+            !relationships "ss.ui -> ss.service1" {
+                technology "via API Gateway"
+            }
+
+            !relationships "ss.ui -> ss.service2" {
+                technology "via API Gateway"
+            }
+        }
+    }
+
+    views {
+        deployment * env {
+            include *
+            autolayout lr 100 100 100
+        }
+
+        styles {
+            element "Infrastructure Node" {
+                shape ellipse
+            }
+        }
+    }
+
+}

dsl/patterns/api-gateway/example-2.dsl

@@ -0,0 +1,24 @@
+---
+layout: default
+title: API gateway
+parent: Pattern catalog
+grand_parent: DSL
+permalink: /dsl/patterns/api-gateway/
+---
+
+# API gateway
+
+- An API gateway is _typically_ a deployment concept and should be modelled in your deployment model.
+- API gateways can be modelled as a container when (1) you are building your own API gateway, (2) it's required in your development environment, and (3) it's doing more than rate limiting, routing, authentication, etc.
+
+## Example 1
+
+Model the API gateway as an infrastructure node, intercepting the communication between the UI and the backend services.
+
+[![](example-1.png)](https://playground.structurizr.com?src=https://docs.structurizr.com/dsl/patterns/api-gateway/example-1.dsl)
+
+## Example 2
+
+Model the API gateway as an annotation on the relationship between UI and backend services.
+
+[![](example-2.png)](https://playground.structurizr.com?src=https://docs.structurizr.com/dsl/patterns/api-gateway/example-2.dsl)

dsl/patterns/api-gateway/example-2.png

@@ -0,0 +1,39 @@
+workspace extends https://docs.structurizr.com/dsl/patterns/workspace.dsl {
+
+    model {
+        ss = softwareSystem "Name" {
+            app = container "Application" {
+                technology "Java and Spring Boot"
+            }
+        }
+
+        env = deploymentEnvironment "Environment" {
+
+            deploymentNode "Amazon Web Services" {
+
+                deploymentNode "App Runner" {
+
+                    deploymentNode "Docker Container" {
+                        instances 2
+                        properties {
+                            "Image URI" "1234567890.dkr.ecr.eu-west-1.amazonaws.com/example/application:latest"
+                        }
+
+                        deploymentNode "Java Virtual Machine" {
+                            technology "Eclipse Temurin"
+
+                            instanceof ss.app
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    views {
+        deployment * env {
+            include *
+        }
+    }
+
+}

dsl/patterns/api-gateway/index.md

@@ -0,0 +1,42 @@
+workspace extends https://docs.structurizr.com/dsl/patterns/workspace.dsl {
+
+    model {
+        ss = softwareSystem "Name" {
+            app = container "Application" {
+                technology "Java and Spring Boot"
+            }
+        }
+
+        env = deploymentEnvironment "Environment" {
+
+            deploymentNode "Amazon Web Services" {
+
+                deploymentNode "eu-west-1" {
+
+                    deploymentNode "App Runner" {
+
+                        deploymentNode "Docker Container" {
+                            instances 2
+                            properties {
+                                "Image URI" "1234567890.dkr.ecr.eu-west-1.amazonaws.com/example/application:latest"
+                            }
+
+                            deploymentNode "Java Virtual Machine" {
+                                technology "Eclipse Temurin"
+
+                                instanceof ss.app
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    views {
+        deployment * env {
+            include *
+        }
+    }
+
+}

dsl/patterns/aws-app-runner/example-1.dsl

@@ -0,0 +1,25 @@
+---
+layout: default
+title: AWS App Runner
+parent: Pattern catalog
+grand_parent: DSL
+permalink: /dsl/patterns/aws-app-runner/
+---
+
+# Amazon Web Services App Runner
+
+- App Runner is a deployment concept and should be modelled in your deployment model.
+- App Runner should _not_ appear on container views.
+
+## Example 1
+
+Model App Runner and the Docker container as deployment nodes.
+
+[![](example-1.png)](https://playground.structurizr.com?src=https://docs.structurizr.com/dsl/patterns/aws-app-runner/example-1.dsl)
+
+## Example 2
+
+As above, but add the AWS region as a deployment node.
+
+[![](example-2.png)](https://playground.structurizr.com?src=https://docs.structurizr.com/dsl/patterns/aws-app-runner/example-2.dsl)
+