mirror of
https://github.com/johndoe6345789/metabuilder.git
synced 2026-04-28 15:54:56 +00:00
Phase 8 Email Client Implementation - Complete Docker containerization:
DELIVERABLES:
- Dockerfile: Production-ready Flask WSGI server
* Python 3.11-slim base image (optimized)
* Multi-stage build (separates build/runtime dependencies)
* Gunicorn with 4 workers, 2 threads (8 concurrent connections)
* Non-root user execution (emailservice UID 1000)
* Automated health checks (30s interval, 15s grace period)
* Structured logging to persistent volumes
- Docker Compose Stack (8 services):
* PostgreSQL 16 (email metadata, health checks)
* Redis 7 (cache & Celery broker, RDB persistence)
* Postfix (SMTP relay, multi-port support)
* Dovecot (IMAP/POP3, TLS support)
* Email Service (Flask REST API, 4 workers)
* Celery Worker (async tasks, 4 concurrency)
* Celery Beat (scheduled tasks)
* Mailpit (development email UI)
CONFIGURATION:
- requirements.txt: Pinned dependencies (flask, sqlalchemy, celery, etc.)
- .env.example: Environment variable template with defaults
- .dockerignore: Build optimization (excludes cache, venv, etc.)
DOCUMENTATION:
- README.md: Complete service reference (350+ lines)
* Architecture overview
* Building and running instructions
* API endpoint reference
* Health check configuration
* Volume management
* Worker process tuning
* Celery background jobs
* Networking and security
* Troubleshooting guide
- DEPLOYMENT.md: Full deployment procedures (600+ lines)
* Quick start for 3 environments (dev, staging, prod)
* System architecture diagrams
* Service dependencies
* Configuration management
* Secrets management strategies (3 options)
* Production deployment steps (5-step procedure)
* Load balancer configuration (nginx)
* Monitoring setup (Prometheus)
* Horizontal scaling
* Backup/restore procedures
* Zero-downtime deployments
* Comprehensive troubleshooting
- Makefile: 40+ development commands
* dev: Start all services (development mode)
* build: Build Docker images
* health: Check service health
* logs: Tail service logs
* test: Run test suite
* db-backup/restore: Database operations
* clean: Remove all data
* ci-*: CI/CD targets
HELPER SCRIPTS:
- startup-checks.sh: Validates dependencies at startup
* Environment variables
* Database connectivity
* Redis connectivity
* Flask application
* Python dependencies
* File permissions
DOCKER COMPOSE VARIATIONS:
- docker-compose.yml: Production configuration
- docker-compose.override.yml: Development overrides (auto-loaded)
* Flask dev server with hot reload
* Source code volumes
* Mailpit for email testing
FEATURES:
- Multi-tenant support (X-Tenant-ID header)
- JWT authentication (Authorization header)
- Rate limiting (configurable per minute/hour)
- Async processing (Celery workers + Beat)
- Encryption (AES-256 for credentials)
- Health checks (all services)
- Graceful shutdown handling
- Structured JSON logging
ARCHITECTURE:
- 8 concurrent HTTP connections (4 workers × 2 threads)
- Horizontal scaling: Multiple service instances + load balancer
- Vertical scaling: Increase GUNICORN_WORKERS/THREADS
- Resource requirements: 2-4 GB RAM, 2-4 CPU cores
TESTING & VALIDATION:
- Dockerfile builds successfully
- All dependencies resolved
- Container starts and responds to health checks
- API endpoints accessible
- Database and Redis connectivity verified
FILES CREATED (12 total):
emailclient/
├── PHASE_8_SUMMARY.md (700+ lines)
├── DEPLOYMENT.md (600+ lines)
├── Makefile (350+ lines, 40+ targets)
├── docker-compose.yml (enhanced)
├── docker-compose.override.yml (development)
└── deployment/
└── docker-compose.yml
└── docker/email-service/
├── Dockerfile (production)
├── requirements.txt (pinned versions)
├── .env.example (configuration)
├── .dockerignore (build optimization)
├── startup-checks.sh (validation)
└── README.md (reference)
NEXT PHASES:
- Phase 9: API Documentation & OpenAPI/Swagger
- Phase 10: Monitoring & Observability
- Phase 11: CI/CD Pipeline Integration
- Phase 12: Performance Optimization & Load Testing
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
370 lines
10 KiB
YAML
370 lines
10 KiB
YAML
version: '3.9'
|
|
|
|
# Phase 8 Email Client Implementation - Complete Docker Compose Stack
|
|
# Full email service infrastructure with IMAP, SMTP, API, and supporting services
|
|
|
|
services:
|
|
# ============================================================================
|
|
# Core Infrastructure Services
|
|
# ============================================================================
|
|
|
|
# PostgreSQL Database - Email metadata storage
|
|
postgres:
|
|
image: postgres:16-alpine
|
|
container_name: emailclient-postgres
|
|
hostname: postgres
|
|
environment:
|
|
POSTGRES_USER: ${DB_USER:-emailclient}
|
|
POSTGRES_PASSWORD: ${DB_PASSWORD:-secure_password}
|
|
POSTGRES_DB: ${DB_NAME:-emailclient_db}
|
|
POSTGRES_INITDB_ARGS: "-c max_connections=200"
|
|
ports:
|
|
- "${DB_PORT:-5433}:5432"
|
|
volumes:
|
|
- postgres-data:/var/lib/postgresql/data
|
|
- ./deployment/docker/postgres/init-scripts:/docker-entrypoint-initdb.d
|
|
networks:
|
|
- emailclient-net
|
|
restart: unless-stopped
|
|
healthcheck:
|
|
test: ["CMD-SHELL", "pg_isready -U ${DB_USER:-emailclient}"]
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 5
|
|
start_period: 20s
|
|
labels:
|
|
- "com.metabuilder.service=database"
|
|
- "com.metabuilder.phase=8-email-client"
|
|
|
|
# Redis Cache & Message Broker - For Celery tasks and session storage
|
|
redis:
|
|
image: redis:7-alpine
|
|
container_name: emailclient-redis
|
|
hostname: redis
|
|
command: redis-server
|
|
--appendonly yes
|
|
--appendfsync everysec
|
|
--maxmemory 256mb
|
|
--maxmemory-policy allkeys-lru
|
|
ports:
|
|
- "${REDIS_PORT:-6379}:6379"
|
|
volumes:
|
|
- redis-data:/data
|
|
networks:
|
|
- emailclient-net
|
|
restart: unless-stopped
|
|
healthcheck:
|
|
test: ["CMD", "redis-cli", "ping"]
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 5
|
|
start_period: 10s
|
|
labels:
|
|
- "com.metabuilder.service=cache"
|
|
- "com.metabuilder.phase=8-email-client"
|
|
|
|
# ============================================================================
|
|
# Email Infrastructure Services
|
|
# ============================================================================
|
|
|
|
# Postfix Mail Server - SMTP relay and mail delivery
|
|
postfix:
|
|
build:
|
|
context: ..
|
|
dockerfile: ./emailclient/deployment/docker/postfix/Dockerfile
|
|
container_name: emailclient-postfix
|
|
hostname: postfix
|
|
environment:
|
|
POSTFIX_myhostname: ${POSTFIX_HOSTNAME:-emailclient.local}
|
|
POSTFIX_mydomain: ${POSTFIX_DOMAIN:-emailclient.local}
|
|
POSTFIX_mynetworks: ${POSTFIX_NETWORKS:-127.0.0.0/8 10.0.0.0/8 172.16.0.0/12}
|
|
POSTFIX_relayhost: ${POSTFIX_RELAYHOST:-}
|
|
POSTFIX_smtp_sasl_auth_enable: ${POSTFIX_SASL_AUTH:-no}
|
|
POSTFIX_smtp_tls_security_level: ${POSTFIX_TLS_LEVEL:-may}
|
|
ports:
|
|
- "${POSTFIX_SMTP_PORT:-25}:25"
|
|
- "${POSTFIX_SUBMISSION_PORT:-587}:587"
|
|
- "${POSTFIX_SMTPS_PORT:-465}:465"
|
|
volumes:
|
|
- postfix-data:/var/mail
|
|
- postfix-logs:/var/log
|
|
- postfix-spool:/var/spool/postfix
|
|
networks:
|
|
- emailclient-net
|
|
restart: unless-stopped
|
|
healthcheck:
|
|
test: ["CMD", "postfix", "status"]
|
|
interval: 30s
|
|
timeout: 5s
|
|
retries: 3
|
|
start_period: 20s
|
|
labels:
|
|
- "com.metabuilder.service=smtp"
|
|
- "com.metabuilder.phase=8-email-client"
|
|
|
|
# Dovecot IMAP/POP3 Server - Email storage and access
|
|
dovecot:
|
|
build:
|
|
context: ..
|
|
dockerfile: ./emailclient/deployment/docker/dovecot/Dockerfile
|
|
container_name: emailclient-dovecot
|
|
hostname: dovecot
|
|
environment:
|
|
DOVECOT_MAIL_HOME: /var/mail
|
|
DOVECOT_PROTOCOLS: ${DOVECOT_PROTOCOLS:-imap pop3}
|
|
DOVECOT_LISTEN: ${DOVECOT_LISTEN:-*, ::}
|
|
ports:
|
|
- "${IMAP_PORT:-143}:143"
|
|
- "${IMAPS_PORT:-993}:993"
|
|
- "${POP3_PORT:-110}:110"
|
|
- "${POP3S_PORT:-995}:995"
|
|
volumes:
|
|
- dovecot-data:/var/mail
|
|
- dovecot-logs:/var/log/dovecot
|
|
networks:
|
|
- emailclient-net
|
|
depends_on:
|
|
- postfix
|
|
restart: unless-stopped
|
|
healthcheck:
|
|
test: ["CMD", "doveadm", "ping"]
|
|
interval: 30s
|
|
timeout: 5s
|
|
retries: 3
|
|
start_period: 20s
|
|
labels:
|
|
- "com.metabuilder.service=imap-pop3"
|
|
- "com.metabuilder.phase=8-email-client"
|
|
|
|
# ============================================================================
|
|
# Email Service API (Phase 8)
|
|
# ============================================================================
|
|
|
|
# Email Service - Flask REST API
|
|
email-service:
|
|
build:
|
|
context: ..
|
|
dockerfile: ./emailclient/deployment/docker/email-service/Dockerfile
|
|
container_name: emailclient-email-service
|
|
hostname: email-service
|
|
environment:
|
|
# Flask Configuration
|
|
FLASK_ENV: ${FLASK_ENV:-production}
|
|
FLASK_HOST: 0.0.0.0
|
|
FLASK_PORT: 5000
|
|
|
|
# Database Configuration
|
|
DATABASE_URL: postgresql://${DB_USER:-emailclient}:${DB_PASSWORD:-secure_password}@postgres:5432/${DB_NAME:-emailclient_db}
|
|
|
|
# Redis Configuration
|
|
REDIS_URL: redis://redis:6379/0
|
|
CELERY_BROKER_URL: redis://redis:6379/1
|
|
CELERY_RESULT_BACKEND: redis://redis:6379/1
|
|
|
|
# Security
|
|
JWT_SECRET: ${JWT_SECRET:-change-me-in-production}
|
|
JWT_ALGORITHM: HS256
|
|
JWT_EXPIRATION_HOURS: 24
|
|
|
|
# CORS
|
|
CORS_ORIGINS: ${CORS_ORIGINS:-localhost:3000,emailclient.local:3000}
|
|
|
|
# Email Service Configuration
|
|
IMAP_TIMEOUT: 30
|
|
SMTP_TIMEOUT: 30
|
|
IMAP_POOL_SIZE: 10
|
|
SMTP_POOL_SIZE: 5
|
|
|
|
# Encryption
|
|
ENCRYPTION_KEY: ${ENCRYPTION_KEY:-change-me-in-production}
|
|
|
|
# Gunicorn Configuration
|
|
GUNICORN_WORKERS: 4
|
|
GUNICORN_THREADS: 2
|
|
GUNICORN_TIMEOUT: 120
|
|
|
|
# Logging
|
|
LOG_LEVEL: ${LOG_LEVEL:-INFO}
|
|
|
|
# Feature Flags
|
|
ENABLE_IMAP_SYNC: "true"
|
|
ENABLE_SMTP_SEND: "true"
|
|
ENABLE_CELERY_TASKS: "true"
|
|
ENABLE_EMAIL_PARSING: "true"
|
|
|
|
# Rate Limiting
|
|
RATE_LIMIT_ENABLED: "true"
|
|
RATE_LIMIT_REQUESTS_PER_MINUTE: 60
|
|
RATE_LIMIT_REQUESTS_PER_HOUR: 1000
|
|
|
|
# Multi-tenant Configuration
|
|
TENANT_ID_HEADER: X-Tenant-ID
|
|
DEFAULT_TENANT_ID: default
|
|
|
|
ports:
|
|
- "${EMAIL_SERVICE_PORT:-5000}:5000"
|
|
|
|
volumes:
|
|
- email-service-logs:/app/logs
|
|
- email-service-data:/app/data
|
|
|
|
depends_on:
|
|
postgres:
|
|
condition: service_healthy
|
|
redis:
|
|
condition: service_healthy
|
|
postfix:
|
|
condition: service_healthy
|
|
dovecot:
|
|
condition: service_healthy
|
|
|
|
networks:
|
|
- emailclient-net
|
|
|
|
restart: unless-stopped
|
|
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-f", "http://localhost:5000/health"]
|
|
interval: 30s
|
|
timeout: 10s
|
|
retries: 3
|
|
start_period: 15s
|
|
|
|
labels:
|
|
- "com.metabuilder.service=email-api"
|
|
- "com.metabuilder.phase=8-email-client"
|
|
|
|
# Celery Worker - Background job processing for async tasks
|
|
celery-worker:
|
|
build:
|
|
context: ..
|
|
dockerfile: ./emailclient/deployment/docker/email-service/Dockerfile
|
|
container_name: emailclient-celery-worker
|
|
hostname: celery-worker
|
|
command: celery -A tasks worker --loglevel=info --concurrency=4
|
|
|
|
environment:
|
|
# Database Configuration
|
|
DATABASE_URL: postgresql://${DB_USER:-emailclient}:${DB_PASSWORD:-secure_password}@postgres:5432/${DB_NAME:-emailclient_db}
|
|
|
|
# Redis Configuration
|
|
REDIS_URL: redis://redis:6379/0
|
|
CELERY_BROKER_URL: redis://redis:6379/1
|
|
CELERY_RESULT_BACKEND: redis://redis:6379/1
|
|
|
|
# Email Service Configuration
|
|
IMAP_TIMEOUT: 30
|
|
SMTP_TIMEOUT: 30
|
|
IMAP_POOL_SIZE: 10
|
|
SMTP_POOL_SIZE: 5
|
|
|
|
# Encryption
|
|
ENCRYPTION_KEY: ${ENCRYPTION_KEY:-change-me-in-production}
|
|
|
|
# Logging
|
|
LOG_LEVEL: ${LOG_LEVEL:-INFO}
|
|
|
|
# Feature Flags
|
|
ENABLE_IMAP_SYNC: "true"
|
|
ENABLE_SMTP_SEND: "true"
|
|
ENABLE_EMAIL_PARSING: "true"
|
|
|
|
volumes:
|
|
- email-service-logs:/app/logs
|
|
- email-service-data:/app/data
|
|
|
|
depends_on:
|
|
redis:
|
|
condition: service_healthy
|
|
postgres:
|
|
condition: service_healthy
|
|
postfix:
|
|
condition: service_healthy
|
|
|
|
networks:
|
|
- emailclient-net
|
|
|
|
restart: unless-stopped
|
|
|
|
labels:
|
|
- "com.metabuilder.service=celery-worker"
|
|
- "com.metabuilder.phase=8-email-client"
|
|
|
|
# Celery Beat - Scheduled task scheduler
|
|
celery-beat:
|
|
build:
|
|
context: ..
|
|
dockerfile: ./emailclient/deployment/docker/email-service/Dockerfile
|
|
container_name: emailclient-celery-beat
|
|
hostname: celery-beat
|
|
command: celery -A tasks beat --loglevel=info
|
|
|
|
environment:
|
|
# Database Configuration
|
|
DATABASE_URL: postgresql://${DB_USER:-emailclient}:${DB_PASSWORD:-secure_password}@postgres:5432/${DB_NAME:-emailclient_db}
|
|
|
|
# Redis Configuration
|
|
REDIS_URL: redis://redis:6379/0
|
|
CELERY_BROKER_URL: redis://redis:6379/1
|
|
CELERY_RESULT_BACKEND: redis://redis:6379/1
|
|
|
|
# Encryption
|
|
ENCRYPTION_KEY: ${ENCRYPTION_KEY:-change-me-in-production}
|
|
|
|
# Logging
|
|
LOG_LEVEL: ${LOG_LEVEL:-INFO}
|
|
|
|
volumes:
|
|
- email-service-logs:/app/logs
|
|
- email-service-data:/app/data
|
|
|
|
depends_on:
|
|
redis:
|
|
condition: service_healthy
|
|
postgres:
|
|
condition: service_healthy
|
|
|
|
networks:
|
|
- emailclient-net
|
|
|
|
restart: unless-stopped
|
|
|
|
labels:
|
|
- "com.metabuilder.service=celery-beat"
|
|
- "com.metabuilder.phase=8-email-client"
|
|
|
|
# ============================================================================
|
|
# Persistent Volumes
|
|
# ============================================================================
|
|
|
|
volumes:
|
|
postgres-data:
|
|
driver: local
|
|
redis-data:
|
|
driver: local
|
|
postfix-data:
|
|
driver: local
|
|
postfix-logs:
|
|
driver: local
|
|
postfix-spool:
|
|
driver: local
|
|
dovecot-data:
|
|
driver: local
|
|
dovecot-logs:
|
|
driver: local
|
|
email-service-logs:
|
|
driver: local
|
|
email-service-data:
|
|
driver: local
|
|
|
|
# ============================================================================
|
|
# Networks
|
|
# ============================================================================
|
|
|
|
networks:
|
|
emailclient-net:
|
|
driver: bridge
|
|
ipam:
|
|
config:
|
|
- subnet: 172.25.0.0/16
|