Skip to content

Commit

Permalink
Add readyz and livez example to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam0Brien committed Sep 17, 2024
1 parent b9a5359 commit 2d59df8
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,23 @@ make init

## Example Usage

### Health check endpoints

The inventory API includes health check endpoints for readiness and liveness probes.

#### Readyz
The readyz endpoint checks if the service is ready to handle requests.
```bash
curl http://localhost:8081/api/inventory/v1/readyz
```

#### Livez
The livez endpoint checks if the service is alive and functioning correctly.
```bash
curl http://localhost:8081/api/inventory/v1/livez
```

### Add hosts to inventory
To add hosts to the inventory, use the following `curl` command:

```bash
Expand Down

0 comments on commit 2d59df8

Please sign in to comment.