.NET Core CI/CD pipeline with delivery to AWS Fargate on the AWS Cloud

Quick Start Reference Deployment

QS

January 2022
Andy Hopper, AWS Microsoft Specialist SA Team

Visit our GitHub repository for source files and to post feedback, report bugs, or submit feature ideas for this Quick Start.

This Quick Start was created by Amazon Web Services (AWS). Quick Starts are automated reference deployments that use AWS CloudFormation templates to deploy key technologies on AWS, following AWS best practices.

Overview

This guide provides instructions for deploying the .NET Core CI/CD pipeline with delivery to AWS Fargate Quick Start reference architecture on the AWS Cloud.

This Quick Start is for users who want to create a continuous integration and continuous deployment (CI/CD) pipeline for a .NET application in their AWS environment using the AWS portfolio of DevOps services. This Quick Start follows best practices to create a CI/CD pipeline that automatically builds and deploys a .NET application to Fargate. You can use this Quick Start as both a reference architecture and a template for creating a fully implemented CI/CD pipeline for deploying a .NET application to Fargate. To deploy the application to Fargate, you upload the application’s source code to the code repository created by the Quick Start.

.NET Core CI/CD pipeline with delivery to AWS Fargate on AWS

This Quick Start deploys a complete CI/CD pipeline that uses the AWS portfolio of DevOps services to build and deploy a containerized .NET application. The Quick Start also demonstrates how to use Fargate to host a containerized application using a fully managed AWS infrastructure.

AWS costs

You are responsible for the cost of the AWS services and any third-party licenses used while running this Quick Start. There is no additional cost for using the Quick Start.

The AWS CloudFormation templates for Quick Starts include configuration parameters that you can customize. Some of the settings, such as the instance type, affect the cost of deployment. For cost estimates, see the pricing pages for each AWS service you use. Prices are subject to change.

After you deploy the Quick Start, create AWS Cost and Usage Reports to deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. These reports provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information, see What are AWS Cost and Usage Reports?

Software licenses

No licenses are required to deploy this Quick Start. All AWS service resources consumed during the launch of the Quick Start incur AWS service usage costs.

Architecture

Deploying this Quick Start for a new virtual private cloud (VPC) with default parameters builds the following .NET Core CI/CD pipeline with delivery to AWS Fargate environment in the AWS Cloud.

Architecture
Figure 1. Quick Start architecture for .NET Core CI/CD pipeline with delivery to AWS Fargate on AWS

As shown in Figure 1, the Quick Start sets up the following:

  • A highly available architecture that spans two Availability Zones.

  • A VPC configured with public and private subnets, according to AWS best practices, to provide you with your own virtual network on AWS.

  • AWS CodePipeline to create a pipeline with source, build, and deploy stages. The pipeline is invoked when a developer commits a code change to the CodeCommit repository.

    • AWS CodeCommit to host the application source code in a Git repository.

    • AWS CodeBuild to serve as a CodePipeline stage for performing the build process for a container image.

    • Amazon Elastic Container Service (Amazon ECS) to deploy the updated application container image.

  • Amazon Simple Storage Service (Amazon S3) to store AWS CodePipeline artifacts.

  • AWS Identity and Access Management (IAM) roles for the CI/CD pipeline’s build and deployment process.

  • In the public subnets, managed network address translation (NAT) gateways to allow outbound internet access for resources in the private subnets.

  • In the private subnets:

    • AWS Fargate tasks to host the containers using Amazon ECS.

    • An Application Load Balancer to direct traffic to the Fargate cluster.

Planning the deployment

Specialized knowledge

This deployment requires a moderate level of familiarity with AWS services. If you’re new to AWS, see Getting Started Resource Center and AWS Training and Certification. These sites provide materials for learning how to design, deploy, and operate your infrastructure and applications on the AWS Cloud.

Even though this Quick Start provides the required steps to deploy containerized applications to Fargate, you should be familiar with .NET and how to build containerized applications using Docker multi-stage builds.

AWS account

If you don’t already have an AWS account, create one at https://aws.amazon.com by following the on-screen instructions. Part of the sign-up process involves receiving a phone call and entering a PIN using the phone keypad.

Your AWS account is automatically signed up for all AWS services. You are charged only for the services you use.

Technical requirements

Before you launch the Quick Start, review the following information and ensure that your account is properly configured. Otherwise, deployment might fail.

Resource quotas

If necessary, request service quota increases for the following resources. You might need to request increases if your existing deployment currently uses these resources and if this Quick Start deployment could result in exceeding the default quotas. The Service Quotas console displays your usage and quotas for some aspects of some services. For more information, see What is Service Quotas? and AWS service quotas.

Resource This deployment uses

Amazon Simple Storage Service (S3) buckets

1

AWS CloudFormation Stacks

2

VPCs

1

Subnets

4

Elastic IP addresses

2

Managed NAT Gateways

2

Security groups

2

AWS Identity and Access Management (IAM) roles

3

Application Load Balancers

1

Amazon Elastic Container Registries

1

Amazon ECS Clusters

1

Amazon ECS Services

1

Amazon ECS Task Definitions

1

Amazon CloudWatch Log Group

1

AWS CodeCommit Repository

1

AWS CodePipeline Pipeline

1

AWS CodeBuild Projects

1

Supported AWS Regions

