Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zufardhiyaulhaq/ngrok-operator

Expose your service in Kubernetes to the Internet with Ngrok easily! Automatically reload ngrok sessions after expired!
https://github.com/zufardhiyaulhaq/ngrok-operator

k8s kubernetes kubernetes-operator kubernetes-tunnel ngrok ngrok-alternative ngrok-operator ngrok-tunnel operator private-kubernetes proxy tunnel

Last synced: 3 months ago
JSON representation

Expose your service in Kubernetes to the Internet with Ngrok easily! Automatically reload ngrok sessions after expired!

Host: GitHub
URL: https://github.com/zufardhiyaulhaq/ngrok-operator
Owner: zufardhiyaulhaq
License: mit
Created: 2020-07-09T18:56:29.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-03-10T12:22:37.000Z (over 1 year ago)
Last Synced: 2024-06-18T21:33:11.307Z (5 months ago)
Topics: k8s, kubernetes, kubernetes-operator, kubernetes-tunnel, ngrok, ngrok-alternative, ngrok-operator, ngrok-tunnel, operator, private-kubernetes, proxy, tunnel
Language: Go
Homepage:
Size: 248 KB
Stars: 102
Watchers: 2
Forks: 16
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        # 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](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.3.0](https://img.shields.io/badge/AppVersion-1.3.0-informational?style=flat-square) [![made with Go](https://img.shields.io/badge/made%20with-Go-brightgreen)](http://golang.org) [![Github master branch build](https://img.shields.io/github/workflow/status/zufardhiyaulhaq/ngrok-operator/Master)](https://github.com/zufardhiyaulhaq/ngrok-operator/actions/workflows/master.yml) [![GitHub issues](https://img.shields.io/github/issues/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/zufardhiyaulhaq/ngrok-operator)](https://github.com/zufardhiyaulhaq/ngrok-operator/pulls)[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/ngrok-operator)](https://artifacthub.io/packages/search?repo=ngrok-operator)

## Installing

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

```console

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

```console

kubectl apply -f examples/deployment/

kubectl apply -f examples/http/simple/

kubectl apply -f examples/http/full-configuration/

```

2. Check ngrok object

```console

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

```

3. access the URL

```console

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](https://github.com/zufardhiyaulhaq/ngrok-operator/blob/master/charts/ngrok-operator/values.yaml)

```yaml

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

```