Ngrok operator provide developer easy access to private Kubernetes cluster for testing purpose via ngrok. Automate the creation of ngrok tunnel via CRD!

Feature

• support HTTP
• support TCP
• support costum configuration
  • custom domain
  • custom TCP address
  • custom region
  • enable/disable inspection
  • support HTTP auth

Installation

Please read README.md in charts folder for more information.

helm repo add zufardhiyaulhaq https://charts.zufardhiyaulhaq.com/
helm install zufardhiyaulhaq/ngrok-operator --name-template ngrok-operator

to insatall without crds

--skip-crds

to upgrade

helm upgrade ngrok-operator zufardhiyaulhaq/ngrok-operator

Example

• Deploy ngrok via Helm
• Apply some example

kubectl apply -f examples/nginx
kubectl apply -f examples/helloworld/namespace.yaml
kubectl apply -f examples/helloworld/

• Check ngrok object

kubectl get ngrok --all-namespaces
NAMESPACE    NAME               STATUS    URL
default      nginx-ngrok        created   https://9496e56ed0bc.ngrok.io
default      nginx-ngrok-full   created   https://ngrok.zufardhiyaulhaq.com
helloworld   helloworld-ngrok   created   https://d00ba8cb0b95.ngrok.io

• access the URL

https://d5150f7c3588.ngrok.io
https://ngrok.zufardhiyaulhaq.com
https://fa03f71fbe18.ngrok.io/hello

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Zufar Dhiyaulhaq 🚇 💻

This project follows the all-contributors specification. Contributions of any kind welcome, please check CONTRIBUTING.md!

Changes

For changes, see the CHANGELOG.md.

License

This program is free software: you can redistribute it and/or modify it under the terms of the MIT license