Merge pull request #770 from Kezzsim/pod_health

💉 Add health check for hosting containerized tiled instances

tiled/_tests/test_routes.py

@@ -5,7 +5,7 @@
 from ..server.app import build_app
 
 
-@pytest.mark.parametrize("path", ["/", "/docs"])
+@pytest.mark.parametrize("path", ["/", "/docs", "/healthz"])
 @pytest.mark.asyncio
 async def test_meta_routes(path):
     app = build_app({})

tiled/server/app.py

@@ -217,6 +217,12 @@ async def lifespan(app: FastAPI):
 
     app = FastAPI(lifespan=lifespan)
 
+    # Healthcheck for deployment to containerized systems, needs to preempt other responses.
+    # Standardized for Kubernetes, but also used by other systems.
+    @app.get("/healthz", status_code=200)
+    async def healthz():
+        return {"status": "ready"}
+
     if SHARE_TILED_PATH:
         # If the distribution includes static assets, serve UI routes.