Kubernetes Operator
Overview
The Kubernetes Ingress Controller within the ngrok Kubernetes Operator allows access to Kubernetes Services using Kubernetes Ingress CRDs. More details on how these are derived is described in the guide to edges in k8s.
Other ngrok features such as TCP Edges can be configured via CRDs.
If you are looking to install the controller for the first time, see our deployment-guide. If it's already installed and you are looking to configure ingress for an app or service, see our user-guide.
Install
Installing the ngrok Kubernetes Operator is easy using Helm.
Add the ngrok Kubernetes Operator repo to Helm:
Loading…
Install the ngrok Kubernetes Operator:
Loading…
Create an edge with a domain
This would create an Edge on with the Domain example.ngrok.app that routes traffic to the Kubernetes service example-service running on port 80.
Loading…
Route Traffic based on a path
This would create an Edge on with the Domain example.ngrok.app that routes traffic from example.ngrok.app/foo to the Kubernetes service example-service running on port 80.
Loading…
Modify Headers
This would modify the headers to add headers for is-ngrok (set to a value of "1") and a country (based on the country code). It would also remove the referrer header.
Loading…
Redirect Traffic
Redirects are not yet supported with the ngrok Kubernetes Operator.
Pricing
The ngrok Kubernetes Operator is available to all ngrok users at no additional charge. You only incur costs if the resources provisioned by the controller incur a cost. More details can be found on our pricing page.