From ce650d9bfe59bfb3bd558b61563ff64cf3ccfbac Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Fri, 16 Jan 2026 12:15:24 +0100 Subject: [PATCH] Add first version of Network Topology documentation --- docs/installation/environment-variables.md | 2 +- .../images/network_topology.excalidraw.svg | 2 + docs/installation/network.md | 37 +++++++++++++++++++ 3 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 docs/installation/images/network_topology.excalidraw.svg create mode 100644 docs/installation/network.md diff --git a/docs/installation/environment-variables.md b/docs/installation/environment-variables.md index 9e5d78f9d..44d261958 100644 --- a/docs/installation/environment-variables.md +++ b/docs/installation/environment-variables.md @@ -1,5 +1,5 @@ --- -order: 4 +order: 5 --- # Environment Variables diff --git a/docs/installation/images/network_topology.excalidraw.svg b/docs/installation/images/network_topology.excalidraw.svg new file mode 100644 index 000000000..519feb6a4 --- /dev/null +++ b/docs/installation/images/network_topology.excalidraw.svg @@ -0,0 +1,2 @@ +eyJ2ZXJzaW9uIjoiMSIsImVuY29kaW5nIjoiYnN0cmluZyIsImNvbXByZXNzZWQiOnRydWUsImVuY29kZWQiOiJ4nO1d6VLjSLb+30/hoP/MjWjUuZzcOmJigq1YqqBcXOBiqemJXG5hXHUwMDBiW5Sx3LaMMVx1MDAxM/1cdTAwMDb3PsO84jzCnDSUJUspY4Og3XdMR1SD1lxczne+s2Xqnz9UKmvxqFx1MDAxYqz9UllcdTAwMGLu6n47bPT84dpP9vht0OuHUVx1MDAwN0+x8d/9aNCrj69sxXG3/8vPP9/4vW9B3G379cC7XHL7XHUwMDAzv92PXHUwMDA3jTDy6tHNz2FcdTAwMWPc9P9m/z3yb4K/dqObRtzzkpesXHUwMDA3jTCOelx1MDAwZu9cbtrBTdCJ+/j0v+Pflco/x//imbBh31i7qu9INTpvjarRgOlcdTAwMDHIL9XP41vHXHUwMDE3fe9CL6jHfqfZXHUwMDBlklN3eJxcdTAwMTJcIj1cblooXHUwMDA1nHFGYHJ6ZE9LJTxccsooyThQNTk5XGZcdTAwMWJxy16gmPBcYldMK6GEgeSKVlx1MDAxMDZbMV6CXHUwMDBm9Vx1MDAxOJOKMs1cclx1MDAwN2CTS1x1MDAxZdrzS4VMjvTjXvQt2Ira2Hts9I80sP8lTb7069+avWjQaUyuiXt+p9/1ezhGyXVXYbt9XHUwMDEyj8ZPx9nBYV3LvOPssVx1MDAwM5A5Prmr4fdbQeo2fGuz1Vx0+nZcIujkaNT162E8elx1MDAxOMnJUdvE7n5jPGf/SFx1MDAxYdXD2d63k9ZcdTAwMTm025PDYadcdTAwMTHYqVj7Mpp6W6fx+LbvXHUwMDEznswmfzzye9L4ILBcdTAwMGZcdTAwMDbGKKda8smJRFSFltmjR1FnLLbMXHUwMDEwKjmRXCJpVH9cdTAwMWJcdTAwMDUvXHUwMDFlP/RcboU3SKbAtmwnK5RpwZySuzi4S+YlJbaqXHUwMDFmrn/1P7VH7Wiwf3FcdTAwMWP91tpmm2uT635//C1cdTAwMTm9QbfhP7SHKqmFpEBQ5pKZaIedb9mhbUf1b0lcdTAwMTd+SFxyWVx1MDAwNkTu1uRANNWZMX6YMMojWlx1MDAxOEFAKEhccvFYJoyUXHUwMDFlUSC1IYpcdTAwMGJcbnn8MONcdTAwMTFjXGZcdTAwMDUhiNKUiTyAUsdWiKlMIebejZipq1x1MDAxZqFBNU5cdTAwMDHHWVx1MDAxMlx1MDAwZWxcdTAwMDCnRdigRmmBqlx1MDAwYp5cdTAwMDWOMuU3XHUwMDExRyuG2P396klQr9RcdTAwMDadTtBOzWTUiU/C+zGuydTRd/5N2LYjL6ZcdTAwMWW10Vx1MDAwZZudMUeMXHUwMDA1Lj1cdTAwMTBxiJw0OX9cdTAwMTnFcXSTXFxQx2f6YSfo7c/DRFx1MDAxMT4+7Pjt2szW+4M4Olx1MDAwZfpcdTAwMGbtj3uDID1Awd53TFCPiVx1MDAxOXjube/t7m+dvb9cYpqfP1x1MDAwZjZORlVS312AXHUwMDE0XHUwMDE186xOpIoonCWSqNPRXHUwMDAz51x1MDAxMU9cdTAwMDKhwFx1MDAwNFMgXHUwMDEyQvuOak6Mp5XkwJTiwJVcdTAwMDPU+GyPIeLxXG7CXHIzZrlAzjLHi+56fYz75MWsiITIuFGK5UBu71Ike3RCi8RcdTAwMDCARlx0eDterO+G9702+/q+XHUwMDE16Z29+unn3cOrjVx1MDAxNC/+5H7so9g3XHUwMDA315d7W1x1MDAxN1vwtXa73vl0c3ekz6bf8v39fq9cdTAwMTdcclx1MDAxN+JbjixFSVx1MDAxYY7P51t3L+fgW0pcdTAwMTlFaGmuuCFcdTAwMTJVus5AU4DHXHUwMDAwiJBcXFx1MDAxOZfByihi11x1MDAxOM1cZiVUSFx1MDAxN99cbrKColx1MDAxYop0fro1mmtcdEy7IFx1MDAwN6zQXHUwMDEy1VxmzVCKaC2ZbFx1MDAxN1x1MDAxNt482XbioIf0VflcdTAwMTD5jUu/7WODe792/rJXq1X7P1X6QftqvY9EXHUwMDE5NP6nXGYurlx1MDAwN/Z9M8j4Jmw00sSVIeMnXHUwMDE4MEfGz+ldOVxcvVx1MDAwMfuHwcFnvv5bK1RfTzZOqztnfH6uXHUwMDA2pTytNaVgXHUwMDE0QcFJxvORq7mnXGJwQFx1MDAxOVBEJEy+XGJXM/BcdTAwMDRcYq2Mtk4ysslKQbhcdTAwMTVcdTAwMDR7OVdcdTAwMWJ0h9DmliYt+lx1MDAxM67OObZcdTAwMTMzXVxiVOok6dfre7CfoviSnp1cdTAwMThxXHUwMDFl6+PT2kV1eLM+L1O3R1freqN68O44qt/u7vV2m3u1T/Mx9Vx1MDAxZmlcdTAwMDEggnRcdTAwMWHkL/C4naM3j1x1MDAwNSCk8lx1MDAwMPmdXHUwMDE5RKJCZGdcdTAwMDCvuIc6gWmJbZUqRfBcdTAwMTOfm1x1MDAxM09ZQuBcdTAwMDZcYjDjiFktmcu9RFxi5/ObXHUwMDAwXHUwMDE0KPpOhDCXx51W1Fkoo5ZFTcxY2Vx1MDAxZTeXqOzNXHUwMDAy8pszXHUwMDAyTqtHlV186NBcdTAwMWYtXHUwMDAzyT9BnVmSd7a+XHUwMDFjXHUwMDEyr9+zwe3+cHvY6jBBR8F9/Hn9bFx1MDAwMVx1MDAxMrdcdTAwMWU1k2iUXHUwMDBiwSil01x1MDAwZbf1t9GY50RLKiVOZt6qR6+AKqq1MIRzNFx1MDAwNVxcJC7RXHUwMDEwUMgvXHUwMDAwSjJ80Fxu4m6IQ1x0JE6ZXHUwMDE2nFx1MDAxM1x1MDAxN/KZKLT+qTRcZv221PS/OouPjrbCg+2v8OV8n1xmt8Ot7iW5MvOyLf9wXFz9cvn1Tn7ReyT8+P54PWyKkthcdTAwMTZFVVx1MDAxYS7TaHw+27p7OVx1MDAwZtuC1Fx1MDAxZVx1MDAxYbxMXHUwMDFi4Fx1MDAwMoiZZlsljMdcZiDotKVS7VxucMPY3zZcdTAwMDTVL1wi1GVfr1x1MDAxY+5CKJ7OT7dcZpmWXHUwMDExXHUwMDFja5flzIQqXHUwMDAyXHUwMDFkp8RYsD4ryFWm/ObYdufuwSn9tZP2SpeBeJ+guyzxfu9Ixd2Pcij4y1nAovbd6TbERjZcdTAwMTX/rX306XpcdTAwMTFcbpZcdTAwMWWVikiOOFdcIlx1MDAxNTpcdTAwMWLLMnKrRzU1XHUwMDEypVx1MDAxYdBNToRsxcGPk14m8PXLOZih6pWKa7f1zbJHJ1x1MDAxY8xQUYt0QuzVOZhdb368un/XQibhTXN6uE9cdTAwMWFcdTAwMWa/zsvBfl2N3jfZYKfGNk2z8am7XHUwMDE3nqiyOFx1MDAxOFx1MDAxZFx1MDAwNmVKinm7ezlcdTAwMTdcdTAwMDcr6qFbi60xXHUwMDFhJKeZmDdDVFx0LoSwNM1AO6o0mPGMMFx1MDAxYe9GXHUwMDE2XHUwMDE3riqNXHUwMDE1XHUwMDA3XHUwMDE3QdHMT8GUK5xcdTAwMDZuwJljZlCIOaJcdTAwMTGnaGo9XHUwMDBidLPkV1hcdTAwMTJ+XHRcdTAwMDdvtaNBo3JcdTAwMWNccuJxPJiDx4XHpcfVUoS5nyC9LFx1MDAxMc/Vm3Lo+Li1xbpcdTAwMWZPmlv65Oa88e64qz9cdTAwMWXqPNztI6fhbrj2lFFCconqh7NcdTAwMDRcblx1MDAwZkRMlYe+sFxyd1x1MDAwMrJxXCIxXHUwMDEzsGvNPYpcblxcXHUwMDBiXCKEMil3a4J2pGHUXHUwMDE4QFx1MDAwNVx1MDAwM6VcdTAwMTXI5Vxudy1RhYm/MS9cdTAwMTGzXCJcIjZSao3a11WTxfIp6aTuRDKJ+lqXnVxuXHUwMDAzdMtcdTAwMDWkZXpendCNwizPJ79VXHUwMDEykVx1MDAxOf8x+f1cdTAwMWY/Oa8uXHUwMDE2U/uznpPQ5Hk52m77/XgrurlcdGPsaNU2MqefY79cdTAwMTdv4qyGnWb2XFzQaVx1MDAxNJxcdTAwMTnftWGNhlbg52RcdTAwMDTvy56boVx1MDAwZS6of0N6vUCMzuu1r+9cdTAwMDe76nZcYvNb59aNtvrAXHUwMDBlXG4xJJvlskksblx1MDAxNLdWvFRgXHUwMDFjfjg66Z5lJ7TtXHUwMDE0kHSIbaJcdTAwMTVcZvekwncwJjia6ikh+a5cdTAwMTVcdTAwMDDNd0GUUFRoxVx1MDAxOWRpeiEt8WOgrsTV1Z/cPNh+saWu0Fx1MDAxNWJEsZyHbqekOFVOXHKgejBGvWF1ykXY6sf8ZrvV6rzbaF72+s2Dk9piOSTO0yrtRVx1MDAxNrW7NfNY1JpoXHUwMDBmXHIuqlxyQ0lcdTAwMDbIWNRcdTAwMWO4p5BiXHThhlsoOCxqa5JcdTAwMWLDlVx1MDAwMqBAUinhWUmkUvHz/8fE3t5dwMa2dbJKc+OqLDFQ6NdKivrRSFJ6ZcmiXHUwMDAynTOx//2v//2/SuWhXHUwMDAyI4iXwap+gqyyVnVRXHUwMDA3yjGkZzv4XHUwMDE5535cdTAwMWHmUjCPc23AMKGJlJnqbCaoXHUwMDA3M1x1MDAxZGdgXG5hXHUwMDBlXGbvVUZcdTAwMGLtXGJeXHUwMDEzj2tCXHUwMDE1o0QgXHUwMDBio0FetjH9XHUwMDAymiw0pN9cdTAwMWXi71x1MDAxNkA4WjBcdTAwMWH1JHVcdTAwMDWy0XYpJETOlKJSmrIj2Vx1MDAxMulioSjQ61jMhcI4vjsvhmVazClz5nFB0jz+91hY75I3TNn/XHUwMDFlYcyOrbBcXKhcdTAwMDTAdHfQssHOKKU1sXVbQrqGXHUwMDA3tWF90E8jzEqo37VHcubWlKFf1KGrWjCMN9d3morFw73N0baBxu1cXFx1MDAxZFonuVx1MDAxZYnX7tJCXHUwMDFlSlZFXHUwMDA27ctoOFx1MDAxNtop3Tzu4EnQ/I6MvFjs90+6QT30245cdTAwMTdmz81Q7LOH+imXiFx1MDAxMS08dGNs4Vx1MDAxN1eGZTxcIpuvQL2O9EyJUaDyZUBLkK/48ZJdscvLP7n1VmC8LZKrwDEmXFy7Nb7khS5cdTAwMTAnXHUwMDA00KJcdTAwMTNvWC+wSVx1MDAwNsdcdTAwMDdXtepAV2vhXHTcjejp+eFy5CpcdTAwMTZlqVx1MDAxOdB093JcdTAwMGXPylx1MDAxNu946FYh/Vx1MDAwMFWGsKzJhYgyVCim0W5cdTAwMTZC5+txqTRcdTAwMWWhRiOPXHUwMDAzXmK4zuNylawowuLeXHUwMDAyZpb1oVx1MDAxNFKRy5GSurBeQKCdhVx1MDAxYfV5XHTCmfJLjXiRIzVJs59cdTAwMDS927BcdTAwMWX0f+38Zb9aOWuFcdBcdTAwMGX78VJkLJ5gvcLSgaf7VI67tTM80DUgerjbXHUwMDBmdrfvXHUwMDBmXHUwMDE4PbzrLMDKyniokjnjgqBo0WlaVjZsQihFP1x1MDAxY20k1/KcXHUwMDE1KZejXGL2X0zKNu5FuVZOTi5eSy5cdTAwMTlY7WDesH5AfoDG6S0/r23qr9e3n6PRZkd+WZJcdTAwMWE+IFBStNPdy7k4XHUwMDE5XHUwMDExXHUwMDAzWnA0llx1MDAwMZjkmepaxTxbXHUwMDEzYOyyK8lSK+qSYKdNOVx1MDAxYYOOJ0XApYtcdTAwMDBXXHUwMDE1809cIvFgkfpcdTAwMDFibNFcdTAwMGW4coVcbnJInNjBRnPg6axQSSV8ROtUNOVcdTAwMTmUvH10UjlcdTAwMGXqUVx1MDAwZodtXHTI91x0csuSr7P15dDsbLUzK6qJXHUwMDE0XHUwMDBisyhWg2dmwtnGkTTa6eg6gbB12lx1MDAwZTjbXFyh0Xq8TMZcdTAwMThI16780SS7REHN9/NDW1hfhlx06Ury5Vx1MDAwZk5CmmBwXHUwMDA2XHUwMDAwXHLuspFt64KehexSQ5rrxbI4Pp1cdTAwMTfD5Ik59i0tqDlbS1RKjFx1MDAwMTKpXFxDVH5Yc3bB8qwuLVx1MDAxNqcto0N/6qDmltiG44vojp53ru+bW992L1x1MDAwNlx1MDAxYjSv191lX0Rz1NhcdTAwMWOIUDpTf41j73FG7bpGbYtAXHUwMDFjVtqq7qtE1f7hxXVfUirCre5yaHxOi5djSEDviYmyXHUwMDE3P1x1MDAwMuN6IVfkdTT+f1nZl7pcdTAwMWHUdtVutTvY/2Ru6+Tjl0bnaP6yLyOMZ6TmXG5cdTAwMDdEKEoy0VS7uVx1MDAwMcdcdTAwMWZm89to6uWLQVe7XHUwMDFilKhcdTAwMTNcdTAwMGXn1Vx0xfvzaZxInFx0l1x1MDAxNVxiqthcZmRS4CTL5ymFSfNcdTAwMTZcbqp0h9fHXHUwMDFmjj9cdTAwMWTpvu6FXHUwMDA04uvNweXFvEGV6vEnas5cdTAwMWLvo1x1MDAxYb266W3xrSPavp9+y7O2N3jBtlx0OfXh2N5cdTAwMDBcdTAwMDQvKVjjXHUwMDFlvVx1MDAxY+5cdTAwMWTBXHUwMDFhXHUwMDAyxlx1MDAxM1xcXG4tjN3NXHUwMDExMnlNJVx0On+SSUNcdTAwMTGwxpHXnGN7g1X+pFxi4kfze3SUUWqILbhwgFmQwmCN1cbozZTt0lEuZTqi/oxgzcfOerVcdTAwMTfc/NpZsm1cdTAwMGWeINFs1GZ2N8pcdN+0z/nt/uX+6ectObwlMNj9Rnlvbl63ppgnUFx1MDAwNNBccleGXHUwMDAwz20wXGJcdTAwMWXKXHUwMDE1mj+IYPrMXHJcdTAwMDZXtP7Ypqcw//Hl9Vx1MDAwYsLYivl8ztRiQlx1MDAxNi+1lIBe9dR9r07rl6dicFTzhzs9df35OHz3flx1MDAxZFx1MDAwZa7fgNbnoF+tRUrUX0S/7l7OQ79gpCeE3fmTMVx0JFsyqiT1uNLooXM0yJVjR18t7FJLNCUkOjDuXFzJin6LoFidn37t5qmacEGd5Vx1MDAwYjRHylx1MDAxM/olVGqdToKVRL/K5m5Kod+dTmPscy9cdTAwMDP3PkF0hdyb70M5xDtbXHUwMDA1zcybcGVmkq6WXHUwMDFlS0HbYVlcdTAwMTPwXHUwMDE0aDzLre0tmGPRXHUwMDA32t7KrqCnlnq53UN4qbC+RMmTs/mxTo3RNnnt3E6oeFx1MDAwNaVcdTAwMDSFPjMpO5LGtTHyj4+krVx1MDAxN4vj+HReXHUwMDEykyfm2Li03MlsfVF5XCJ3QnF07Tp4iWav5smyrPGA2FRcdTAwMDM1imhOOMe+XHTXXGKVnzqZ7X3M6lx1MDAxMc12KJ9cdTAwMGIqtz9/6szJ7NjOzHU+RsDMMCnaZFwiXHUwMDE1M3Es55PMY4RcdTAwMWJkcY3/567lfFx1MDAwNFxyP2qNXHUwMDA3tOtcdTAwMTRcdTAwMThNklx1MDAxNMxKs09p9vP5NbtcdTAwMDJbepT+8kgqSVK8X4bh1j3WquRcdTAwMWHUcVxiMLXA6I9T7YXyOL4/J4lvodmfr1x1MDAwN5dVs8/ePnOl2cvS7LM3JZ6p2UGxmbt7o2bXqc1+85pdKc8wTYExgSyRXiqSUuxM4Vx1MDAxNFx1MDAxMkFcYrVbI5iVyV6g2C9cdTAwMTYw2UEybez6eYdml8VrOClQ+11cdTAwMTVRvmZ/7lx1MDAwN1x1MDAwMMrV7IXyOD6bXHUwMDE3xbfQ7M/Xg8uq2Wd//eBcdM1cdTAwMGV281qNjqPdk2t6goitlFx1MDAxZX/zXHUwMDA3z1xuIdV/ebXThVxiblx1MDAxYs1vXHUwMDE3/cvNnfU9XHUwMDFhxmfqtp/X7EXlXHJcbu1ywaiw31x1MDAxZlx1MDAxNGiaTyt3++FANOi1XHUwMDA0XHUwMDAynKTT46tNbV5Z0X9xK/qFKlx1MDAxZIz9nKTza2uU8MLwLKWaSaK4fsM1nSbw96DfXHUwMDFhtM56XHUwMDA3V7fD+MNcdTAwMDd6Z1x1MDAxNvtcdTAwMTah3YinpNJcdTAwMDF3a3KYyucuNFNcdTAwMWUxljlcdTAwMDR6u5D6XHUwMDE2xlx1MDAwM5zQSVx1MDAwNoN+XHUwMDEzamy7jaurglB5dmtcdTAwMDEgXHUwMDA0XVx1MDAwYrPa1Obh6DMx5C9SSiBcdTAwMDFcdTAwMDdcdTAwMWOc3+2kJP8tlORTXHScXHUwMDE5o8s3l8DuvyFcdTAwMTZcdTAwMTDoRD5cdTAwMWYzXHUwMDAxh2G9XHUwMDE3VZGdeod+x28ux77NT/BVNpsxo1x1MDAwZlx1MDAwYmczfnhUIGt+t3tcdTAwMTLjaE/0KVxuWNjIjMfDsTjoJmMxPnRcdTAwMTg1gp2Of9nOjvzabVx1MDAxOFxmN1x1MDAxZHx0Nf6x2mysbiyWgrEu//2H3/9cdTAwMDOkXHKZXHUwMDAzIn0=IPSec TunnelInternal Loadbalancer(HTTPs, self-signed)VPN GatewayExternalLoadbalancerCloud Router(34.35.36.37)🌍 InternetExternal Services(IP Whitelist)DNS RecordsOn-PremVPN GatewayOn-PremEndpointMicroPowerManager \ No newline at end of file diff --git a/docs/installation/network.md b/docs/installation/network.md new file mode 100644 index 000000000..903f874b7 --- /dev/null +++ b/docs/installation/network.md @@ -0,0 +1,37 @@ +--- +order: 4 +--- + +# Network considerations and topology + +![Network topology](images/network_topology.excalidraw.svg) + +**External Loadbalancer:** + +The external loadbalancer is the most basic (and arguably important) piece of the network. +It implements a consistent interface to incomming traffic from the outside world. + +It is generally recommend to assign it a static IP. +This is IP is what is registered in DNS Records (A-Records). + +It is the first touch point for all third party initiated traffic. +Hence it is accessed by + +- Users +- Incomming Webhooks +- Any sort of Rest API based communication + +**Cloud Router:** + +The internals of a Coud setup might be quite complex. + +As result, by default, outgoing traffic might not have transparent IP address. + +Most of the time this is not a problem at all. + +However, some third party services might rely on IP-Whitelisting. + +This applies to MPM-initiated communication. +For example sending emails via a third party service. + +\*\*