Merge pull request 'add diagrams' (#30) from entity-relations into main

Reviewed-on: Fediversity/meta#30
Reviewed-by: Valentin Gagarin <valentin.gagarin@tweag.io>

architecture-docs/.gitignore

@@ -0,0 +1,3 @@
+*.err
+*.odt
+.~lock*

architecture-docs/entity-relations.mmd

@@ -0,0 +1,25 @@
+---
+title: Fediversity migration entity relations
+---
+erDiagram
+    setup["Fediversity setup"]
+    env["run-time environment"]
+    deployed["deployed configuration"]
+    staged["staged configuration"]
+    token["deployment token"]
+    script["migration script"]
+
+    setup }o--o{ env : offers
+    setup ||--o{ operator : serves
+    operator ||--o{ domain : owns
+    deployment }|--|| domain : uses
+    operator ||--o{ deployment : has
+    deployment ||--|{ token : generates
+    deployment ||--o| deployed : has
+    deployment ||--|| staged : has
+    deployed |o--|| staged : compares
+    deployed ||--|{ application : describes
+    application ||--o{ version : follows
+    application ||--o{ script : runs
+    deployed }|--o{ version : follows
+    script }o--|| token : uses

architecture-docs/host-architecture.puml

@@ -1,4 +1,5 @@
 @startuml
+skinparam backgroundcolor transparent
 
 package Management {
     object "Nix-Panel" as A {
@@ -12,7 +13,7 @@ package Management {
         Secrets
     }
     object "**Orchestrator**" as Orch {
-        NixOps
+        Terraform
     }
     object "**Identity Management**" as AAA {
         Authentication
@@ -49,12 +50,10 @@ package Virtualization {
         Application C
     }
     map "**Application options**" as App {
-        Edumeet => Matrix
+        Vaultwarden => Matrix
         NextCloud => Pixelfed
         Webmail => Peertube
-        Hedgehoc => Mastodon
-        Project planning => Owncast
-        Office => Castopod
+        Forgejo => Mastodon
     }
 }
 

architecture-docs/interactions.mmd

@@ -0,0 +1,47 @@
+flowchart
+
+  user(user) --> |use| deployment
+
+  configuration1 -->|deploy| deployed1
+  devs(developers) --> |maintain| fediversity
+
+  fediversity --> |update| provider1
+  subgraph provider1["fediversity setup A"]
+    subgraph configurations1[configurations]
+      configuration1[staged configuration]
+      configuration1 --> |update| configuration1
+      deployed1[deployed configuration]
+    end
+    deployed1 --> |describe| deployment
+    provider-config[runtime config] --> |describe| host
+    provider-config --> |implement runtime interfaces| configurations1
+    subgraph host[runtime environment]
+      deployment[applications]
+      state
+    end
+  end
+
+  deployment --> |store| state
+
+  operator(operator) --> |change| configuration1
+
+  subgraph provider2["fediversity setup B"]
+     subgraph configurations2[configurations]
+      configuration2[staged configuration]
+      deployed2[deployed configuration]
+    end
+    subgraph host2[runtime environment]
+      deployment2[applications]
+      state2[state]
+    end
+  end
+
+  operator --> |trigger| migration
+  configurations1 & state --> migration
+  migration --> configurations2 & state2
+  provider(hosting provider) --> |maintain| provider1
+  subgraph fediversity[fediversity source code]
+    applications[application modules]
+    backends[runtime backends]
+    config[runtime options]
+  end