Add health probe configuration to Kubernetes deployment guide (#665)

This commit is contained in:
Viktor Liu
2026-03-23 16:40:50 +08:00
committed by GitHub
parent 515c809bbf
commit fdff1eafed

View File

@@ -99,8 +99,33 @@ spec:
- NET_ADMIN
- SYS_RESOURCE
- SYS_ADMIN
livenessProbe:
exec:
command: ["netbird", "status", "--check", "live"]
initialDelaySeconds: 5
periodSeconds: 10
timeoutSeconds: 5
failureThreshold: 3
readinessProbe:
exec:
command: ["netbird", "status", "--check", "ready"]
initialDelaySeconds: 5
periodSeconds: 10
timeoutSeconds: 5
failureThreshold: 3
startupProbe:
exec:
command: ["netbird", "status", "--check", "startup"]
periodSeconds: 2
timeoutSeconds: 10
failureThreshold: 30
```
The health probes use `netbird status --check` to verify the client state:
- **live**: checks that the daemon process is responsive
- **ready**: checks that the client is not in an authentication-required state (NeedsLogin, LoginFailed, SessionExpired)
- **startup**: checks that management and signal are connected, and that at least one relay server is available if any are configured
Edit your deployment.yml file, incorporating the setup key into the relevant sections.
Apply the updated deployment file to your Kubernetes cluster using the following command: