From f2c3c26a9c4832a39c96aebeab84823694728c6d Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Mon, 12 Feb 2024 15:53:15 +0000 Subject: [PATCH] fix(docs): remove inline mermaid diagrams --- docs/images/networking/stun1.svg | 1 + docs/images/networking/stun2.1.svg | 1 + docs/images/networking/stun2.2.svg | 1 + docs/images/networking/stun3.svg | 1 + docs/networking/stun.md | 88 ++---------------------------- 5 files changed, 10 insertions(+), 82 deletions(-) create mode 100644 docs/images/networking/stun1.svg create mode 100644 docs/images/networking/stun2.1.svg create mode 100644 docs/images/networking/stun2.2.svg create mode 100644 docs/images/networking/stun3.svg diff --git a/docs/images/networking/stun1.svg b/docs/images/networking/stun1.svg new file mode 100644 index 0000000000000..9767515c6bac2 --- /dev/null +++ b/docs/images/networking/stun1.svg @@ -0,0 +1 @@ +
Private Network
Client Workstation
192.168.21.47:38297
Workspace Agent
192.168.21.147:41563
 \ No newline at end of file diff --git a/docs/images/networking/stun2.1.svg b/docs/images/networking/stun2.1.svg new file mode 100644 index 0000000000000..2dc60789b89f1 --- /dev/null +++ b/docs/images/networking/stun2.1.svg @@ -0,0 +1 @@ +
Network B
Public Internet
Network A
[I see 12.34.56.7:41563]
[I see 65.4.3.21:29187]
Workspace agent
10.21.43.241:56812
NAT
??.??.??.??:?????
STUN server
Client workstation
192.168.1.101:38297
NAT
??.??.??.??:?????
 \ No newline at end of file diff --git a/docs/images/networking/stun2.2.svg b/docs/images/networking/stun2.2.svg new file mode 100644 index 0000000000000..07880c9f39090 --- /dev/null +++ b/docs/images/networking/stun2.2.svg @@ -0,0 +1 @@ +
Network B
Network A
[12.34.56.7:41563]
[10.21.43.241:56812]
[12.34.56.7:41563]
[12.34.56.7:41563]
Workspace agent
10.21.43.241:56812
NAT
12.34.56.7:41563
Client workstation
192.168.1.101:38297
NAT
65.4.3.21:29187
Public Internet
 \ No newline at end of file diff --git a/docs/images/networking/stun3.svg b/docs/images/networking/stun3.svg new file mode 100644 index 0000000000000..2b4c423a7cf1f --- /dev/null +++ b/docs/images/networking/stun3.svg @@ -0,0 +1 @@ +
Corp Network 172.16.1.0/24
Public Internet
Home Network
Cluster Network 10.11.12.0/16
Corp Router/NAT
172.16.1.1
12.34.56.7
VPN exit node
172.16.1.2
Private STUN
Cluster Router/NAT
10.11.12.1
172.16.1.254
Workspace agent
10.11.12.34
Public STUN
VPN entry node
Client workstation
192.168.1.101
Home Router/NAT
65.4.3.21
 \ No newline at end of file diff --git a/docs/networking/stun.md b/docs/networking/stun.md index 761b14439f91b..ef4934f19530c 100644 --- a/docs/networking/stun.md +++ b/docs/networking/stun.md @@ -59,21 +59,14 @@ to each other. ## Examples +### 1. Direct connections without NAT or STUN + In this example, both the client and agent are located on the network `192.168.21.0/24`. Assuming no firewalls are blocking packets in either direction, both client and agent are able to communicate directly with each other's locally assigned IP address. -### 1. Direct connections without NAT or STUN - -```mermaid -flowchart LR - subgraph corpnet["Private Network\ne.g. Corp. LAN"] - A[Client Workstation\n192.168.21.47:38297] - C[Workspace Agent\n192.168.21.147:41563] - A <--> C - end -``` +![Diagram of a workspace agent and client in the same network](../images/networking/stun1.svg) ### 2. Direct connections with one layer of NAT @@ -82,49 +75,12 @@ to each other over the public Internet. Both client and agent connect to a configured STUN server located on the public Internet to determine the public IP address and port on which they can be reached. -```mermaid -flowchart LR - subgraph homenet["Network A"] - client["Client workstation\n192.168.1.101:38297"] - homenat["NAT\n??.??.??.??:?????"] - end - subgraph internet["Public Internet"] - stun1["STUN server"] - end - subgraph corpnet["Network B"] - agent["Workspace agent\n10.21.43.241:56812"] - corpnat["NAT\n??.??.??.??:?????"] - end - - client --- homenat - agent --- corpnat - corpnat -- "[I see 12.34.56.7:41563]" --> stun1 - homenat -- "[I see 65.4.3.21:29187]" --> stun1 -``` +![Diagram of a workspace agent and client in separate networks](../images/networking/stun2.1.svg) They then exchange this information through Coder server, and can then communicate directly with each other through their respective NATs. -```mermaid -flowchart LR - subgraph homenet["Network A"] - client["Client workstation\n192.168.1.101:38297"] - homenat["NAT\n65.4.3.21:29187"] - end - subgraph corpnet["Network B"] - agent["Workspace agent\n10.21.43.241:56812"] - corpnat["NAT\n12.34.56.7:41563"] - end - - subgraph internet["Public Internet"] - end - - client -- "[12.34.56.7:41563]" --> homenat - agent -- "[10.21.43.241:56812]" --- corpnat - corpnat -- "[12.34.56.7:41563]" --- internet - homenat -- "[12.34.56.7:41563]" --> internet - -``` +![Diagram of a workspace agent and client in separate networks](../images/networking/stun2.2.svg) ### 3. Direct connections with VPN and NAT hairpinning @@ -165,36 +121,4 @@ addresses on the corporate network from which their traffic appears to originate. Using these internal addresses is much more likely to result in a successful direct connection. -```mermaid -flowchart TD - subgraph homenet["Home Network"] - client["Client workstation\n192.168.1.101"] - homenat["Home Router/NAT\n65.4.3.21"] - end - - subgraph internet["Public Internet"] - stun1["Public STUN"] - vpn1["VPN entry node"] - end - - subgraph corpnet["Corp Network 172.16.1.0/24"] - corpnat["Corp Router/NAT\n172.16.1.1\n12.34.56.7"] - vpn2["VPN exit node\n172.16.1.2"] - stun2["Private STUN"] - - subgraph cluster["Cluster Network 10.11.12.0/16"] - clusternat["Cluster Router/NAT\n10.11.12.1\n172.16.1.254"] - agent["Workspace agent\n10.11.12.34"] - end - end - - vpn1 === vpn2 - vpn2 --> stun2 - client === homenat - homenat === vpn1 - homenat x-.-x stun1 - agent --- clusternat - clusternat --- corpnat - corpnat --> stun1 - corpnat --> stun2 -``` +![Diagram of a workspace agent and client over VPN](../images/networking/stun3.svg)