Diagram on Micha Kops' Tech Notes

Modeling AWS Structures with PlantUML and AsciiDoc

Tue, 08 Nov 2022 00:00:00 +0100

The AWS shapes are included in the PlantUML stdlib .. simply include them as shown here:

example.puml

@startuml
!include <awslib/AWSCommon>
!include <awslib/Analytics/ManagedStreamingforKafka>
!include <awslib/Database/RDS>
!include <awslib/General/Users>
!include <awslib/General/InternetGateway>

!include <kubernetes/k8s-sprites-labeled-25pct>

skinparam linetype ortho

title "AWS Context Diagram"


package "EKS Kubernetes Cluster" as eks_cluster {
    component "<$pod>\napp1" as pod1
    component "<$pod>\napp2" as pod2
}

ManagedStreamingforKafka(kafka_pod, "Amazon MSK", "Apache Kafka")

RDS(pg_rds, "PostgreSQL", "Sample Schema")


Users(users, "AppUsers","editors, admins")

InternetGateway(igw1, "Customer Gateway", "Customer access to internal services")

users -> igw1
igw1 --> pod1
igw1 --> pod2
pod1 --> pg_rds
pod1 --> kafka_pod
pod2 --> pg_rds
pod2 --> kafka_pod

@enduml

Snippet: Adding Legends to PlantUML Diagrams

Fri, 21 Oct 2022 00:00:00 +0200

The following hack allows us to draw a diagram in a diagram in a table in a legend :D

example-diagram.puml

@startuml
skinparam legendBackgroundColor transparent
skinparam legendBorderColor transparent

actor Editor as editor
queue Queue as "Message\nQueue"
editor -> [Component] : call
[Component] --> Queue : publish


legend right
{{
   scale 0.7
   skinparam defaultFontSize 14
   skinparam BackGroundColor transparent
   skinparam defaultBackgroundColor white

   !procedure $entry($type, $label, $scale=1)
      {{\nscale $scale \nskinparam backgroundcolor transparent\nlabel " " as A\nlabel " " as B\n $type \n}} => $label
   !endprocedure

   map "<b>Legend</b>" as legend #white {
      $entry(":Editor:","\nEditor for Data xyz", 0.6)
      $entry("[Component]","\nSome Component", 0.8)
      $entry("queue Queue","\nKafka-Topic", 1)
      $entry("A -> B","Data-Flow")
   }
}}

endlegend
@enduml