Build and Deploy a Microsoft .NET Core Web API application to AWS App Runner using CloudFormation
In this blog we show you how to build a Microsoft.NET Web API application with Amazon Aurora Database using AWS App Runner. AWS App Runner makes it easy for developers to quickly deploy containerized web applications and APIs, and helps us start with our source code or a container image.
Container workload management tasks, such as managing deployments, scaling infrastructure, or keeping it updated, can get cumbersome. AWS App Runner is a great alternative for customers without any prior containers or infrastructure experience, as it is a fully managed service that takes care of building and deploying your application, load balancing traffic, or autoscaling up or down per your application needs. App Runner retrieves your source code from GitHub or source image from Amazon ECR repository in your AWS account, and creates and maintains a running web service for you in the AWS Cloud.
Recently, App Runner introduced Amazon Virtual Private Cloud (VPC) support. With this feature, you don’t need to have your AWS services publicly accessible. App Runner applications can connect to private endpoints in your VPC, and you can enable a more secure and compliant environment by removing public access to these resources. Check out this post to learn more about how to enable a more secure and compliant environment by removing public access to these resources.
You can connect App Runner services to databases in Amazon Relational Database Service (RDS), Redis or Memcached caches in Amazon ElastiCache, or your own applications running in Amazon Elastic Container Service (Amazon ECS), Amazon Elastic Kubernetes Service (EKS), Amazon Elastic Compute Cloud (Amazon EC2), or on-premises and connected via AWS Direct Connect. The VPC connectors in App Runner work similarly to VPC networking in AWS Lambda and are based on AWS Hyperplane, the internal Amazon network function virtualization system behind AWS services and resources like Network Load Balancer, NAT Gateway, and AWS PrivateLink.
Microsoft workloads have a lot of Web APIs that are native to Microsoft methods for serving front-end applications (like ASP.NET, ASP.NET Razor/MVC, ReactJS or Angular Application). These applications traditionally talk to Microsoft SQL Server database for CRUD operations. Entity Framework Core (EF) Core is a lightweight, extensible, open source and cross-platform version of the popular Entity Framework data access technology. EF Core can serve as an object-relational mapper (O/RM), which enables .NET developers to work with a database using .NET objects. This helps to eliminate the need for most of the data-access code that typically needs to be written. We use MySql.EntityFramework to connect to Amazon RDS in this blog.
Many of these existing .NET Core applications can be containerized using Docker and AWS services like Amazon EC2/ Amazon Elastic Container Service (ECS)/ Amazon Elastic Kubernetes Service (Amazon EKS), and can interface with databases like Amazon Aurora Database providing a full blown API application system. In our previous blogs, we showed you how to build a similar Microsoft.NET Web API application with Amazon Aurora Database using AWS CloudFormation and AWS CDK. In this blog the application architecture is complemented by build tools like AWS CodeCommit AWS CodeBuild using AWS CloudFormation. We will create a simple Microsoft .NET Web API for a ToDo Application. See below, the solution architecture diagram of Microsoft .NET Core Web API Application Orchestration . The sample ToDo application will communicate with an Amazon Aurora Serverless database for basic CRUD operations. Provided CloudFormation templates will build a Web API deployed in AWS App Runner connecting to a RDS Aurora back-end.
AWS services used in this solution
- Amazon Aurora Serverless is an on-demand, auto-scaling configuration for Amazon Aurora. It automatically starts up, shuts down, and scales capacity up or down based on your application’s needs.
- AWS App Runner is a managed service that makes it easy for developers to quickly deploy containerized web applications and APIs is used using Docker template containers and allows you to easily run and scale containerized applications on AWS. The ToDo solution for this blog post includes a sample Dockerfile for a .NET Core 3.1 application. Web API code uses AWS SDK Packages like System Manager, MySql EntityFrameworkCore to interact with the database.
- Amazon Elastic Container Registry (ECR), the AWS provided Docker container registry is used and integrated with App Runner, simplifying the development to production workflow.
- AWS CodeBuild is used to manage the continuous integration of development code into Amazon ECR as a containerized image.
- AWS CodeCommit is used as the code repository and integrates with AWS CodeBuild for continuous integration process.
Docker Containers to deploy the Microsoft .NET Web API Application. Make sure Docker daemon is running if you are trying to run the manual scripts (that builds application image and pushes to Amazon ECR). The following are required to setup your development environment:
- AWS CLI
- Dotnet CLI: Web API application was built using Microsoft .NET core 3.1. Please refer Microsoft Documentation for installation.
- Docker: Install Docker depending on your hardware specification. Make sure the docker daemon is running
- Additionally, we use AWS SDK, MySql data packages for the Microsoft .NET project and have added them as nuget packages to the solution. In this solution, we use Mysql data to connect to MySql/Aurora database and also AWS SDK Systems Manager to connect to Amazon Systems Manager.
<PackageReference Include="AWSSDK.SimpleSystemsManagement" Version="3.3.106" /> <PackageReference Include="Amazon.Extensions.Configuration.SystemsManager" Version="1.2.0" /> <PackageReference Include="MySql.EntityFrameworkCore" Version="3.1.10+m8.0.23" />
Below section will provide steps to provision the infrastructure (and services) and deploy the application. Upon deploying the solution, two AWS CloudFormation stacks namely “net-core-stack-ecr” and “net-core-stack-infra” will be created. CI/CD is achieved through buildspec.yaml file for subsequent checkins on the AWS CodeCommit repo that will be used by the AWS CodeBuild.
Clone the code
- Clone the solution code which contains .net api and CloudFormation templates from this GitHub location. The source code includes two folders — ‘code’ and ‘config’. The ‘code’ folder has the necessary .NET ToDo Web API solution, and the config folder has the AWS CloudFormation templates, and the script files used for deployment.
- config/net-core-app-ecr.yaml – This template spins up Amazon ECR.
- config/net-core-app-infra.yaml – This template creates a new VPC with Amazon RDS, AWS App Runner, AWS CodeBuild, AWS CodeCommit, Amazon Systems Manager.
- config/buildspec.yaml – This yaml is used by CodeBuild. Steps include building the dotnet application, pushes the image to AWS ECR. Upon pushing a new image to AWS ECR, App Runner will redeploy/re-run the application which will be exposed as an endpoint.
- config/exec_docker.sh – Used by “exec.sh” script when creating the infrastructure for the first time.
- exec.sh (root folder) – This script is used only during the initial setup to push the dotnet application image to AWS ECR. Provide your AWS Account Number to the script as input. Make sure to setup “aws configure” in the cli to the same account number before executing this script.
- cleanup.sh (root folder) – This script is used to clean up the entire deployment for this solution.
This solution can be provisioned in two ways: fully automated with the provided script(s) (option 1) or can be installed using cli commands (option 2).
Option 1: Run the “exec.sh”
chmod +x exec.sh
You will notice two CloudFormation stacks are created (net-core-stack-ecr and net-core-stack-infra). Output of the net-core-stack-infra will provide AWS App Runner Service Url endpoint. Take a few moments to review the services that are spun up in the AWS CloudFormation console.
Option 2: Deploy individual CloudFormation stacks and push image to ECR
Deploy Amazon ECR CloudFormation stack (config/net-core-app-ecr.yaml)
aws cloudformation create-stack --stack-name net-core-stack-ecr --template-body file://config/net-core-app-ecr.yaml --capabilities CAPABILITY_NAMED_IAM --parameters ParameterKey=AppStackName,ParameterValue=net-core-stack-ecr
Build and Deploy application code to Amazon ECR
cd code dotnet build . ECR_REPO=net-core-stack-repo ACCOUNT_NUMBER=<YOUR_ACCOUNT_NUMBER> REGION=us-east-1 APP_SVC=todo/apprunnerdotnetsvc ### build the AWS App Runner docker image, tag and push it to AWS ECR docker build -t $APP_SVC . docker tag $APP_SVC $ACCOUNT_NUMBER.dkr.ecr.us-east-1.amazonaws.com/$ECR_REPO:latest aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $ACCOUNT_NUMBER.dkr.ecr.$REGION.amazonaws.com docker push $ACCOUNT_NUMBER.dkr.ecr.us-east-1.amazonaws.com/$ECR_REPO:latest cd ..
Deploy the other CloudFormation stack for infra/services needed for the solution (config/net-core-app-infra.yaml)
aws cloudformation create-stack --stack-name net-core-stack-infra --template-body file://config/net-core-app-infra.yaml --capabilities CAPABILITY_NAMED_IAM --parameters ParameterKey=AppStackName,ParameterValue=net-core-stack-infra
With the above deployment we have successful setup a CICD solution which will enable you to make further updates to the dotnet application code and manage automatic deployment to AWS App Runner. You can clone the code from AWS CodeCommit into a local folder and make updates as needed.
Below are commands to clone and push updates to AWS CodeCommit:
# set source directory where you have this current code downloaded from github
# copy and git push steps to codecommit
git clone https://git-codecommit.us-east-1.amazonaws.com/v1/repos/net-core-stack-ecr-repo
mkdir codecommit/net-core-stack-ecr-repo/code codecommit/net-core-stack-ecr-repo/config
cp -R SOURCE_DIR/code/* codecommit/net-core-stack-ecr-repo/code
cp -R SOURCE_DIR/config/* codecommit/net-core-stack-ecr-repo/config
git add .
git commit -m "test cicd commit"
Verify by visiting the App Runner console to view the application (net-core-stack-apprunner-svc) that has been deployed. In the application, visit the “Logs” tab to view the details about service creation, image pull from ECR, health check on port 8080 before routing traffic to application. A sample Event log will be as below.
02-02-2022 04:00:28 PM [AppRunner] Service status is set to RUNNING.
02-02-2022 04:00:28 PM [AppRunner] Service creation completed successfully.
02-02-2022 04:00:27 PM [AppRunner] Successfully routed incoming traffic to application.
02-02-2022 03:59:56 PM [AppRunner] Health check is successful. Routing traffic to application.
02-02-2022 03:58:59 PM [AppRunner] Performing health check on port '8080'.
02-02-2022 03:58:51 PM [AppRunner] Provisioning instances and deploying image.
02-02-2022 03:58:39 PM [AppRunner] Successfully pulled image from ECR.
02-02-2022 03:56:54 PM [AppRunner] Successfully created pipeline for automatic deployments.
02-02-2022 03:56:35 PM [AppRunner] Service status is set to OPERATION_IN_PROGRESS.
02-02-2022 03:56:35 PM [AppRunner] Service creation started.
Go to AWS CloudFormation console and in the Infra stack output tab get the “AppRunnerServiceUrl” to test the health check api on a browser. A sample url will be like – http://gcdpsgaztx.us-east-1.awsapprunner.com/api/values
To test the application endpoint, you can use tools like Postman, ARC Rest Client or Browser extensions like RestMan. Select “content-type” as “application/json”, POST as raw data/json – sample input below -https:///api/todo
"Task": "new ToDo Application",
Use the same url and fire a GET call to see the previously posted todo item as response.
Option 1: You can run the provided “cleanup.sh” to clean up the entire solution
chmod +x cleanup.sh .\cleanup.sh
Option 2: If you like to individually execute the following commands.
aws ecr batch-delete-image --repository-name net-core-stack-ecr-repo --image-ids imageTag=latest aws ecr batch-delete-image --repository-name net-core-stack-ecr-repo --image-ids imageTag=untagged`Delete the entire infrastructure
aws cloudformation delete-stack --stack-name net-core-stack-ecr aws cloudformation delete-stack --stack-name net-core-stack-infra
- AWS CloudFormation Stacks Failure: If you notice any of the CloudFormation stack failures below steps would help to triage.
- ecr-stack: Make sure Docker daemon is running; Check the CloudFormation “Outputs” of the ecr-stack to verify the ECR arn. Look at the Events tab to see if any failures have occurred.
- infra stack: Review the AWS service limits. Ex: 5 VPCs per region; Make sure ECR stack is created with docker image (application code as docker container images in there). Look at the Events tab to see if any failures have occurred.
- RDSCluster Connectivity
- Use AWS RDS console to verify the new RDS cluster. Connectivity to RDS Endpoints/credentials will be in AWS Systems Manager.
- Table/Model entity will not be created unless ToDo Url POST is triggered.
- Note: Inactivity in Aurora Serverless – RDS Table could put the RDS in suspended state to reduce the cost. You might receive a communication error after no activity while trying to invoke the database DDL/DML statements. If the application provided API times out (especially after the initial setup, you may have to invoke the POST/GET call invoke on the /api/todo endpoint). You might notice this by connecting to the SQL in Query Editor with below output.Retrying the select queries will warm up the RDS database for subsequent connection to be served.
Communications link failure The last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.
- AWS AppRunner
- Verify App Runner application “Event Logs” and “Deployment logs”.
- By default, the application is coded to run in port 8080. Make sure they are seen in application log.
- Check the health check url to see the test endpoint
- Check the ToDo Url to post the data from tools like Postman or RestMan (Google Chrome/MS Edge plugin). Check if the data is available in RDS database.
To recap, in this post we built and deployed an ASP.NET Core Web API application that interacts with various AWS Services. We also walked through in this example how to deploy Microsoft .NET Core application code as containers with infrastructure as code. We encourage you to test this example and see for yourself how this overall application design works within AWS. Then, it will be just the matter of replacing your individual code base (buildspec/WebAPI, MVC, or other Microsoft .NET core application) and package them as Docker container and let the AWS App Runner handle the process efficiently.
If you implement this example and run into any issues, or have any questions or feedback about this blog please provide your comments below!
- AWS App Runner Documentation
- New for App Runner – VPC Support | AWS News Blog (amazon.com)
- Networking with App Runner – AWS App Runner (amazon.com)
- Developing a Microsoft .NET Core Web API application with Aurora Database using CloudFormation
- Build and deploy a Spring Boot application to AWS App Runner with a CI/CD pipeline using Terraform
About the Authors
Sivasubramanian Ramani (Siva Ramani) is a Sr Cloud Application Architect at AWS. His expertise is in application optimization, serverless solutions and using Microsoft application workloads with AWS.
Naveen Balaraman is a Cloud Application Architect at Amazon Web Services. He is passionate about Containers, serverless Applications, Architecting Microservices and helping customers leverage the power of AWS cloud.