uptrends-operator

README

📈 uptrends Operator

This operator helps to configure uptrends monitoring for your Ingress Controllers.

Introduction

The operator is based on the uptrends package. It is a Kubernetes operator that watches for Ingress resources and creates uptrends checks for them. It also watches for changes in the Ingress resources and updates the uptrends checks accordingly.

Helm

Helm can be used to install 📈 uptrends Operator.

helm repo add uptrends https://ionos-cloud.github.io/uptrends-operator/
helm repo update

The most recent version is installed via.

helm install uptrends uptrends/uptrends --create-namespace --namespace uptrends --version v0.1.11

The required API_USERNAME and API_PASSWORD can be securely configured via envFrom in the values.yaml.

Environment

API_USERNAME

This configures the required username for the uptrends API access. See the uptrends documentation for more information.

API_PASSWORD

This configures the required password for the uptrends API access. See the uptrends documentation for more information.

Annotations

The operator supports creating a monitor via the Uptrends kind, but also via annotations on an Ingress.

The operator will create an uptrend in case the ingress has this annotation: uptrends.ionos-cloud.github.io/monitor: "true", otherwise the ingress will not be monitored.

The following keys are supported:

uptrends.ionos-cloud.github.io/monitor.type Default: HTTPS

This can be either HTTPS or HTTP.

uptrends.ionos-cloud.github.io/monitor.interval Default: "5"

This can be an interval from 1 to 60 minutes.

The annotations are evaluates agains the host fields on the rules. Wildcard hosts and empty hosts are ignored.

uptrends.ionos-cloud.github.io/monitor.guid Default: ""

This can be used to add the monitor to a Monitor Group identified with a MonitorGroupID.

uptrends.ionos-cloud.github.io/monitor.regions Default:""

This is a list of regions to include as checkpoints. An example "54,1007"

uptrends.ionos-cloud.github.io/monitor.checkpoints Default:""

This is a list of point of presence to include.

uptrends.ionos-cloud.github.io/monitor.exclude Default: ""

This is a list of point of presence to exclude as checkpoints.

Examples

/examples contains the example of an Ingress and Uptrends based monitor.

Renaming the ingress does not delete monitors.

License

Apache 2.0