Skip to content

Commit

Permalink
chore(build): readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rkettelerij committed Apr 16, 2024
1 parent b031061 commit e815198
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# uptime-operator

Kubernetes Operator to watch Traefik IngressRoute(s) and register these with a (SaaS) uptime monitoring provider.
Kubernetes Operator to watch [Traefik](https://github.com/traefik/traefik) IngressRoute(s) and register these with a (SaaS) uptime monitoring provider.

## Annotations

Traefik `IngressRoute` resource should be annotated in order to successfully register an uptime check. For example:
Traefik `IngressRoute` resources should be annotated in order to successfully register an uptime check. For example:

```yaml
apiVersion: traefik.containo.us/v1alpha1
Expand All @@ -21,6 +21,8 @@ metadata:
uptime.pdok.nl/response-check-for-string-not-contains: "NullPointerException"
```
Both `traefik.containo.us/v1alpha1` as well as `traefik.io/v1alpha1` resources are supported.

## Run/usage

```shell
Expand Down Expand Up @@ -70,6 +72,34 @@ OPTIONS:
Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'.
```

## Develop

The project is written in Go and scaffolded with [kubebuilder](https://kubebuilder.io).

### kubebuilder

This operator was scaffolded with [kubebuilder](https://kubebuilder.io)

Read the manual when you want/need to make changes.
E.g. run `make test` before committing.

### Linting

Install [golangci-lint](https://golangci-lint.run/usage/install/) and run `golangci-lint run`
from the root.
(Don't run `make lint`, it uses an old version of golangci-lint.)

## Misc

### How to Contribute

Make a pull request...

### Contact

Contacting the maintainers can be done through the issue tracker.


## License

```text
Expand Down

0 comments on commit e815198

Please sign in to comment.