Skip to content

runbook.md

Latest commit

 

History

History
51 lines (40 loc) · 1.16 KB

runbook.md

File metadata and controls

51 lines (40 loc) · 1.16 KB
Raw

Deployment Runbook

This runbook outlines steps to deploy the FakeStoreNet application.

Prerequisites

  • Docker and Docker Compose installed
  • .NET 8 SDK if building locally
  • Access to container registry (optional)

Deployment Steps

  1. Build Docker images:

    docker-compose build

  2. Start services:

    docker-compose up -d

  3. Verify containers:

    docker ps

  4. Apply database migrations:

    • Connect to the SQL Server container: 
      docker exec -it <db_container> /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "<YourPassword>"
    • Run migration scripts located in docs/infrastructure/migrations.

  5. Smoke test API endpoints:

    • GET http://localhost:5000/health
    • POST http://localhost:5000/products with sample payload

  6. Rollback

    • To stop and remove containers: 
      docker-compose down
    • To remove volumes if needed: 
      docker volume rm -f <volume_name>

Use this runbook to ensure consistent deployment across environments.
Document any environment-specific variables in .env files or CI/CD pipeline configuration.