containerize-aspnetcore
Containerize an ASP.NET Core project by creating Dockerfile and .dockerfile files customized for the project.
By github · 8,885 installs
npx skills add github/awesome-copilot --skill containerize-aspnetcore
Source repository · Upstream listing
ASP.NET Core Docker Containerization Prompt
Containerization Request
Containerize the ASP.NET Core (.NET) project specified in the settings below, focusing exclusively on changes required for the application to run in a Linux Docker container. Containerization should consider all settings specified here.
Abide by best practices for containerizing .NET Core applications, ensuring that the container is optimized for performance, security, and maintainability.
Containerization Settings
This section of the prompt contains the specific settings and configurations required for containerizing the ASP.NET Core application. Prior to running this prompt, ensure that the settings are filled out with the necessary information. Note that in many cases, only the first few settings are required. Later settings can be left as defaults if they do not apply to the project being containerized.
Any settings that are not specified will be set to default values. The default values are provided in [square brackets] .
Basic Project Information
1. Project to containerize:
[ProjectName (provide path to .csproj file)]
2. .NET version to use:
[8.0 or 9.0 (Default 8.0)]
3. Linux distribution to use:
[debian, alpine, ubuntu, chiseled, or Azure Linux (mariner) (Default debian)]
4. Custom base image for the build stage of the Docker image ("None" to use standard Microsoft base image):
[Specify base image to use for build stage (Default None)]
5. Custom base image for the run stage of the Docker image ("None" to use standard Microsoft base image):
[Specify base image to use for run stage (Default None)]
Container Configuration
1. Ports that must be exposed in the container image:
Primary HTTP port: [e.g., 8080]
Additional ports: [List any additional ports, or "None"]
2. User account the container should run as:
[User account, or default to "$APP UID"]
3. Application URL configuration:
[Specify ASPNETCORE URLS, or default to "http://+:8080"]
Build configuration
1. Custom build steps that must be performed before building the container image:
[List any specific build steps, or "None"]
2. Custom build steps that must be performed after building the container image:
[List any specific build steps, or "None"]
3. NuGet package sources that must be configured:
[List any private NuGet feeds with authentication details, or "None"]
Dependencies
1. System packages that must be installed in the container image:
[Package names for the chosen Linux distribution, or "None"]
2. Native libraries that must be copied to the container image:
[Library names and paths, or "None"]
3. Additional .NET tools that must be installed:
[Tool names and versions, or "None"]
System Configuration
1. Environment variables that must be set in the container image:
[Variable names and values, or "Use defaults"]
File System
1. Files/directories that need to be copied to the container image:
[Paths relative to project root, or "None"]
Target location in container: [Container paths, or "Not applicable"]
2. Files/directories to exclude from containerization:
[Paths to exclude, or "None"]
3. Volume mount points that should be configured:
[Volume paths for persistent data, or "None"]
.dockerignore Configuration
1. Patterns to include in the .dockerignore file (.dockerignore will already have common defaults; these are additional patterns):
Additional patterns: [List any additional patterns, or "None"]
Health Check Configuration
1. Health check endpoint:
[Health check URL path, or "None"]
2. Health check interval and timeout:
[Interval and timeout values, or "Use defaults"]
Additional Instructions
1. Other instructions that must be followed to containerize the project:
[Specific requirements, or "None"]
2. Known issues to address:
[Describe any known issues, or "None"]
Scope
✅ App configuration modification to ensure application settings and connection strings can be read from environment variables
✅ Dockerfile creation and configuration for an ASP.NET Core application
✅ Specifying multiple stages in the Dockerfile to build/publish the application and copy the output to the final image
✅ Configuration of Linux container platform compatibility (Alpine, Ubuntu, Chiseled, or Azure Linux (Mariner))
✅ Proper handling of dependencies (system packages, native libraries, additional tools)
❌ No infrastructure setup (assumed to be handled separately)
❌ No code changes beyond those required for containerization
Execution Process
1. Review the containerization settings above to understand the containerization requirements
2. Create a progress.md file to track changes with check marks
3. Determine the .NET version from the project's .csproj file by checking the TargetFramework element
4. Select the appropriate Linux container image based on:
The .NET version detected from the project
The Linux distribution specified in containerization settings (Alpine, Ubuntu, Chiseled, or Azure Linux (Mariner))
If the user does not request specific base images in the containerization settings, then the base images MUST be valid mcr.microsoft.com/dotnet images with a tag as shown in the example Dockerfile, below, or in documentation
Official Microsoft .NET images for build and runtime stages:
SDK image tags (for build stage): https://github.com/dotnet/dotnet docker/blob/main/README.sdk.md
ASP.NET Core runtime image tags: https://github.com/dotnet/dotnet docker/blob/main/README.aspnet.md
.NET runtime image tags: https://github.com/dotnet/dotnet docker/blob/main/README.runtime.md
5. Create a Dockerfile in the root of the project directory to containerize the application
The Dockerfile should use multiple stages:
Build stage: Use a .NET SDK image to build the application
Copy csproj file(s) first
Copy NuGet.config if one exists and configure any private feeds
Restore NuGet packages
Then, copy the rest of the source code and build and publish the application to /app/publish
Final stage: Use the selected .NET runtime image to run the application
Set the working directory to /app
Set the user as directed (by default, to a non root user (e.g., $APP UID ))
Unless directed otherwise in containerization settings, a new user does not need to be created. Use the $APP UID variable to specify the user account.
Copy the published output from the build stage to the final image
Be sure to consider all requirements in the containerization settings:
.NET version and Linux distribution
Exposed ports
User account for container
ASPNETCORE URLS configuration
System package installation
Native library dependencies
Additional .NET tools
Environment variables
File/directory copying
Volume mount points
Health check configuration
6. Create a .dockerignore file in the root of the project directory to exclude unnecessary files from the Docker image. The .dockerignore file MUST include at least the following elements as well as additional patterns as specified in the containerization settings:
bin/
obj/
.dockerignore
Dockerfile
.git/
.github/
.vs/
.vscode/
/node modules/
.user
.suo
/.DS Store
/Thumbs.db
Any additional patterns specified in the containerization settings
7. Configure health checks if specified in the containerization settings:
Add HEALTHCHECK instruction to Dockerfile if health check endpoint is provided
Use curl or wget to check the health endpoint
8. Mark tasks as completed: [ ] → [✓]
9. Continue until all tasks are complete and Docker build succeeds
Build and Runtime Verification
Confirm that Docker build succeeds once the Dockerfile is completed. Use the following command to build the Docker image:
If the build fails, review the error messages and make necessary adjustments to the Dockerfile or project configuration. Report success/failure.
Progress Tracking
Maintain a progress.md file with the following structure:
Do not pause for confirmation between steps. Continue methodically until the application has been containerized and Docker build succeeds.
YOU ARE NOT DONE UNTIL ALL CHECKBOXES ARE MARKED! This includes building the Docker image successfully and addressing any issues that arise during the build process.
Example Dockerfile
An example Dockerfile for an ASP.NET Core (.NET) application using a Linux base image.
Adapting this Example
Note: Customize this template based on the specific requirements in containerization settings.
When adapting this example Dockerfile:
1. Replace YourProject.csproj , YourProject.dll , etc. with your actual project names
2. Adjust the .NET version and Linux distribution as needed
3. Modify the dependency installation steps based on your requirements and remove any unnecessary ones
4. Configure environment variables specific to your application
5. Add or remove stages as needed for your specific workflow
6. Update the health check endpoint to match your application's health check route
Linux Distribution Variations
Alpine Linux
For smaller image sizes, you can use Alpine Linux:
Ubuntu Chiseled
For minimal attack surface, consider using chiseled images:
Azure Linux (Mariner)
For Azure optimized containers:
Notes on Stage Naming
The AS stage name syntax gives each stage a name
Use from=stage name to copy files from a previous stage
You can have multiple intermediate stages that aren't used in the final image
The final stage is the one that becomes the final container image
Security Best Practices
Always run as a non root user in production
Use specific image tags instead of latest
Minimize the number of installed packages
Keep base images updated
Use multi stage builds to exclude build dependencies from the final image