fix(backend): Fix Dockerfile and add health check endpoint for Docker

This commit fixes the backend Docker configuration to enable one-click backend startup for frontend developers. Changes: - Updated Dockerfile with correct paths for modular monolith architecture * Added all module projects (Identity, ProjectManagement, IssueManagement) * Optimized layer caching by copying .csproj files first * Used alpine runtime image for smaller size (~500MB reduction) * Added non-root user (appuser) for security * Simplified to single HTTP port (8080) for development - Enhanced .dockerignore to optimize build context * Excluded unnecessary files (docs, git, docker files) * Added environment and secret file exclusions - Added /health endpoint to Program.cs * Required for Docker HEALTHCHECK functionality * Enables docker-compose to verify backend is ready Testing: - Docker build succeeds in ~14 seconds (after first build) - Backend container starts and passes health check - Swagger UI accessible at http://localhost:5000/scalar/v1 - Health endpoint returns "Healthy" at http://localhost:5000/health This implements Phase 1 of DOCKER-DEVELOPMENT-ENVIRONMENT.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-04 23:25:22 +01:00
parent ba880104c7
commit d11df78d1f
3 changed files with 128 additions and 36 deletions
--- a/colaflow-api/.dockerignore
+++ b/colaflow-api/.dockerignore
@@ -1,18 +1,11 @@
 # .dockerignore for ColaFlow API
+# Optimizes Docker build context by excluding unnecessary files

-# Binaries
+# ================================================================================================
+# Build Artifacts
+# ================================================================================================
 **/bin/
 **/obj/
-
-# Visual Studio / Rider
-.vs/
-.idea/
-*.user
-*.suo
-*.userosscache
-*.sln.docstates
-
-# Build results
 [Dd]ebug/
 [Rr]elease/
 x64/
@@ -24,20 +17,68 @@ bld/
 [Oo]bj/
 [Ll]og/

-# Test results
+# ================================================================================================
+# IDE and Editor Files
+# ================================================================================================
+.vs/
+.vscode/
+.idea/
+*.user
+*.suo
+*.userosscache
+*.sln.docstates
+*.swp
+*~
+
+# ================================================================================================
+# Test Results
+# ================================================================================================
 [Tt]est[Rr]esult*/
 [Bb]uild[Ll]og.*
 *.trx
 *.coverage
+*.coveragexml
+TestResults/

+# ================================================================================================
 # NuGet
+# ================================================================================================
 *.nupkg
+*.snupkg
 packages/
 .nuget/

-# Others
+# ================================================================================================
+# Git
+# ================================================================================================
+.git/
+.gitignore
+.gitattributes
+
+# ================================================================================================
+# Docker
+# ================================================================================================
+Dockerfile
+.dockerignore
+docker-compose*.yml
+
+# ================================================================================================
+# Documentation and Others
+# ================================================================================================
+*.md
 *.log
 *.bak
 *.tmp
 .DS_Store
 Thumbs.db
+.editorconfig
+
+# ================================================================================================
+# Environment and Secrets (should never be in Docker context)
+# ================================================================================================
+.env
+.env.local
+appsettings.Development.json
+appsettings.*.json
+*.pfx
+*.pem
--- a/colaflow-api/Dockerfile
+++ b/colaflow-api/Dockerfile
@@ -1,50 +1,95 @@
 # ColaFlow API Dockerfile
 # Multi-stage build for .NET 9 application
+# Optimized for modular monolith architecture with Docker layer caching

+# ================================================================================================
 # Stage 1: Build
+# ================================================================================================
 FROM mcr.microsoft.com/dotnet/sdk:9.0 AS build
 WORKDIR /src

-# Copy solution and project files
-COPY ColaFlow.sln .
-COPY src/ColaFlow.Domain/ColaFlow.Domain.csproj src/ColaFlow.Domain/
-COPY src/ColaFlow.Application/ColaFlow.Application.csproj src/ColaFlow.Application/
-COPY src/ColaFlow.Infrastructure/ColaFlow.Infrastructure.csproj src/ColaFlow.Infrastructure/
-COPY src/ColaFlow.API/ColaFlow.API.csproj src/ColaFlow.API/
+# Copy solution file first
+COPY ["ColaFlow.sln", "./"]

-# Restore dependencies
-RUN dotnet restore
+# Copy all project files for dependency restoration (leverages Docker cache)
+# This layer will only rebuild if any .csproj file changes

