Skip to content

Commit

Permalink
docs: Adding documentation about basic endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
ViBiOh committed Dec 19, 2020
1 parent afdacfd commit 8ae7dbb
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ You can configure app by passing CLI args or environment variables (cf. [Usage](

You'll find a Kubernetes exemple in the [`infra/`](infra/) folder, using my [`app chart`](https://github.com/ViBiOh/charts/tree/master/app)

## Endpoints

- `GET /health`: healthcheck of server, respond [`okStatus (default 204)`](#usage) or `503` during [`graceDuration`](#usage) when SIGTERM is received
- `GET /version`: value of `VERSION` environment variable
- `GET /metrics`: Prometheus metrics values

## Usage

```bash
Expand Down

0 comments on commit 8ae7dbb

Please sign in to comment.