Skip to content

Commit fbb4da4

Browse files
committed
clean up existing content
1 parent 69159b0 commit fbb4da4

File tree

5 files changed

+44
-30
lines changed

5 files changed

+44
-30
lines changed

docs/iam/index.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,16 @@ sidebar_label: Overview
44
pagination_next: iam/users
55
---
66

7-
# Identity and Access Management
8-
9-
## Overview
10-
11-
ngrok includes a robust identity and access management (IAM) system. ngrok's
12-
IAM functionality enables you to:
7+
ngrok includes a robust identity and access management (IAM) system.
8+
ngrok's IAM functionality enables you to:
139

1410
- Issue, rotate and revoke unique credentials for each principal in your account (either a human user or an automated process).
1511
- Enforce least-privilege access for each principal acting within your ngrok account
1612
- Attribute all mutations to distinct principals in your ngrok account recorded in audit logs
1713
- Configure single sign-on (SSO) to federate identity and SCIM to enable provisioning from your own IdP
1814
- Administrate multiple ngrok accounts with a single user
1915

20-
## Concepts
16+
## Features
2117

2218
Before diving into ngrok's IAM system, it's helpful to be acquainted with the
2319
terminology and concepts ngrok uses to describe its IAM primitives.
@@ -44,3 +40,11 @@ terminology and concepts ngrok uses to describe its IAM primitives.
4440
- [**RBAC**](/iam/rbac/): Role Base Access Control is used to limit the permissions of what
4541
actions a User may take within your account.
4642
- [**Account Domain Controls**](/iam/domain-controls/): Account Domain Controls are used to create policy on Users who log in or sign up with a given email domain.
43+
44+
## Use cases
45+
46+
TK
47+
48+
## What's next
49+
50+
TK

docs/k8s/index.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,18 @@ pagination_next: k8s/how-it-works
55
---
66

77
The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments.
8-
It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you.
8+
It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources.
9+
When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you.
910

1011
The ngrok Kubernetes Operator is deployed to a cluster and allows developers to self-service endpoints to their apps and services using a shared ngrok account.
1112

1213
Check out the [how it works](/k8s/how-it-works) and [architecture](/k8s/installation/architecture) pages for more info on how the operator functions.
1314

14-
## When Should I Use The ngrok Kubernetes Operator?
15+
## Features
16+
17+
TK
18+
19+
## Use cases
1520

1621
You should use the ngrok Kubernetes Operator if you want to:
1722

@@ -20,7 +25,7 @@ You should use the ngrok Kubernetes Operator if you want to:
2025
1. Perform cross-cluster networking
2126
1. Use Kubernetes with ngrok without using ngrok's SDKs
2227

23-
## What Type of Config Can I Use With The Operator?
28+
## Configuration
2429

2530
The Operator supports its own native custom resource types, including:
2631

@@ -42,3 +47,7 @@ controller incur a cost. More details can be found on our [pricing page](https:/
4247

4348
[Kubernetes Ingress docs]: https://kubernetes.io/docs/concepts/services-networking/ingress/
4449
[Gateway API docs]: https://gateway-api.sigs.k8s.io/
50+
51+
## What's next
52+
53+
TK

docs/obs/index.mdx

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,20 @@ sidebar_label: Overview
44
pagination_next: obs/traffic-inspection
55
---
66

7-
# Traffic Observability
8-
9-
ngrok provides two powerful mechanisms that allow you to observe and introspect
10-
the network traffic flowing through your Endpoints.
11-
An in-dashboard real-time
12-
view of requests and a fully-fledged event system to export events to your own
13-
logging systems.
7+
ngrok provides two powerful mechanisms that allow you to observe and introspect the network traffic flowing through your Endpoints.
8+
An in-dashboard real-time view of requests and a fully-fledged event system to export events to your own logging systems.
149

1510
## Traffic Inspector
1611

17-
Traffic Inspector gives you a view into the HTTP traffic flowing through the
18-
endpoints in your account. You can choose whether Traffic Inspector captures
19-
only request metadata or full request and response bodies. You can even replay
20-
requests against your endpoints for easy debugging replication.
12+
Traffic Inspector gives you a view into the HTTP traffic flowing through the endpoints in your account.
13+
You can choose whether Traffic Inspector captures only request metadata or full request and response bodies.
14+
You can even replay requests against your endpoints for easy debugging replication.
2115

2216
[Get Started with Traffic Inspector →](/obs/traffic-inspection/)
2317

2418
## Log Exporting
2519

26-
Whenever changes occur in your ngrok account or when traffic transits through
27-
your endpoints, an event is fired. You may subscribe to these events and
28-
publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3,
29-
Datadog Logs, Azure Monitor and more.
20+
Whenever changes occur in your ngrok account or when traffic transits through your endpoints, an event is fired.
21+
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.
3022

3123
[Get Started with Log Exporting Events →](/obs/events/)
Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
---
22
sidebar_position: 0
3-
title: Overview
3+
title: Traffic Policy Overview
4+
sidebar_title: Overview
45
pagination_next: traffic-policy/concepts/phases
56
pagination_label: Phases
67
---
78

8-
# Traffic Policy Overview
9+
## What is Traffic Policy?
910

1011
The ngrok Traffic Policy engine enables you to manage traffic consistently across your endpoints.
1112
It allows you to inspect, manipulate, and route traffic in a structured way.
1213

14+
## Features
15+
1316
Traffic Policy is composed of a few key components:
1417

1518
- [**Phases:**](./phases) Defined points in the traffic lifecycle where you can apply logic.
@@ -18,4 +21,10 @@ Traffic Policy is composed of a few key components:
1821
- [**Actions:**](./actions) Logic that is triggered when a Phase Rule condition is met.
1922
- [**CEL Interpolation:**](./cel-interpolation) A way to dynamically evaluate variables and macros inside configuration values, such as URLs or headers.
2023

21-
By combining these components, Traffic Policy provides a powerful way to control your traffic flow at a fine-grained level.
24+
## Use cases
25+
26+
TK
27+
28+
## What's next?
29+
30+
TK

docs/universal-gateway/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Universal Gateway can be used with software running locally or in the cloud,
1313
You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices.
1414
It's globally distributed by default and provides support for multiple environments with minimal configuration.
1515

16-
## Universal Gateway features
16+
## Features
1717

1818
Here are some of the key features of the Universal Gateway platform:
1919

@@ -22,7 +22,7 @@ Here are some of the key features of the Universal Gateway platform:
2222
- [**Identity and access management**](/docs/iam/): manage credentials for human users and automated processes.
2323
- [**Kubernetes support**](/docs/k8s/): ngrok's Kubernetes Operator supports ingress resources as well as cross-platform Gateway API configuration resources.
2424

25-
## Universal Gateway use cases
25+
## Use cases
2626

2727
Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/):
2828

0 commit comments

Comments
 (0)