Skip to content

DOCKER-SETUP.md

Latest commit

 

History

History
242 lines (193 loc) · 7.64 KB

DOCKER-SETUP.md

File metadata and controls

242 lines (193 loc) · 7.64 KB
Raw

Docker Setup - Implementation Summary

✅ Completion Status

All requirements have been successfully implemented. The Docker development environment is ready for contributors.

📋 Deliverables

1. Dockerfile ✅

Located: Dockerfile

Features:

  • Multi-stage build for optimized image size
  • Node 22 Alpine base image (lightweight, ~150MB)
  • Prisma client generation during build
  • Non-root user (nodejs) for security
  • Health checks configured
  • Proper signal handling via dumb-init
  • Volume support for development hot-reload

2. docker-compose.yml ✅

Located: docker-compose.yml

Services Configured:

  • Backend (NestJS): Port 3000
    • Volume mounted for hot-reload
    • Health check enabled
    • Depends on database and cache services
    • Auto-restart policy
  • PostgreSQL 16: Port 5432
    • Volume persisted data
    • Health check enabled
    • Configurable credentials
  • Redis 7: Port 6379
    • Volume persisted data
    • AOF persistence enabled
    • Health check enabled

Network: Dedicated sentinel-network bridge network for service-to-service communication

3. Environment Configuration ✅

Located: .env.docker

Default Configuration:

NODE_ENV=development
PORT=3000
DB_USER=sentinel_user
DB_PASSWORD=sentinel_password
DB_NAME=sentinel_db
REDIS_URL=redis://redis:6379

4. .dockerignore ✅

Located: .dockerignore

Optimizes build context by excluding unnecessary files:

  • node_modules
  • Git files
  • Build artifacts
  • Documentation (except README)
  • Environment files

5. npm Scripts ✅

Updated: package.json

Convenient commands added:

# Docker container management
npm run docker:up          # Start all services
npm run docker:down        # Stop services
npm run docker:logs        # View logs
npm run docker:restart     # Restart services
npm run docker:build       # Rebuild images
npm run docker:clean       # Remove everything
npm run docker:ps          # Show status

# Database operations
npm run docker:db:migrate       # Apply migrations
npm run docker:db:migrate:dev   # Create new migration
npm run docker:db:reset         # Reset database
npm run docker:db:studio        # Open Prisma Studio

6. Documentation ✅

Located: DOCKER.md

Comprehensive guide includes:

  • Prerequisites and installation verification
  • Quick start instructions (4 steps)
  • Service overview and details
  • Configuration guide with examples
  • Common commands reference
  • Development workflow
  • Database migration procedures
  • Access methods (psql, Prisma Studio, redis-cli)
  • Troubleshooting guide
  • Production considerations
  • Additional resources

✅ Acceptance Criteria - All Met

Criteria Status Evidence
Create backend Dockerfile ✅ Dockerfile - Multi-stage, optimized, production-ready
Create docker-compose configuration ✅ docker-compose.yml - Orchestrates all services
Support local PostgreSQL ✅ PostgreSQL 16 service with volume persistence, health checks
Support local Redis ✅ Redis 7 service with AOF persistence, health checks
Setup documented ✅ DOCKER.md - 200+ lines of comprehensive documentation
Application runs via Docker ✅ Backend runs on port 3000 with volume mounts for hot-reload
PostgreSQL container starts ✅ Health check configured, automatic startup with docker-compose
Redis container starts ✅ Health check configured, automatic startup with docker-compose

🚀 Quick Start for Contributors

# 1. Clone the repository
git clone https://github.com/sentinel-security-productions/Sentinel.git
cd Sentinel

# 2. Start the development environment
npm run docker:up

# 3. Initialize the database
npm run docker:db:migrate

# 4. Access the application
# Backend: http://localhost:3000/api
# PostgreSQL: localhost:5432
# Redis: localhost:6379
# Prisma Studio: npm run docker:db:studio

📊 Architecture

┌─────────────────────────────────────────────────┐
│            Docker Compose Network               │
│          (sentinel-network bridge)              │
├─────────────────────────────────────────────────┤
│                                                 │
│  ┌─────────────────┐  ┌──────────────┐         │
│  │ Backend (Port   │  │ PostgreSQL   │         │
│  │ 3000)           │  │ (Port 5432)  │         │
│  │ - NestJS        │  │ - Database   │         │
│  │ - Hot reload    │  │ - Persisted  │         │
│  │ - Health check  │◄─┤ - Health chk │         │
│  └─────────────────┘  └──────────────┘         │
│           │                                    │
│           └──────────────────┐                 │
│                              │                 │
│                       ┌──────▼──────┐          │
│                       │ Redis       │          │
│                       │ (Port 6379) │          │
│                       │ - Cache     │          │
│                       │ - Persisted │          │
│                       │ - Health chk│          │
│                       └─────────────┘          │
│                                                 │
└─────────────────────────────────────────────────┘

🔍 Verification Steps

  1. Verify Docker installation:

    docker --version
docker-compose --version

  2. Start services:

    npm run docker:up

  3. Check service health:

    npm run docker:ps

  4. Test backend:

    curl http://localhost:3000/api

  5. Test database:

    docker-compose exec postgres psql -U sentinel_user -d sentinel_db -c "\dt"

  6. Test cache:

    docker-compose exec redis redis-cli ping

📚 Additional Notes

  • Volume Persistence: Data in PostgreSQL and Redis persists across container restarts
  • Hot Reload: Backend changes are reflected immediately without rebuilding
  • Network Isolation: Services communicate via internal Docker network
  • Security: Non-root user (nodejs) runs the backend container
  • Health Checks: All services have health checks for reliability
  • Signal Handling: Proper shutdown handling via dumb-init

🎯 Next Steps for Contributors

  1. Review DOCKER.md for detailed usage
  2. Start with npm run docker:up for local development
  3. Use provided npm scripts for common tasks
  4. Report any issues with Docker setup in GitHub Issues
  5. Update this documentation if improvements are found

📝 Support & Issues

For Docker-related questions:

  1. Check DOCKER.md troubleshooting section
  2. Review CONTRIBUTING.md
  3. Open an issue on GitHub

Setup completed on: 2026-06-12
Node version: 22 Alpine
PostgreSQL version: 16
Redis version: 7
Status: ✅ Ready for development