Ingress Monitor is a Kubernetes Operator which takes care of setting up monitoring for your Kubernetes Ingress and Service objects.
This is still a WIP. The main piece currently missing is Custom Resource Definition validation and extra providers.
IngressMonitor exists out of several key components, which are each explained in their respective design docs.
The main goal for Ingress Monitor is to make it easy for teams to set up monitors without having to add special annotations. As with a lot of the Kubernetes ecosystem, this operator bases it's selection on labels.
This means that you can use your existing set of labels on your Ingresses and
do a widespread selection, which will then be used by the Operator to set up
the appropriate IngressMonitor. This is useful so that teams could for example
each add their own label team: gophers, which then has a Monitor attached to
it. This Monitor can then be configured to just alert this specific team if
something is wrong.
The second goal is to make it possible to reuse components. This is why there
are separate Provider and MonitorTemplate objects. These can be mixed and
matched within the Monitor resource, which then forms an actual monitoring
instance.
To install the Operator, make sure you have RBAC enabled in your cluster.
kubectl apply -f https://raw.githubusercontent.com/jelmersnoeck/ingress-monitor/master/docs/kube/with-rbac.yaml
There is an example installed in the examples directory. This is using StatusCake as a provider and is using kuard as the application it monitors.
This is meant to demonstrate the configuration options.
To use this, first you'll need to create an account with StatusCake and retrieve the API key.
Following that, you can set up a secret which contains your credentials:
kubectl create namespace websites
kubectl create secret generic statuscake-secrets -n websites --from-literal=username=<STATUSCAKE_USERNAME> --from-literal=apikey=<STATUSCAKE_APIKEY>
After this, you can apply the entire _examples/kuard folder:
kubectl apply -f _examples/kuard
This will set up a Provider, MonitorTemplate and Monitor along with a Deployment
which is exposed through a Service and Ingress. The Ingress has the label
team: gophers which is used by the Monitor to create an IngressMonitor.
Providers are used to indicate where we want to set up a monitor. Multiple providers are supported within one cluster. These can be referenced later on in a Monitor.
The Operator only supports a certain set of Monitoring Providers. Below we have listed these providers.
To configure StatusCake, there are 2 required arguments:
- username
- apiKey
As an optional argument, you can reference a contactGroup which will be used
to send notifications to.
All values follow the EnvVar schema, meaning you can use plaintext values or
secretKeyRef. We recommend using the secretKeyRef.
For more information about the design of this project, have a look at the design documents.