For any Quick Start to work in a Region other than its default Region, all the services it deploys must be supported in that Region. You can launch a Quick Start in any Region and see if it works. If you get an error such as “Unrecognized resource type,” the Quick Start is not supported in that Region.

For an up-to-date list of AWS Regions and the AWS services they support, see AWS Regional Services.

Certain Regions are available on an opt-in basis. For more information, see Managing AWS Regions.

IAM permissions

Before launching the Quick Start, you must sign in to the AWS Management Console with IAM permissions for the resources that the templates deploy. The AdministratorAccess managed policy within IAM provides sufficient permissions, although your organization may choose to use a custom policy with more restrictions. For more information, see AWS managed policies for job functions.

Deployment options

This Quick Start builds a new AWS environment consisting of the VPC, subnets, NAT gateways, security groups, and other infrastructure components. It then deploys .NET Core CI/CD pipeline with delivery to AWS Fargate into this new VPC. For more details about the resources this Quick Start deploys, see the Architecture section.

Prepare your AWS account

Verify that your AWS account has the permissions required to create the resources listed in the Resource quotas section of this guide.

Deployment steps

Confirm your AWS account configuration

  1. Sign in to your AWS account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For details, see Planning the deployment in this guide.

  2. Ensure that your AWS account is configured correctly, as discussed in the Technical requirements section.

Launch the Quick Start

If you deploy .NET Core CI/CD pipeline with delivery to AWS Fargate into an existing VPC, ensure that your VPC has two private subnets in different Availability Zones for the workload instances and that the subnets are not shared. This Quick Start does not support shared subnets. The subnets require NAT gateways in their route tables to allow the instances to download packages and software without exposing the instances to the internet. Also ensure that the domain name in the DHCP options is configured, as explained in DHCP options sets. Provide your VPC settings when you launch the Quick Start.

Each deployment takes about 15 minutes to complete.

  1. Sign in to your AWS account, and launch the following AWS CloudFormation template: Deploy .NET Core CI/CD pipeline with delivery to AWS Fargate into a new VPC on AWS. You can also view the template.

  2. Check the AWS Region that’s displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where you build the infrastructure. The template is launched in the us-east-1 Region by default. For more information, see Supported AWS Regions earlier in this guide.

  3. On the Create stack page, keep the default setting for the template URL, and then choose Next.

  4. On the Specify stack details page, change the stack name if needed. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. When you finish reviewing and customizing the parameters, choose Next.

  5. On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you finish, choose Next.

  6. On the Review page, review and confirm the template settings. Under Capabilities, select the two check boxes to acknowledge that the template creates IAM resources and might require the ability to automatically expand macros.

  7. Choose Create stack to deploy the stack.

  8. Monitor the status of the stack. When the status is CREATE_COMPLETE, the .NET Core CI/CD pipeline with delivery to AWS Fargate deployment is ready.

  9. To view the created resources, see the values displayed in the Outputs tab for the stack.

Test the deployment

This Quick Start includes CloudFormation output parameters that provide links to the infrastructure deployed by the Quick Start:

Output Description

RepoUrl

The URL to GitHub for creating a clone of the CodeCommit repository.

LoadBalancerUrl

The URL for the Application Load Balancer in front of the Fargate service.

CodePipelineUrl

The URL to navigate directly to the CodePipeline pipeline for the application.

After deploying this Quick Start, a build of the application starts. You can use your browser to navigate to the CodePipeline URL to monitor the build process. After the build completes, you can navigate to the Application Load Balancer URL to view the application in your browser.

Post-deployment steps

After you’ve deployed this Quick Start, you can use the CodeCommit repository URL to clone the repo and make modifications to the application. When you push changes to the repo, the CodePipeline pipeline is triggered, and the application deployes.

FAQ

Q. I encountered a CREATE_FAILED error when I launched the Quick Start.

A. If AWS CloudFormation fails to create the stack, relaunch the template with Rollback on failure set to Disabled. This setting is under Advanced in the AWS CloudFormation console on the Configure stack options page.

When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Delete the stack when you finish troubleshooting.

For more information, see Troubleshooting AWS CloudFormation.


Q. I encountered a size-limitation error when I deployed the AWS CloudFormation templates.

A. Launch the Quick Start templates from the links in this guide or from another S3 bucket. If you deploy the templates from a local copy on your computer or from a location other than an S3 bucket, you might encounter template-size limitations. For more information, see AWS CloudFormation quotas.

Troubleshooting

This Quick Start uses CloudFormation to deploy an application using a IAM role created by the Quick Start template. When deleting the stack created by launching this Quick Start’s template, delete the deployed application first to avoid an error caused by the deleted IAM role.

Customer responsibility

After you successfully deploy this Quick Start, confirm that your resources and services are updated and configured — including any required patches — to meet your security and other needs. For more information, see the AWS Shared Responsibility Model.

Send us feedback

To post feedback, submit feature ideas, or report bugs, use the Issues section of the GitHub repository for this Quick Start. To submit code, see the Quick Start Contributor’s Guide.

Quick Start reference deployments

GitHub repository

Visit our GitHub repository to download the templates and scripts for this Quick Start, to post your comments, and to share your customizations with others.


Notices

This document is provided for informational purposes only. It represents AWS’s current product offerings and practices as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS’s products or services, each of which is provided “as is” without warranty of any kind, whether expressed or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.

The software included with this paper is licensed under the Apache License, version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://aws.amazon.com/apache2.0/ or in the accompanying "license" file. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for specific language governing permissions and limitations.