Skip to content

Commit 13372a1

Browse files
committed
Add diagram and overview to Networking Reference
See #62997 Make it easier for users to follow the Networking Reference by adding a brief architectural oververview and diagram. The diagram makes use of the built-in Docusaurus support for MermaidJS diagrams, which we enabled in gravitational/docs-website#552.
1 parent 3622a40 commit 13372a1

1 file changed

Lines changed: 62 additions & 2 deletions

File tree

docs/pages/reference/deployment/networking.mdx

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: Networking
2+
title: Teleport Networking Reference
33
description: This reference explains the networking requirements of a Teleport cluster, including its public address, ports, and support for HTTP CONNECT proxies.
4+
sidebar_label: Networking
45
tags:
56
- conceptual
67
- platform-wide
@@ -14,7 +15,66 @@ manage Agents and `tbot` instances.
1415
This reference guide describes the networking requirements of a Teleport
1516
cluster.
1617

17-
## Public address
18+
## Architecture overview
19+
20+
A Teleport cluster is a distributed system consisting of components that can run
21+
in both public and private networks. Teleport also supports fully air-gapped
22+
environments.
23+
24+
The **Teleport Auth Service**, which manages backend data and issues
25+
certificates, typically runs in a private network. The **Teleport Proxy
26+
Service** should be the only component of your Teleport cluster that is
27+
addressable from the public internet, and can run in a private network as long
28+
as end-users can dial it.
29+
30+
We expect all other components, including Teleport Agents and Machine & Workload
31+
ID Bots, to run in private networks. Components in private networks connect to
32+
the Teleport Proxy Service and establish reverse tunnels that the Proxy Service
33+
uses to communicate with them.
34+
35+
For a comprehensive explanation of how a Teleport cluster works, see [Teleport
36+
Architecture](../architecture/architecture.mdx). For a glossary of terms, see
37+
[Core Concepts](../../core-concepts.mdx).
38+
39+
```mermaid
40+
architecture-beta
41+
42+
%% Networks
43+
group public_net(carbon-network-public)[Public Internet]
44+
group dmz_net(carbon-network-public)[DMZ or Public Subnet]
45+
group private_net(carbon-virtual-private-cloud)[Private Network]
46+
group private_net2(carbon-virtual-private-cloud)[Private Network]
47+
48+
%% Services
49+
service user(carbon-user)[User] in public_net
50+
service proxy(teleport-logo-purple)[Teleport Proxy Service] in dmz_net
51+
service auth(teleport-logo-purple)[Teleport Auth Service] in private_net2
52+
service ssh_node(carbon-bare-metal-server)[SSH Nodes] in private_net
53+
service db(carbon-db2-database)[Databases] in private_net
54+
service agent(teleport-logo-purple)[Teleport Agents] in private_net
55+
service k8s(logos-kubernetes)[Kubernetes Clusters] in private_net
56+
service windows(carbon-virtual-desktop)[Windows Desktops] in private_net
57+
service webapp(carbon-code)[Web Applications] in private_net
58+
59+
%% Connections
60+
junction agentconn in private_net
61+
junction agentconn2 in private_net
62+
63+
user:B --> T:proxy
64+
65+
agent:L --> R:proxy
66+
auth:T --> B:proxy
67+
68+
agent:R -- L:agentconn
69+
agentconn:T --> B:ssh_node
70+
agentconn:B --> T:db
71+
agentconn2:L -- R:agentconn
72+
agentconn2:T --> B:k8s
73+
agentconn2:B --> T:windows
74+
agentconn2:R --> L:webapp
75+
```
76+
77+
## Public addresses
1878

1979
<Tabs>
2080
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">

0 commit comments

Comments
 (0)