Add /health Endpoint for Health Check

[ddeerrrriicckk]

Description

It adds a /health endpoint. The endpoint provides a simple JSON response indicating the health status of the service, allowing Kubernetes to monitor if the service is running properly.

Implementation Details

• /health Endpoint:
  1. Added a new /health route in service/routes.py.
  2. The /health endpoint returns a JSON response {"status": "OK"} with an HTTP status code 200_OK.
  3. This endpoint is intended for use by Kubernetes liveness and readiness probes to check the service's health status.
• Kubernetes Health Probes:
  1. Liveness Probe: Checks if the app is alive; restarts the container if it fails.
     • Path: /health, Port: 8080
     • Delay: 15s, Interval: 20s
  2. Readiness Probe: Checks if the app is ready to receive traffic; marks the Pod as unready if it fails.
     • Path: /health, Port: 8080
     • Delay: 5s, Interval: 10s

Acceptance Criteria

• [x] The /health endpoint returns {"status": "OK"}.
• [x] The HTTP status code is 200_OK.
• [x] Liveness and readiness probes are configured in deployment.yaml to use the /health endpoint.

Testing

1. Manually tested the /health endpoint to verify it returns the correct JSON response and status code.
2. Automated tests added in tests/test_routes.py to ensure the /health endpoint behaves as expected.
3. Verified the Kubernetes probes work as expected by observing the Pod behavior during testing.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Files with missing lines	Coverage Δ
service/routes.py	98.07% <100.00%> (+0.05%)	:arrow_up: