Internals docs (#759)

csviri · web-flow · commit 4611134a6c94 · 2021-12-16T16:18:26.000+01:00
diff --git a/docs/_data/sidebar.yml b/docs/_data/sidebar.yml
@@ -11,6 +11,8 @@
     url: /docs/patterns-best-practices
   - title: FAQ
     url: /docs/faq
+  - title: Architecture and Internals
+    url: /docs/architecture-and-internals
   - title: Contributing
     url: /docs/contributing
   - title: Migrating from v1 to v2
diff --git a/docs/assets/images/architecture.svg b/docs/assets/images/architecture.svg
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Do not edit this file with editors other than diagrams.net -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="741px" height="701px" viewBox="-0.5 -0.5 741 701" content="&lt;mxfile host=&quot;app.diagrams.net&quot; modified=&quot;2021-12-16T13:34:46.221Z&quot; agent=&quot;5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36&quot; etag=&quot;ETJa8nfDf-xllq5m_PVF&quot; version=&quot;15.9.6&quot;&gt;&lt;diagram id=&quot;eP6_rGIzK21v1XbeDeGs&quot; name=&quot;Page-1&quot;&gt;5VpNc9owEP01XDpTxpK/4EhC2s40mWbCoc2po9gC1BrEyCJAfn1lLH9JgB1jY9rO5GCtJWHvvn1Pu07PvF1sPzO0mj9QHwc9aPjbnjnuQQgsCHvRn+HvYssAmrFhxogvJ2WGCXnD0mhI65r4OCxM5JQGnKyKRo8ul9jjBRtijG6K06Y0KP7qCs2wZph4KNCt34nP5/ItbCOzf8FkNk9+GRjyzgIlk6UhnCOfbnIm865n3jJKeXy12N7iIHJe4pd43acjd9MHY3jJqyz4/fXXmoDgfvaGwofpaPAy/jn6KKPzioK1fOFvK8wQp0w+NN8lnmB0vfRxtJnRM282c8LxZIW86O5GxF7Y5nwRiBEQl3JbzDjeHn1ekHpBwAfTBeZsJ6bIBY702y4BhBxvsjCAJAzzXAgG0oZk5GfpzplzxIX0zzt8ZWq+uqVLzmgQ4O69ZTpu3y53mHVJh9maw+5exetM6Jp5+AEtRe5cg+OKOIPDQzizL+g2R3Ob5iS89EcRuYmRF6AwJF7RL0Un4i3hP6JrgZB49CznRdfjbW7aeJcMBLJ3uUXR8Dl/L1u2HyXr4kfFvsaqSjzE6+xhUJ5vHLEZ5mUw0+Obi98hmkhsDAeIk9fi4x6KqfyFR0rEi2QspcIHKrCIX1OuytOzspELFL5zlY1iP2gb7SGWvnZ91LmHk/WRUQ+H4RXogelAheEsu2Kqqq5sLFUHmtOesDiJeERIwpiEK8S9+VVwXNFx9kGOO5AkrTlueEoaOveXW0ESnEsqKQCNa0LK7wV2z8j+CL/X0ZIGNWFYURPcw/E9k+zBsAiMlIDeS/awbKOWyR7o535B9KKYQVxkn7HPRR1gIoD36EUUeAJMOCRv6GV/yyjiDAVktoxAKPYQ3GfeRKlIREU1kjcWxPejhRIXsnKTm/VSAS3J4BN5ckbcz8vS5k9uSZaC92Vp9YwrzaRhK5mknrpNs+6xySrZqO1M0pXM6Pc/nJs8LBYVLXdeKOd00U7uOCc1UW5zbtyV6NDpNMStBCZ1ReNlFMgJXyaDZWVUWwlcKpmwYqKbrSR6GvGkrAE1E90clmzUcqJDvf0D/s5Ez3Ufm0j0syQTWppXs6baE47BcU2lgQPU2kCWVvnaYHigNkhKsOZdqLfZ/k+isysSXYy5a2kYWWqNXbdhZKmdp7YJ8br6lK2dkMsF1qoIvHaKUmdQxIFt1AVU2UZtA0pvQf4TRSk8crC+kMKe6lF2LqdqHZiWc2WtNsdoy196QdcBrXUgi0fY6UKqqJQJdl1V1NjwwqpotlZ2Gn1Y6/Md7Or7nVsReINOgWcX8eJYddXTUIA3rAY8gQS0y01bRRPCVqDZ/EeEbpltUBFgsFOE2Urjwq3bAbGSr0CqVl6K2vQOSGP4cfMAMqpSm1ugNnA5aquKvE411ValUGWkypqqinNjwBPD7B/g4unZvxGad38A&lt;/diagram&gt;&lt;/mxfile&gt;" style="background-color: rgb(255, 255, 255);"><defs/><g><rect x="0" y="0" width="150" height="80" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 148px; height: 1px; padding-top: 40px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Operator</div></div></div></foreignObject><text x="75" y="44" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Operator</text></switch></g><rect x="307.5" y="0" width="140" height="80" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 138px; height: 1px; padding-top: 40px; margin-left: 309px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Controller</div></div></div></foreignObject><text x="378" y="44" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Controller</text></switch></g><rect x="300" y="190" width="155" height="80" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 153px; height: 1px; padding-top: 230px; margin-left: 301px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">EventSourceManager</div></div></div></foreignObject><text x="378" y="234" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">EventSourceManager</text></switch></g><path d="M 377.5 80 L 377.5 183.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 377.5 188.88 L 374 181.88 L 377.5 183.63 L 381 181.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><rect x="302.5" y="350" width="155" height="70" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 153px; height: 1px; padding-top: 385px; margin-left: 304px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">EventProcessor</div></div></div></foreignObject><text x="380" y="389" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">EventProcessor</text></switch></g><rect x="305" y="490" width="150" height="70" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 148px; height: 1px; padding-top: 525px; margin-left: 306px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">ReconcilerDispatcher</div></div></div></foreignObject><text x="380" y="529" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">ReconcilerDispatcher</text></switch></g><rect x="10" y="190" width="160" height="80" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 158px; height: 1px; padding-top: 230px; margin-left: 11px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">EventSource</div></div></div></foreignObject><text x="90" y="234" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">EventSource</text></switch></g><path d="M 90 270 L 296.9 381.97" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 301.52 384.47 L 293.69 384.21 L 296.9 381.97 L 297.03 378.06 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 328px; margin-left: 197px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">Propagate Event</div></div></div></foreignObject><text x="197" y="331" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="11px" text-anchor="middle">Propagate Event</text></switch></g><path d="M 300 230 L 176.37 230" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 171.12 230 L 178.12 226.5 L 176.37 230 L 178.12 233.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-end; width: 1px; height: 1px; padding-top: 228px; margin-left: 199px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: right;"><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">0..*</div></div></div></foreignObject><text x="199" y="228" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="11px" text-anchor="end">0..*</text></switch></g><path d="M 150 40 L 301.13 40" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 306.38 40 L 299.38 43.5 L 301.13 40 L 299.38 36.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-end; justify-content: unsafe flex-end; width: 1px; height: 1px; padding-top: 38px; margin-left: 307px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: right;"><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">1..*</div></div></div></foreignObject><text x="307" y="38" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="11px" text-anchor="end">1..*</text></switch></g><rect x="550" y="195" width="190" height="65" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 188px; height: 1px; padding-top: 228px; margin-left: 551px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">ControllerResourceEventSource</div></div></div></foreignObject><text x="645" y="231" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">ControllerResourceEventSource</text></switch></g><path d="M 455 230 L 543.63 227.67" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 548.88 227.53 L 541.98 231.21 L 543.63 227.67 L 541.79 224.21 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><path d="M 645 260 L 462.8 381.47" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 458.43 384.38 L 462.31 377.58 L 462.8 381.47 L 466.2 383.41 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 323px; margin-left: 551px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">Propagate Event</div></div></div></foreignObject><text x="551" y="326" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="11px" text-anchor="middle">Propagate Event</text></switch></g><rect x="300" y="640" width="160" height="60" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 158px; height: 1px; padding-top: 670px; margin-left: 301px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Reconciler</div></div></div></foreignObject><text x="380" y="674" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Reconciler</text></switch></g><path d="M 377.5 270 L 379.1 343.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 379.21 348.88 L 375.56 341.96 L 379.1 343.63 L 382.56 341.81 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><path d="M 341.25 420 L 342.39 483.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 342.48 488.88 L 338.86 481.95 L 342.39 483.63 L 345.85 481.82 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><path d="M 380 560 L 380 633.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 380 638.88 L 376.5 631.88 L 380 633.63 L 383.5 631.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><path d="M 417.5 490 L 418.64 426.37" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 418.73 421.12 L 422.1 428.18 L 418.64 426.37 L 415.11 428.05 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g><switch><g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/><a transform="translate(0,-5)" xlink:href="https://www.diagrams.net/doc/faq/svg-export-text-problems" target="_blank"><text text-anchor="middle" font-size="10px" x="50%" y="100%">Viewer does not support full SVG 1.1</text></a></switch></svg>
diff --git a/docs/documentation/architecture-and-internals.md b/docs/documentation/architecture-and-internals.md
