ngrok-operator

ngrok Kubernetes Operator

Leverage ngrok for your ingress in your Kubernetes cluster. Instantly add load balancing, authentication, and observability to your services via ngrok Cloud Edge modules using Custom Resource Definitions (CRDs) and Kubernetes-native tooling. This repo contains both our Kubernetes Ingress Controller and the Kubernetes Gateway API

Installation | Getting Started | Documentation | Developer Guide | Known Issues

Note

The ngrok-operator is production-ready and supported for use in production environments. However, it is currently pre-1.0.0, and as such, the public API (including helm values and CRDs) should be considered unstable.

While we aim to minimize disruption, breaking changes may be introduced in minor or patch releases prior to the 1.0.0 release. Users are encouraged to pin versions and review release notes when upgrading.

Installation

Helm

Note We recommend using the Helm chart to install the operator for a better upgrade experience.

Add the ngrok Kubernetes Operator Helm chart:

helm repo add ngrok https://charts.ngrok.com

Then, install the latest version (setting the appropriate values for your environment):

export NAMESPACE=[YOUR_K8S_NAMESPACE]
export NGROK_ACCESS_TOKEN=[PERSONAL_ACCESS_TOKEN]

helm install ngrok-operator ngrok/ngrok-operator \
  --namespace $NAMESPACE \
  --create-namespace \
  --set credentials.accessToken=$NGROK_ACCESS_TOKEN

** Note ** You can create an access token in your ngrok dashboard. The ngrok Kubernetes Operator uses it to authenticate with ngrok and configure and run your network ingress traffic at the edge.

For a more in-depth installation guide follow our step-by-step Getting Started guide.

Gateway API

To enable using the ngrok-operator with the Kubernetes Gateway API, you need to install the Gateway CRDs if you haven't already, and then include ngrok.features.gateway.enabled in your helm --set or values.yaml.

See the Kubernetes Gateway API Quickstart for setup and installation steps.

YAML Manifests

Apply the sample combined manifest from our repo:

kubectl apply -n ngrok-operator \
  -f https://raw.githubusercontent.com/ngrok/ngrok-operator/main/manifest-bundle.yaml

For a more in-depth installation guide follow our step-by-step Getting Started guide.

Documentation

The full documentation for the ngrok Kubernetes Operator can be found on our k8s docs

Uninstalling

For guidance on safely uninstalling the operator, including cleanup of ngrok API resources and finalizers, see the Uninstall Guide.

Known Issues

1. Current issues can be found in the GitHub issues. Known/suspected bugs are labeled as bug.

Support

The best place to get support using the ngrok Kubernetes Operator is by opening an issue. For account or billing questions, contact ngrok support. If you find bugs or would like to contribute code, please follow the instructions in the contributing guide.

License

The ngrok Kubernetes Operator is licensed under the terms of the MIT license.

See LICENSE for details.