Skip to content

docs(deployment): add liveness and readiness probes to Kubernetes manifest#215

Open
andrerfneves wants to merge 1 commit into
mainfrom
maintenance/add-k8s-health-probes-20260625
Open

docs(deployment): add liveness and readiness probes to Kubernetes manifest#215
andrerfneves wants to merge 1 commit into
mainfrom
maintenance/add-k8s-health-probes-20260625

Conversation

@andrerfneves

Copy link
Copy Markdown
Owner

Summary

Adds HTTP health probes (liveness and readiness) to the Kubernetes Deployment example in DEPLOYMENT_DOCKER.md.

Why

The Kubernetes manifest was missing health probes, which are essential for production deployments:

  • Without probes, Kubernetes has no way to detect if the nginx container becomes unhealthy (stuck, deadlocked, etc.) or is not yet ready to serve traffic
  • livenessProbe tells Kubernetes when to restart a container that has entered an unhealthy state
  • readinessProbe tells Kubernetes when a pod is ready to start receiving traffic (prevents serving requests during startup)

The probes use the existing nginx health endpoint (HTTP GET / on port 80), which requires no additional dependencies since nginx responds with 200 on the root path by default.

Changes

  • DEPLOYMENT_DOCKER.md: Added livenessProbe and readinessProbe to the container spec in the Kubernetes manifest:
    • livenessProbe: HTTP GET / port 80, initialDelaySeconds: 10, periodSeconds: 30
    • readinessProbe: HTTP GET / port 80, initialDelaySeconds: 5, periodSeconds: 10

Test Plan

  • No behavior change — documentation-only fix
  • YAML syntax is valid
  • Probes use standard Kubernetes API fields

…ifest

Add HTTP health probes to the Kubernetes Deployment example so that
Kubernetes can properly manage container lifecycle and traffic routing.

- livenessProbe: HTTP GET / on port 80, starts after 10s, checks every 30s
- readinessProbe: HTTP GET / on port 80, starts after 5s, checks every 10s

Without these probes, Kubernetes cannot detect when the nginx container
is unhealthy or not ready to serve traffic.
@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
lightning-decoder Ready Ready Preview, Comment Jun 25, 2026 12:12pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant