Skip to content

Commit 526df15

Browse files
committed
fix(docs): add k8s example
1 parent d068bfb commit 526df15

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,19 @@ A lightweight CLI tool for HTTP health checks with configurable retries and time
4747
This is best used in containerized environments and more specifically, to check
4848
the healthcheck of a recently deployed pod for preview environment.
4949

50+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
51+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
52+
53+
- [Install](#install)
54+
- [Usage](#usage)
55+
- [Environment Variables](#environment-variables)
56+
- [Docker](#docker)
57+
- [Kubernetes Example](#kubernetes-example)
58+
- [Options](#options)
59+
- [Build](#build)
60+
61+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
62+
5063
## Install
5164

5265
```bash
@@ -92,6 +105,44 @@ docker run --rm ghcr.io/meysam81/liveness-check:latest \
92105
check --http-target http://host.docker.internal:8080/health
93106
```
94107

108+
### Kubernetes Example
109+
110+
```yaml
111+
---
112+
apiVersion: batch/v1
113+
kind: Job
114+
metadata:
115+
name: liveness-check
116+
spec:
117+
template:
118+
spec:
119+
containers:
120+
- args:
121+
- check
122+
- "--http-target"
123+
- http://my-service.default.svc.cluster.local/health
124+
image: ghcr.io/meysam81/liveness-check
125+
name: liveness-check
126+
resources:
127+
limits:
128+
cpu: 10m
129+
memory: 10Mi
130+
requests:
131+
cpu: 10m
132+
memory: 10Mi
133+
securityContext:
134+
allowPrivilegeEscalation: false
135+
capabilities:
136+
drop:
137+
- ALL
138+
readOnlyRootFilesystem: true
139+
runAsGroup: 65534
140+
runAsNonRoot: true
141+
runAsUser: 65534
142+
terminationMessagePolicy: FallbackToLogsOnError
143+
restartPolicy: OnFailure
144+
```
145+
95146
## Options
96147
97148
- `--http-target, -u`: Target URL to check (required)

0 commit comments

Comments
 (0)