The ngrok Kubernetes Operator exposes your Kubernetes services securely using standard Kubernetes resources like Ingress or the Gateway API. With the Operator, teams can create and manage ngrok endpoints for their apps using a shared ngrok account. Optionally, bindings let you make services running elsewhere (including your local machine or another cluster) appear inside a cluster as normal Kubernetes Services. This enables private, cross-cluster connectivity without publishing publicly accessible URLs.Documentation Index
Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Concepts
How it works
Learn how the Operator establishes secure connections and routes traffic.
Architecture
Understand the Operator’s control loops and design.
Load Balancing
Distribute traffic across multiple Kubernetes services.
Features
- Local cluster options - Set up a local Kubernetes cluster for development and testing.
- Helm configuration - Reference for Helm config values when installing the Operator.
- Observability - Monitor and observe your Operator deployment.
Use cases
Secure endpoints with OAuth
Configure OAuth authentication in Kubernetes to secure your endpoints by requiring valid OAuth tokens before forwarding requests.
Route traffic to backends
Configure request routing to direct incoming traffic to the appropriate backend services based on rules.
Handle TLS traffic
Configure TLS routing in Kubernetes to handle encrypted traffic using SNI-based routing with optional TLS termination.
Protect services with rate limiting
Configure rate limiting in Kubernetes to protect your services from excessive traffic and ensure fair usage across clients.
What’s next?
- Get started with Ingress, Gateway API, Custom Resources, or Endpoints.
- Explore the guides for common use cases and configurations.