Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stakater/IngressMonitorController
A Kubernetes controller to watch ingresses and create liveness alerts for your apps/microservices in UptimeRobot, StatusCake, Pingdom, etc. – [✩Star] if you're using it!
https://github.com/stakater/IngressMonitorController
controller hacktoberfest helm helm-charts ingress isup k8s kubernetes live monitor openshift pingdom stakater statuscake uptime-checker uptimerobot
Last synced: 10 days ago
JSON representation
A Kubernetes controller to watch ingresses and create liveness alerts for your apps/microservices in UptimeRobot, StatusCake, Pingdom, etc. – [✩Star] if you're using it!
- Host: GitHub
- URL: https://github.com/stakater/IngressMonitorController
- Owner: stakater
- License: apache-2.0
- Created: 2018-02-21T05:18:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T10:11:47.000Z (7 months ago)
- Last Synced: 2024-04-22T12:02:48.562Z (7 months ago)
- Topics: controller, hacktoberfest, helm, helm-charts, ingress, isup, k8s, kubernetes, live, monitor, openshift, pingdom, stakater, statuscake, uptime-checker, uptimerobot
- Language: Go
- Homepage: https://stakater.com
- Size: 70.5 MB
- Stars: 545
- Watchers: 11
- Forks: 102
- Open Issues: 79
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
#  Ingress Monitor Controller
An operator to watch ingresses/routes and create liveness alerts for your apps/microservices in Uptime checkers.
[](https://stakater.com/?utm_source=IngressMonitorController&utm_medium=github)
## Problem Statement
We want to monitor ingresses in a kubernetes cluster and routes in openshift cluster via any uptime checker but the problem is having to manually check for new ingresses or routes / removed ingresses or routes and add them to the checker or remove them.
## Solution
This operator will continuously watch ingresses/routes based on defined `EndpointMonitor` custom resource, and
automatically add / remove monitors in any of the uptime checkers. With the help of this solution, you can keep a check
on your services and see whether they're up and running and live, without worrying about manually registering them on
the Uptime checker.
## Supported Uptime Checkers
Currently we support the following monitors:
- [UptimeRobot](https://uptimerobot.com) ([Additional Config](docs/uptimerobot-configuration.md))
- [Pingdom](https://pingdom.com) ([Additional Config](docs/pingdom-configuration.md)) (Not fully tested)
- [StatusCake](https://www.statuscake.com) ([Additional Config](docs/statuscake-configuration.md))
- [Uptime](https://uptime.com) ([Additional Config](docs/uptime-configurations.md))
- [Updown](https://updown.io/) ([Additional Config](docs/updown-configuration.md))
- [Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/monitor-web-app-availability) ([Additional Config](docs/appinsights-configuration.md))
- [gcloud](https://cloud.google.com/monitoring/uptime-checks) ([Additional Config](docs/gcloud-configuration.md))
- [Grafana](https://grafana.com/grafana/plugins/grafana-synthetic-monitoring-app/) ([Additional Config](docs/grafana-configuration.md))
## Usage
### Adding configuration
Configure the uptime checker configuration in the `config.yaml` based on your uptime provider. Add create a secret
`imc-config` that holds `config.yaml` key:
```yaml
kind: Secret
apiVersion: v1
metadata:
name: imc-config
data:
config.yaml: >-
type: Opaque
```
#### Configuration Parameters
Following are the available options that you can use to customize the controller:
| Key | Description |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| providers | An array of uptime providers that you want to add to your controller |
| enableMonitorDeletion | A safeguard flag that is used to enable or disable monitor deletion on ingress deletion (Useful for prod environments where you don't want to remove monitor on ingress deletion) |
| resyncPeriod | Resync period in seconds, allows to re-sync periodically the monitors with the Routes. Defaults to 0 (= disabled) |
| creationDelay | CreationDelay is a duration string to add a delay before creating new monitor (e.g., to allow DNS to catch up first) |
| monitorNameTemplate | Template for monitor name eg, `{{.Namespace}}-{{.Name}}` |
- Replace `BASE64_ENCODED_CONFIG.YAML` with your config.yaml file that is encoded in base64.
- For detailed guide for the configuration refer to [Docs](./docs) and go through configuration guidelines for your uptime provider.
- For sample `config.yaml` files refer to [Sample Configs](examples/configs).
- Name of secret can be changed by setting environment variable `CONFIG_SECRET_NAME`.
### Add EndpointMonitor
`EndpointMonitor` resource can be used to manage monitors on static urls or route/ingress references.
- Specifying url:
```yaml
apiVersion: endpointmonitor.stakater.com/v1alpha1
kind: EndpointMonitor
metadata:
name: stakater
spec:
forceHttps: true
url: https://stakater.com
```
- Specifying route reference:
```yaml
apiVersion: endpointmonitor.stakater.com/v1alpha1
kind: EndpointMonitor
metadata:
name: frontend
spec:
forceHttps: true
urlFrom:
routeRef:
name: frontend
```
- Specifying ingress reference:
```yaml
apiVersion: endpointmonitor.stakater.com/v1alpha1
kind: EndpointMonitor
metadata:
name: frontend
spec:
forceHttps: true
urlFrom:
ingressRef:
name: frontend
```
NOTE: For provider specific additional configuration refer to [Docs](./docs) and go through configuration guidelines for your uptime provider.
## Deploying the Operator
The following quickstart let's you set up Ingress Monitor Controller to register uptime monitors for endpoints:
## Helm Chart
If you have configured helm on your cluster, you can deploy IngressMonitorController via helm using below mentioned commands. For details on chart, see [IMC Helm Chart](https://github.com/stakater/IngressMonitorController/tree/master/charts/ingressmonitorcontroller)
```sh
# Install CRDs
kubectl apply -f https://raw.githubusercontent.com/stakater/IngressMonitorController/master/charts/ingressmonitorcontroller/crds/endpointmonitor.stakater.com_endpointmonitors.yaml
# Install chart
helm repo add stakater https://stakater.github.io/stakater-charts
helm repo update
helm install stakater/ingressmonitorcontroller
```
## Vanilla Manifests
1. Clone this repository
```terminal
$ git clone [email protected]:stakater/IngressMonitorController.git
```
2. Deploy dependencies(crds):
```terminal
$ make deploy
```
### Environment Variables
| Key | Default | Description |
| ------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| WATCH_NAMESPACE | Namespace in which operator is deployed | Use comma separated list of namespaces or leave the field empty to watch all namespaces(cluster scope) |
| CONFIG_SECRET_NAME | imc-config | Name of secret that holds the configuration |
| REQUEUE_TIME | 300 seconds | Integer value to specify number of seconds after which the resource should be reconciled again |
## Help
### Documentation
You can find more detailed documentation for configuration, extension, and support for other Uptime checkers etc. [here](https://github.com/stakater/IngressMonitorController/tree/master/docs)
### Contributing
If you'd like to contribute any fixes or enhancements, please refer to the documentation [here](CONTRIBUTING.md)
### Have a question?
File a GitHub [issue](https://github.com/stakater/IngressMonitorController/issues).
### Talk to us on Slack
Join and talk to us on the #tools-ingressmonitor channel for discussing the Ingress Monitor Controller
[](https://slack.stakater.com/)
[](https://stakater-community.slack.com/messages/CA66MMYSE)
## Known Issues
- Latest image of kube-rbac-proxy fails on openshift with permission issues. To resolve use `registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.7.0` instead of kube-rbac-proxy. This issue can be tracked [here](https://github.com/operator-framework/operator-sdk/issues/4684).
## License
Apache2 © [Stakater][website]
## About
The `IngressMonitorController` is maintained by [Stakater][website]. Like it? Please let us know at
See [our other projects](https://github.com/stakater)
or contact us in case of professional services and queries on
[website]: https://stakater.com/
## Contributors
Stakater Team and the Open Source community! :trophy: