Skip to content

DevOps Documentation

Welcome, DevOps engineers! This section contains everything you need to deploy, operate, and maintain the Portugal Odyssey platform infrastructure.

Quick Start

New to the infrastructure? Start here: 1. Deployment Overview - Understand deployment process 2. Infrastructure Overview - Learn about the infrastructure stack 3. Environments Guide - Set up Dev/Qual/Prod environments

Documentation Sections

🚀 Deployment

  • Environment setup (Dev/Qual/Prod)
  • Docker Compose configuration
  • CI/CD pipelines
  • VPS deployment guides

🏗️ Infrastructure

  • Docker configuration
  • Networking (Traefik, domains)
  • Databases (PostgreSQL, Redis)
  • Messaging (RabbitMQ)
  • Monitoring stack
  • Secret management

⚙️ Operations

  • Monitoring and alerting
  • Log aggregation
  • Backup and recovery
  • Scaling strategies

🔧 Troubleshooting

  • Common operational issues
  • Debugging procedures
  • Recovery steps

Quick Reference

Environment Setup

# Development
make dev

# Qualification
make qual

# Production
make prod

Common Commands

  • make networks - Create Docker networks
  • make infrastructure - Start infrastructure services
  • make deploy-vps-qual - Deploy to qualification VPS
  • make deploy-vps-prod - Deploy to production VPS

Key Infrastructure Components

Component Documentation Status
Docker infrastructure/docker.md ✅
Traefik infrastructure/networking.md ✅
PostgreSQL infrastructure/databases.md ✅
Redis infrastructure/databases.md ✅
RabbitMQ infrastructure/messaging.md ✅
Monitoring infrastructure/monitoring.md ✅

Deployment Workflows

Initial Setup

  1. Review Deployment Overview
  2. Configure Environment Variables
  3. Set up Secrets
  4. Deploy Infrastructure

CI/CD Pipeline

Production Deployment

  1. Review VPS Deployment Guide
  2. Verify Environment Configuration
  3. Execute deployment via Makefile targets
  4. Monitor Operations Dashboard

Context for AI Agents

This section is optimized for AI understanding:

  • Structure: Organized by operational workflow (deployment → infrastructure → operations)
  • Metadata: Each doc includes audience, category, and related infrastructure components
  • Cross-References: Infrastructure components link to deployment guides
  • Commands: Standardized Makefile and Docker commands throughout
  • Terminology: Consistent infrastructure terminology (see Glossary)

Common queries this section answers: - "How do I deploy to production?" - "How is the infrastructure configured?" - "What monitoring tools are used?" - "How do I troubleshoot deployment issues?" - "What are the environment differences?"

Need Help? Check Troubleshooting or review Operations Guide.