build: refactor to optimized docker multistage setup

Author: c-wygoda

.dockerignore

@@ -1,3 +1,3 @@
+.git*
 scripts
 tests
-.git*

DOCKER.md

@@ -0,0 +1,13 @@
+# Dockerized STAPI-FastAPI
+
+The [Dockerfile](./Dockerfile) provides three targets:
+
+- `base`: base install only, including poetry
+- `dev`: base plus dev dependencies
+- `lambda`: optimized for AWS Lambda, i.e. poetry removed
+
+Both `dev` and `lambda` builds allow setting the backend class with the `BACKEND_NAME`
+env var, i.e. `BACKEND_NAME=stapi_fastapi_landsat:LandsatBackend`.
+
+For local dev use, it's recommended to use the docker compose file. The backend can
+be choosen again by providing a env var `BACKEND_NAME`.

Dockerfile

@@ -1,24 +1,49 @@
-FROM python:3.12-slim
+FROM python:3.12-slim AS base
 
-ENV PYTHONUNBUFFERED=1 \
+ENV PATH="/venv/bin:/opt/poetry/bin:$PATH" \
     POETRY_VIRTUALENVS_CREATE=0 \
-    VIRTUAL_ENV=/.venv \
-    PATH="/.venv/bin:$PATH" \
-    DEBIAN_FRONTEND=noninteractive
+    PYTHONUNBUFFERED=1 \
+    VIRTUAL_ENV=/venv
 
-RUN pip install --no-cache-dir --no-cache poetry
+RUN python3 -m venv /opt/poetry && \
+    /opt/poetry/bin/pip3 install --no-cache-dir --no-cache poetry
 
 WORKDIR /app
-
 COPY poetry.lock pyproject.toml ./
+RUN --mount=type=cache,target=/root/.cache/pypoetry/cache \
+    --mount=type=cache,target=/root/.cache/pypoetry/artifacts \
+    python3 -m venv /venv && \
+    poetry install --no-interaction --compile && \
+    python3 -m compileall stapi_fastapi
+COPY . /app
 
-RUN python3 -m venv /.venv && poetry install --no-cache --no-interaction --with lambda
-RUN apt-get -yq update && apt-get -yq install git && pip install \
-    # git+https://github.com/stapi-utils/stat-fastapi-up42.git@main \
-    git+https://github.com/stapi-utils/stat-fastapi-blacksky.git@main \
-    git+https://github.com/stapi-utils/stat-fastapi-umbra.git@main \
-    && rm -rf /var/lib/apt/lists/*
 
-COPY . /app
+FROM base AS dev
+
+RUN --mount=type=cache,target=/root/.cache/pypoetry/cache \
+    --mount=type=cache,target=/root/.cache/pypoetry/artifacts \
+    poetry install --no-interaction --with dev --compile
+
+ENV HOST=0.0.0.0
+
+CMD [ "/opt/poetry/bin/poetry", "run", "dev" ]
+
+FROM base AS lambda-builder
+
+RUN --mount=type=cache,target=/root/.cache/pypoetry/cache \
+    --mount=type=cache,target=/root/.cache/pypoetry/artifacts \
+    poetry install --no-interaction --with lambda --compile
+
+
+FROM python:3.12-slim AS lambda
+
+ENV PATH="/venv/bin:$PATH" \
+    PYTHONUNBUFFERED=1 \
+    VIRTUAL_ENV=/venv
+
+WORKDIR /app
+COPY --from=lambda-builder /app /app
+COPY --from=lambda-builder /venv /venv
 
-RUN poetry run python -c "import compileall; compileall.compile_path(maxlevels=10)" && poetry run python -m compileall stapi_fastapi
+ENTRYPOINT [ "python3", "-m", "awslambdaric" ]
+CMD ["lambda_handler.handler"]

README.md

@@ -23,6 +23,8 @@ export DATABASE=sqlite:///order.sqlite
 export SPATIALITE_LIBRARY_PATH=/path/to/mod_spatialite.dylib
 ```
 
+Also see [DOCKER.md](./DOCKER.md) for details on docker setup for and deployment.
+
 ### Dev Setup
 
 Setup is managed with `poetry` and `pre-commit`, all of which can be initialised
@@ -37,6 +39,7 @@ pytest flags are passed along
 
 For dev purposes, [stapi_fastapi.**dev**.py](./stapi_fastapi/__dev__.py) shows
 a minimal demo with `uvicorn` to run the full app. Start it with `./scripts/server`.
+Choose backend with `BACKEND_NAME` env var, defaults to Landsat backend.
 
 ### Implementing a backend
 

compose.yml

@@ -0,0 +1,11 @@
+services:
+  api:
+    build:
+      context: .
+      target: dev
+    ports:
+      - 8000:8000
+    volumes:
+      - .:/app
+    environment:
+      BACKEND_NAME: ${BACKEND_NAME:-stapi_fastapi_landsat:LandsatBackend}

deploy_cdk/app.py

@@ -28,9 +28,6 @@ def __init__(self, scope: Construct, id: str, profile: DeploymentProfile) -> Non
             code=_lambda.Code.from_ecr_image(
                 repository=repository,
                 tag_or_digest=profile.image_tag_or_digest,
-                entrypoint=["poetry", "run", "python3", "-m", "awslambdaric"],
-                cmd=["lambda_handler.handler"],
-                working_directory="/app",
             ),
             memory_size=profile.memory,
             timeout=Duration.seconds(profile.timeout),