Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngrok/kubernetes-ingress-controller
The official ngrok Ingress Controller for Kubernetes
https://github.com/ngrok/kubernetes-ingress-controller
ingress-controller kubernetes ngrok reverse-proxy
Last synced: 2 months ago
JSON representation
The official ngrok Ingress Controller for Kubernetes
- Host: GitHub
- URL: https://github.com/ngrok/kubernetes-ingress-controller
- Owner: ngrok
- License: mit
- Archived: true
- Fork: true (ngrok/ngrok-operator)
- Created: 2024-09-06T03:56:37.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T14:41:26.000Z (4 months ago)
- Last Synced: 2024-09-14T13:33:39.703Z (4 months ago)
- Language: Go
- Homepage: https://ngrok.com
- Size: 2.19 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
Awesome Lists containing this project
- awesome-repositories - ngrok/kubernetes-ingress-controller - The official ngrok Ingress Controller for Kubernetes (Go)
README
)
# ngrok Kubernetes Operator
Leverage [ngrok](https://ngrok.com/) 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](https://kubernetes.io/docs/concepts/services-networking/ingress/) and the [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/)
[Installation](#installation) | [Getting Started](https://ngrok.com/docs/using-ngrok-with/k8s/) | [Documentation](#documentation) | [Developer Guide](https://github.com/ngrok/kubernetes-ingress-controller/blob/main/docs/developer-guide/README.md) | [Known Issues](#known-issues)
## Installation
### Helm
> **Note** We recommend using the Helm chart to install the controller for a better experience for upgrades.
Add the ngrok Ingress Controller Helm chart:
```sh
helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller
```
Then, install the latest version (setting the appropriate values for your environment):
```sh
export NAMESPACE=[YOUR_K8S_NAMESPACE]
export NGROK_AUTHTOKEN=[AUTHTOKEN]
export NGROK_API_KEY=[API_KEY]
helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
--namespace $NAMESPACE \
--create-namespace \
--set credentials.apiKey=$NGROK_API_KEY \
--set credentials.authtoken=$NGROK_AUTHTOKEN
```
> **Note** The values for `NGROK_API_KEY` and `NGROK_AUTHTOKEN` can be found in your [ngrok dashboard](https://dashboard.ngrok.com/get-started/setup) and are used by your ingress controller to authenticate with ngrok for configuring and running your network ingress traffic at the edge.
For a more in-depth installation guide follow our step-by-step [Getting Started](https://ngrok.com/docs/using-ngrok-with/k8s/) guide.
#### Gateway API Preview
To install the developer preview of the gateway api we'll make the following changes to the above instructions.
Install the v1 gateway CRD before the helm installation.
```sh
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
```
Then, during the helm install set the experimental gateway flag.
```sh
helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
--namespace $NAMESPACE \
--create-namespace \
--set credentials.apiKey=$NGROK_API_KEY \
--set credentials.authtoken=$NGROK_AUTHTOKEN \
--set useExperimentalGatewayApi=true # gateway preview
```
### YAML Manifests
Apply the [sample combined manifest](manifest-bundle.yaml) from our repo:
```sh
kubectl apply -n ngrok-ingress-controller \
-f https://raw.githubusercontent.com/ngrok/kubernetes-ingress-controller/main/manifest-bundle.yaml
```
For a more in-depth installation guide follow our step-by-step [Getting Started](https://ngrok.com/docs/using-ngrok-with/k8s/) guide.
## Documentation
The full documentation for the ngrok Ingress Controller can be found on our [k8s docs](https://ngrok.com/docs/k8s/)
## Known Issues
> **Note**
>
> This project is currently in beta as we continue testing and receiving feedback. The functionality and CRD contracts may change. It is currently used internally at ngrok for providing ingress to some of our production workloads.
1. Current issues of concern for production workloads are being tracked [here](https://github.com/ngrok/kubernetes-ingress-controller/issues/208) and [here](https://github.com/ngrok/kubernetes-ingress-controller/issues/219).
## Support
The best place to get support using the ngrok Kubernetes Operator is through the [ngrok Slack Community](https://ngrok.com/slack). If you find bugs or would like to contribute code, please follow the instructions in the [contributing guide](./docs/developer-guide/README.md).
## License
The ngrok ingress controller is licensed under the terms of the MIT license.
See [LICENSE](./LICENSE.txt) for details.