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
Copy file name to clipboardExpand all lines: docs/universal-gateway/overview.mdx
+20-31Lines changed: 20 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,15 @@ The Universal Gateway is a flexible and composable platform that can be used wit
13
13
You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices.
14
14
It's globally distributed by default and provides support across multiple environments with minimal configuration.
15
15
16
-
:::tip
17
-
Check out the [front door pattern](/universal-gateway/examples/front-door-pattern/) in the [examples collection](/universal-gateway/examples/) to see one of the most common use cases.
18
-
:::
16
+
## Common use cases
17
+
18
+
Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/):
19
+
20
+
-[**The front door pattern**](/universal-gateway/examples/front-door-pattern/): A single public endpoint serves as the centralized entrance to all upstream services.
21
+
-[**Route to endpoints by geography**](/universal-gateway/examples/route-by-geography/): Forward requests based on IP geolocation data for improved latency or country-specific features.
22
+
-[**Create identity-based rate limits**](/universal-gateway/examples/pre-tier-requests/): Pre-tier requests based on your packaging or pricing model.
23
+
-[**Secure a public Minecraft server**](/universal-gateway/examples/minecraft/): Restrict server access to a specific set of IP addresses.
24
+
-[**Intercept and rewrite headers**](/universal-gateway/examples/rewrite-headers-redirects/): Intercept 302 redirect headers to preserve UX and agent behavior.
19
25
20
26
## Universal Gateway features
21
27
@@ -30,44 +36,27 @@ Learn more in the [Traffic Policy documentation](/docs/traffic-policy/).
30
36
31
37
### Kubernetes Operator
32
38
33
-
The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments.
34
-
It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources.
35
-
36
-
You should use the ngrok Kubernetes Operator if you want to:
39
+
ngrok's Kubernetes Operator is the best way to build with the Universal Gateway if your applications run in Kubernetes environments.
40
+
It comes with custom resources for configuration and also supports both ingress resources as well as cross-platform Gateway API configuration resources.
41
+
You can use the Operator to integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok.
37
42
38
-
Send traffic to your Kubernetes workloads
39
-
Integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok
40
-
Perform cross-cluster networking
41
-
Use Kubernetes with ngrok without using ngrok's SDKs
43
+
Learn more in the [Kubernetes Operator documentation](/docs/obs/).
42
44
43
-
### Traffic Observability
45
+
### Traffic observability
44
46
45
-
#### Traffic Inspector
47
+
The Universal Gateway provides several options for observing the traffic flowing through your endpoints, including the Traffic Inspector and ngrok's event logging system.
48
+
With Traffic Inspector, you can choose to capture full request and response bodies or just metadata, and replay requests against your endpoints for easy debugging replication.
49
+
With ngrok's event logging system, you can subscribe to events triggered whenever traffic transits through your endpoints, and publish them to destinations such as AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, and Azure Monitor.
46
50
47
-
Traffic Inspector gives you a view into the HTTP traffic flowing through the endpoints in your account. You can choose whether Traffic Inspector captures only request metadata or full request and response bodies. You can even replay requests against your endpoints for easy debugging replication.
48
-
49
-
#### Log exporting
50
-
51
-
Whenever changes occur in your ngrok account or when traffic transits through your endpoints, an event is fired. You may subscribe to these events and publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, Azure Monitor and more.
51
+
Learn more in the [traffic observability documentation](/docs/k8s/).
52
52
53
53
### Identify and access management
54
54
55
55
ngrok includes a robust identity and access management (IAM) system.
56
-
ngrok's IAM functionality enables you to:
56
+
With ngrok's IAM functionality, you can manage credentials for human users and automated processes; record all changes by principal in audit logs; configure single sign-on (SS0); and more.
57
57
58
-
- Issue, rotate and revoke unique credentials for each principal in your account (either a human user or an automated process).
59
-
- Enforce least-privilege access for each principal acting within your ngrok account
60
-
- Attribute all mutations to distinct principals in your ngrok account recorded in audit logs
61
-
- Configure single sign-on (SSO) to federate identity and SCIM to enable provisioning from your own IdP
62
-
- Administrate multiple ngrok accounts with a single user
58
+
Learn more in the [IAM documentation](/docs/iam/).
63
59
64
-
## Common use cases
65
-
66
-
-[**The front door pattern**](/universal-gateway/examples/front-door-pattern/): A single public endpoint serves as the centralized entrance to all upstream services.
67
-
-[**Route to endpoints by geography**](/universal-gateway/examples/route-by-geography/): Forward requests based on IP geolocation data for improved latency or country-specific features.
68
-
-[**Create identity-based rate limits**](/universal-gateway/examples/pre-tier-requests/): Pre-tier requests based on your packaging or pricing model.
69
-
-[**Secure a public Minecraft server**](/universal-gateway/examples/minecraft/): Restrict server access to a specific set of IP addresses.
70
-
-[**Intercept and rewrite headers**](/universal-gateway/examples/rewrite-headers-redirects/): Intercept 302 redirect headers to preserve UX and agent behavior.
0 commit comments