feat: add multi-stage Dockerfile for building and running app #230
Conversation
WalkthroughA multi-stage Dockerfile was added to build and run a .NET 8.0 ASP.NET Core Web API application, including steps for dependency restoration, publishing, and secure runtime configuration. The Dockerfile sets up environment variables, user permissions, and exposes the application on port 9000. A new Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant Docker
participant .NET SDK Image
participant .NET Runtime Image
participant Web API App
Developer->>Docker: docker build -t aspnetcore-app .
Docker->>.NET SDK Image: Restore dependencies, publish app
.NET SDK Image-->>Docker: Published output
Docker->>.NET Runtime Image: Copy published app, set up environment
.NET Runtime Image-->>Docker: Ready-to-run container
Developer->>Docker: docker run -p 9000:9000 aspnetcore-app
Docker->>.NET Runtime Image: Start container
.NET Runtime Image->>Web API App: dotnet WebApiApp.dll
Web API App-->>Developer: API available on port 9000
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
Dockerfile (5)
1-4: Use specific base image tags for reproducible builds
Consider pinning the SDK image to a specific patch version (e.g., 8.0.x) to avoid unexpected upstream changes and ensure build reproducibility.Apply a diff like:
-FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build +FROM mcr.microsoft.com/dotnet/sdk:8.0.100 AS build
10-13: Optimize publish step by skipping redundant restore
Since dependencies were already restored, you can add--no-restoreto the publish command to leverage the cached layers and speed up the build.-RUN dotnet publish -c Release -o /app/publish +RUN dotnet publish -c Release --no-restore -o /app/publish
15-18: Consider slimmer or pinned runtime image
You might use a smaller variant (e.g.,aspnet:8.0-alpine) or pin the runtime image to a specific patch version for consistency. This can reduce the final image size.Example:
-FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS runtime +FROM mcr.microsoft.com/dotnet/aspnet:8.0.0-alpine AS runtime
20-23: Add EXPOSE for port metadata
Including anEXPOSE 9000instruction helps tools and documentation consumers detect the service port.WORKDIR /app +EXPOSE 9000 # Copy published output COPY --from=build /app/publish .
31-35: Enhance reliability with HEALTHCHECK and ENV consolidation
- Combine environment variables into one layer to reduce image size.
- If you have a health endpoint (e.g.,
/health), add aHEALTHCHECKto monitor container health.-ENV ASPNETCORE_URLS=http://+:9000 -ENV ASPNETCORE_ENVIRONMENT=Production +ENV ASPNETCORE_URLS=http://+:9000 \ + ASPNETCORE_ENVIRONMENT=Production +HEALTHCHECK --interval=30s --timeout=5s \ + CMD curl -f http://localhost:9000/health || exit 1README.md (1)
37-52: Expand container usage guidance
Consider enriching the “Container” section with best-practice examples, such as detached mode, environment overrides, and mounting a host volume for the SQLite database. This helps users run the container in real‐world scenarios.Example:
docker run -d \ -p 9000:9000 \ -e ASPNETCORE_ENVIRONMENT=Production \ -v $(pwd)/Data:/app/Data \ aspnetcore-app
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
Dockerfile(1 hunks)README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Analyze (csharp)
🔇 Additional comments (2)
Dockerfile (1)
25-28: Non-root user for improved security
Great job adding a non-rootaspnetcoreuser and updating ownership. This hardens the container by dropping root privileges.README.md (1)
29-29: Clarify development-only documentation
Renaming the section to “Documentation (Development-only)” clearly signals that Swagger UI should not be exposed in production.
|
Summary by CodeRabbit
New Features
.dockerignorefile to optimize Docker build contexts by excluding unnecessary files.Documentation