Skip to content

Commit 1e28b73

Browse files
committed
Refresh README tone and concision
1 parent b5368d7 commit 1e28b73

1 file changed

Lines changed: 16 additions & 42 deletions

File tree

README.md

Lines changed: 16 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,23 @@
1-
# ssl-expiry-check
1+
# Ssl Expiry Check
22

3-
The `ssl-expiry-check` verifies a TLS certificate is valid and does not expire within a configured number of days.
3+
Kuberhealthy's SSL expiry check
44

5-
## Configuration
5+
## What it is
6+
This repository builds the container image used by Kuberhealthy to run the ssl-expiry-check check.
67

7-
Set these environment variables in the `HealthCheck` spec:
8+
## Image
9+
- `docker.io/kuberhealthy/ssl-expiry-check`
10+
- Tags: short git SHA for `main` pushes and `vX.Y.Z` for releases.
811

9-
- `DOMAIN_NAME` (required): domain name to check.
10-
- `PORT` (required): TLS port to check (for example, `443`).
11-
- `DAYS` (required): number of days before expiration to warn (for example, `60`).
12-
- `INSECURE` (required): set to `true` for self-signed certificates to skip TLS verification.
12+
## Quick start
13+
- Apply the example manifest: `kubectl apply -f healthcheck.yaml`
14+
- Edit the manifest to set any required inputs for your environment.
1315

14-
## Build
16+
## Build locally
17+
- `docker build -f ./Containerfile -t kuberhealthy/ssl-expiry-check:dev .`
1518

16-
- `just build` builds the container image locally.
17-
- `just test` runs unit tests.
18-
- `just binary` builds the binary in `bin/`.
19+
## Contributing
20+
Issues and PRs are welcome. Please keep changes focused and add a short README update when behavior changes.
1921

20-
## Example HealthCheck
21-
22-
Apply the example below or the provided `healthcheck.yaml`:
23-
24-
```yaml
25-
apiVersion: kuberhealthy.github.io/v2
26-
kind: HealthCheck
27-
metadata:
28-
name: ssl-expiry
29-
namespace: kuberhealthy
30-
spec:
31-
runInterval: 24h
32-
timeout: 15m
33-
podSpec:
34-
spec:
35-
containers:
36-
- name: ssl-expiry
37-
image: kuberhealthy/ssl-expiry-check:sha-<short-sha>
38-
imagePullPolicy: IfNotPresent
39-
env:
40-
- name: DOMAIN_NAME
41-
value: "example.com"
42-
- name: PORT
43-
value: "443"
44-
- name: DAYS
45-
value: "60"
46-
- name: INSECURE
47-
value: "false"
48-
restartPolicy: Never
49-
```
22+
## License
23+
See `LICENSE`.

0 commit comments

Comments
 (0)