https://github.com/ionos-cloud/uptrends-operator
:chart_with_upwards_trend: Kubernetes operator to configure uptrends monitoring.
https://github.com/ionos-cloud/uptrends-operator
Last synced: 2 months ago
JSON representation
:chart_with_upwards_trend: Kubernetes operator to configure uptrends monitoring.
- Host: GitHub
- URL: https://github.com/ionos-cloud/uptrends-operator
- Owner: ionos-cloud
- License: apache-2.0
- Created: 2022-11-15T13:42:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-10T09:31:40.000Z (over 1 year ago)
- Last Synced: 2024-12-26T08:27:35.169Z (4 months ago)
- Language: Go
- Homepage: https://ionos-cloud.github.io/uptrends-operator/
- Size: 1.24 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# :chart_with_upwards_trend: uptrends Operator
[](https://github.com/ionos-cloud//uptrends-operator/actions/workflows/release.yml)
[](https://twitter.com/SwiftOnSecurity)
[](https://github.com/auchenberg/volkswagen)
This operator helps to configure [uptrends](https://www.uptrends.com/) monitoring for your [Ingress Controllers](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/).
## Introduction
The operator is based on the [uptrends](https://github.com/ionos-cloud/uptrends-go) 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](https://helm.sh/) can be used to install :chart_with_upwards_trend: uptrends Operator.
```bash
helm repo add uptrends https://ionos-cloud.github.io/uptrends-operator/
helm repo update
```
The most recent version is installed via.
```bash
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](https://www.uptrends.com/support/kb/api) documentation for more information.
### `API_PASSWORD`
This configures the required password for the uptrends API access. See the [uptrends](https://www.uptrends.com/support/kb/api) 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](/examples/) contains the example of an `Ingress` and `Uptrends` based monitor.
> Renaming the ingress does not delete monitors.
## License
[Apache 2.0](/LICENSE)