You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: docs/pages/reference/deployment/networking.mdx
+62-2Lines changed: 62 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
-
title: Networking
2
+
title: Teleport Networking Reference
3
3
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
4
5
tags:
5
6
- conceptual
6
7
- platform-wide
@@ -14,7 +15,66 @@ manage Agents and `tbot` instances.
14
15
This reference guide describes the networking requirements of a Teleport
15
16
cluster.
16
17
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
0 commit comments