Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 2.89 KB

README.md

File metadata and controls

68 lines (55 loc) · 2.89 KB
Raw

ngrok-operator

Ngrok operator provide developer easy access to private Kubernetes cluster for testing purpose via ngrok. Automate the creation of ngrok tunnel via CRD and automatically reload ngrok session when expired!

Version: 1.1.0 Type: application AppVersion: 1.3.0 made with Go Github master branch build GitHub issues GitHub pull requestsArtifact Hub

Installing

To install the chart with the release name my-ngrok-operator:

helm repo add ngrok-operator https://zufardhiyaulhaq.com/ngrok-operator/charts/releases/
helm install my-ngrok-operator ngrok-operator/ngrok-operator --values values.yaml

Usage

  1. Apply some example
kubectl apply -f examples/deployment/
kubectl apply -f examples/http/simple/
kubectl apply -f examples/http/full-configuration/
  1. Check ngrok object
kubectl get ngrok --all-namespaces
NAMESPACE    NAME                       STATUS    URL
default      http-simple                created   https://9496e56ed0bc.ngrok.io
default      http-full-configuration    created   https://ngrok.zufardhiyaulhaq.com
  1. access the URL
https://d5150f7c3588.ngrok.io
https://ngrok.zufardhiyaulhaq.com

Values

Key Type Default Description
operator.image string "zufardhiyaulhaq/ngrok-operator"
operator.replica int 1
operator.tag string "v1.3.0"
resources.limits.cpu string "200m"
resources.limits.memory string "100Mi"
resources.requests.cpu string "100m"
resources.requests.memory string "20Mi"

see example files here

operator:
  # image of ngrok-operator
  image: "zufardhiyaulhaq/ngrok-operator"
  # tag of ngrok-operator image
  tag: "v1.3.0"
  # number of replica for deployment
  replica: 1

resources:
  limits:
    cpu: 200m
    memory: 100Mi
  requests:
    cpu: 100m
    memory: 20Mi