/azure-kubernetes

FastAPI Knowledge Pack

Applies to: Projects detected with requirements.txt, pyproject.toml, or Pipfile containing fastapi

Quick Reference

Health Endpoints

FastAPI health endpoints must be defined explicitly in application code:

Minimal health route

from fastapi import FastAPI

app = FastAPI()

@app.get("/health")
async def health():
    return {"status": "ok"}

Readiness route with database check

from fastapi import FastAPI, status
from fastapi.responses import JSONResponse
from sqlalchemy.ext.asyncio import AsyncSession

@app.get("/ready")
async def ready(db: AsyncSession = Depends(get_db)):
    try:
        await db.execute(text("SELECT 1"))
        return {"status": "ready"}
    except Exception:
        return JSONResponse(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
            content={"status": "not ready"},
        )

Probe configuration in Deployment manifest

livenessProbe:
  httpGet:
    path: /health
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 15
  timeoutSeconds: 3
  failureThreshold: 3
readinessProbe:
  httpGet:
    path: /ready
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 10
  timeoutSeconds: 3
  failureThreshold: 3

Note: FastAPI apps start quickly (typically <2s), so initialDelaySeconds: 5 is sufficient — much lower than JVM-based frameworks.

Database Profiles

FastAPI does not have a built-in profile system. Database configuration is typically driven by environment variables:

Important: SQLAlchemy async requires the +asyncpg suffix in the connection URL scheme (postgresql+asyncpg://). Omitting it will default to the synchronous psycopg2 driver, which blocks the event loop.

Environment variables for PostgreSQL on AKS

env:
  - name: DATABASE_URL
    value: "postgresql+asyncpg://{{IDENTITY_NAME}}@{{PG_SERVER_NAME}}.postgres.database.azure.com:5432/{{DB_NAME}}?sslmode=require"

ConfigMap pattern

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{APP_NAME}}-config
data:
  DATABASE_URL: "postgresql+asyncpg://{{IDENTITY_NAME}}@{{PG_SERVER_NAME}}.postgres.database.azure.com:5432/{{DB_NAME}}?sslmode=require"
  UVICORN_WORKERS: "1"

Workload Identity with azure-identity

See references/workload-identity.md for connection patterns. Requires azure-identity package.

Writable Paths (DS012 Compliance)

When readOnlyRootFilesystem: true is set, FastAPI apps typically only need /tmp writable:

• Uploaded files use /tmp as the default staging directory for UploadFile
• Temporary processing may write intermediate results to /tmp

Required volume mount

volumes:
  - name: tmp
    emptyDir: {}
containers:
  - name: app
    volumeMounts:
      - name: tmp
        mountPath: /tmp

No other writable paths are typically needed for production FastAPI apps.

Resource Sizing

FastAPI with Uvicorn is async and lightweight. Size for workload concurrency.

Port Configuration

• Default port: 8000
• CLI flag: --host 0.0.0.0 --port 8000 passed to uvicorn — must include --host 0.0.0.0 (uvicorn defaults to 127.0.0.1, unreachable from Kubernetes probes)
• Workers: use --workers 1 for pure-async apps (async code uses a single event loop); 2 * CPU_CORES + 1 only for sync/blocking handlers
• Env var override: PORT (read via uvicorn --port $PORT or int(os.environ.get("PORT", 8000)))

Uvicorn logs the port on startup: Uvicorn running on http://0.0.0.0:8000

Build Commands

The --no-cache-dir flag (pip) and --no-interaction flag (Poetry) suppress interactive prompts — important for CI/CD and Docker builds.

Common Issues on AKS