Docker compose healthcheck

.env.example

@@ -0,0 +1,13 @@
+# Pyronear API
+API_URL=https://api.pyronear.org
+
+# Camera credentials (shared across all cameras unless overridden per-camera in credentials.json)
+CAM_USER=my_dummy_login
+CAM_PWD=my_dummy_pwd
+
+# MediaMTX server IP (used by pyro-camera-api to build SRT output URLs)
+MEDIAMTX_SERVER_IP=1.2.3.4
+
+# Docker image tag for both services (defaults to "latest" if unset)
+# Set to a specific version for pinned deployments, e.g. PYRO_ENGINE_VERSION=1.2.0
+PYRO_ENGINE_VERSION=latest

README.md

@@ -104,14 +104,18 @@ pip install -e pyro-engine/.
 
 ### Environment variables
 
-Deployments usually rely on a `.env` file with information such as:
+Deployments usually rely on a `.env` file. A `.env.example` is provided at the root of the repository as a reference:
 
 ```text
 API_URL=https://api.pyronear.org
 CAM_USER=my_dummy_login
 CAM_PWD=my_dummy_pwd
+MEDIAMTX_SERVER_IP=1.2.3.4
+PYRO_ENGINE_VERSION=latest
 ```
 
+`PYRO_ENGINE_VERSION` controls which Docker image tag is pulled for both services (defaults to `latest` if unset).
+
 ### Data directory
 
 A `./data` directory is expected with at least:

docker-compose.yml

@@ -2,7 +2,7 @@ services:
   pyro-camera-api:
     build:
       context: ./pyro_camera_api
-    image: pyronear/pyro-camera-api:latest
+    image: pyronear/pyro-camera-api:${PYRO_ENGINE_VERSION:-latest}
     container_name: pyro-camera-api
     environment:
       CAM_USER: ${CAM_USER}
@@ -12,6 +12,12 @@ services:
       - ./data:/usr/src/app/data
     restart: always
     network_mode: host
+    healthcheck:
+      test: ["CMD-SHELL", "curl -sf http://localhost:8081/health || exit 1"]
+      interval: 30s
+      retries: 3
+      start_period: 20s
+      timeout: 5s
     logging:
       driver: json-file
       options:
@@ -22,17 +28,27 @@ services:
   engine:
     build:
       context: ./engine
-    image: pyronear/pyro-engine:latest
+    image: pyronear/pyro-engine:${PYRO_ENGINE_VERSION:-latest}
     container_name: engine
     environment:
       API_URL: ${API_URL}
       CAM_USER: ${CAM_USER}
       CAM_PWD: ${CAM_PWD}
     volumes:
       - ./data:/usr/src/app/data
-    command: python run.py
+    command: >
+      sh -c '
+        truncate -s 0 engine.log &&
+        python run.py 2>&1 | tee -a engine.log
+      '
     restart: always
     network_mode: host
+    healthcheck:
+      test: ["CMD-SHELL", "grep -q 'confidence\\|Nighttime detected' engine.log || exit 1"]
+      interval: 30s
+      retries: 3
+      start_period: 20s
+      timeout: 5s
     logging:
       driver: json-file
       options:

pyro_camera_api/Dockerfile

@@ -8,6 +8,7 @@ ENV PYTHONPATH=/usr/src/app
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
+        curl \
         git \
         ffmpeg \
         libsm6 \

pyroengine/engine.py

@@ -328,9 +328,6 @@ def _process_alerts(self) -> None:
                     except ValueError:
                         logger.error(f"Camera '{cam_id}' - non-JSON response body: {response.text}")
                         raise
-                    except KeyError:
-                        logger.error(f"Camera '{cam_id}' - unexpected API response: {response.text}")
-                        raise
 
                     # Clear
                     self._alerts.popleft()