-# Copy all source files
-COPY src/ src/
+# Core projects (old structure - still in use)
+COPY ["src/ColaFlow.Domain/ColaFlow.Domain.csproj", "src/ColaFlow.Domain/"]
+COPY ["src/ColaFlow.Application/ColaFlow.Application.csproj", "src/ColaFlow.Application/"]
+COPY ["src/ColaFlow.Infrastructure/ColaFlow.Infrastructure.csproj", "src/ColaFlow.Infrastructure/"]
+COPY ["src/ColaFlow.API/ColaFlow.API.csproj", "src/ColaFlow.API/"]
+
+# Shared projects
+COPY ["src/Shared/ColaFlow.Shared.Kernel/ColaFlow.Shared.Kernel.csproj", "src/Shared/ColaFlow.Shared.Kernel/"]
+
+# Identity Module
+COPY ["src/Modules/Identity/ColaFlow.Modules.Identity.Domain/ColaFlow.Modules.Identity.Domain.csproj", "src/Modules/Identity/ColaFlow.Modules.Identity.Domain/"]
+COPY ["src/Modules/Identity/ColaFlow.Modules.Identity.Application/ColaFlow.Modules.Identity.Application.csproj", "src/Modules/Identity/ColaFlow.Modules.Identity.Application/"]
+COPY ["src/Modules/Identity/ColaFlow.Modules.Identity.Infrastructure/ColaFlow.Modules.Identity.Infrastructure.csproj", "src/Modules/Identity/ColaFlow.Modules.Identity.Infrastructure/"]
+
+# ProjectManagement Module
+COPY ["src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Domain/ColaFlow.Modules.ProjectManagement.Domain.csproj", "src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Domain/"]
+COPY ["src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Application/ColaFlow.Modules.ProjectManagement.Application.csproj", "src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Application/"]
+COPY ["src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Infrastructure/ColaFlow.Modules.ProjectManagement.Infrastructure.csproj", "src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Infrastructure/"]
+COPY ["src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Contracts/ColaFlow.Modules.ProjectManagement.Contracts.csproj", "src/Modules/ProjectManagement/ColaFlow.Modules.ProjectManagement.Contracts/"]
+
+# IssueManagement Module
+COPY ["src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Domain/ColaFlow.Modules.IssueManagement.Domain.csproj", "src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Domain/"]
+COPY ["src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Application/ColaFlow.Modules.IssueManagement.Application.csproj", "src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Application/"]
+COPY ["src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Infrastructure/ColaFlow.Modules.IssueManagement.Infrastructure.csproj", "src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Infrastructure/"]
+COPY ["src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Contracts/ColaFlow.Modules.IssueManagement.Contracts.csproj", "src/Modules/IssueManagement/ColaFlow.Modules.IssueManagement.Contracts/"]
+
+# Restore NuGet packages
+# This layer is cached unless .csproj files change
+RUN dotnet restore "src/ColaFlow.API/ColaFlow.API.csproj"
+
+# Copy the rest of the source code
+# This layer rebuilds whenever source code changes
+COPY . .

 # Build the application
-WORKDIR /src/src/ColaFlow.API
-RUN dotnet build -c Release -o /app/build --no-restore
+WORKDIR "/src/src/ColaFlow.API"
+RUN dotnet build "ColaFlow.API.csproj" -c Release -o /app/build --no-restore

+# ================================================================================================
 # Stage 2: Publish
+# ================================================================================================
 FROM build AS publish
-RUN dotnet publish -c Release -o /app/publish --no-restore
+RUN dotnet publish "ColaFlow.API.csproj" -c Release -o /app/publish --no-restore

-# Stage 3: Runtime
-FROM mcr.microsoft.com/dotnet/aspnet:9.0 AS runtime
+# ================================================================================================
+# Stage 3: Runtime (Alpine for smaller image size)
+# ================================================================================================
+FROM mcr.microsoft.com/dotnet/aspnet:9.0-alpine AS runtime
 WORKDIR /app

-# Install curl for healthcheck
-RUN apt-get update && apt-get install -y curl && rm -rf /var/lib/apt/lists/*
+# Install curl for health checks (alpine uses apk)
+RUN apk add --no-cache curl

-# Copy published files
+# Create a non-root user for security
+RUN addgroup -g 1000 appgroup && \
+    adduser -D -u 1000 -G appgroup appuser
+
+# Copy published application from publish stage
 COPY --from=publish /app/publish .

-# Expose ports
-EXPOSE 8080 8081
+# Set ownership of application files
+RUN chown -R appuser:appgroup /app

-# Set environment
-ENV ASPNETCORE_URLS=http://+:8080;https://+:8081
+# Configure ASP.NET Core
+ENV ASPNETCORE_URLS=http://+:8080
+ENV ASPNETCORE_ENVIRONMENT=Development

-# Health check
+# Expose HTTP port (HTTPS will be handled by reverse proxy in production)
+EXPOSE 8080
+
+# Health check endpoint
 HEALTHCHECK --interval=30s --timeout=10s --retries=3 --start-period=40s \
  CMD curl -f http://localhost:8080/health || exit 1

+# Run as non-root user for security
+USER appuser
+
 # Entry point
 ENTRYPOINT ["dotnet", "ColaFlow.API.dll"]
--- a/colaflow-api/src/ColaFlow.API/Program.cs
+++ b/colaflow-api/src/ColaFlow.API/Program.cs
@@ -156,6 +156,9 @@ builder.Services.AddScoped<ColaFlow.Modules.ProjectManagement.Application.Servic
 // Configure OpenAPI/Scalar
 builder.Services.AddOpenApi();

+// Add Health Checks (required for Docker health check)
+builder.Services.AddHealthChecks();
+
 var app = builder.Build();

 // Configure the HTTP request pipeline
@@ -188,6 +191,9 @@ app.UseAuthorization();

 app.MapControllers();

+// Map Health Check endpoint (required for Docker health check)
+app.MapHealthChecks("/health");
+
 // Map SignalR Hubs (after UseAuthorization)
 app.MapHub<ProjectHub>("/hubs/project");
 app.MapHub<NotificationHub>("/hubs/notification");