Skip to content

Add health probe configuration to Kubernetes deployment guide #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mlsmaycon merged 1 commit into from
Mar 23, 2026
+25 −0
Merged

Add health probe configuration to Kubernetes deployment guide #665

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/pages/use-cases/cloud/routing-peers-and-kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading