reference deployment

TaskCat CI/CD Pipeline for AWS CloudFormation

Automate testing and deployment of CloudFormation templates

This AWS Solution deploys TaskCat continuous integration and continuous delivery (CI/CD) pipeline for AWS CloudFormation on the Amazon Web Services (AWS) Cloud. It is for users that want to automatically test and deploy CloudFormation templates from a GitHub repository using TaskCat.

This AWS Solution was developed by AWS.

  •  What you'll build
  • This AWS Solution sets up the following:

    • AWS CodePipeline to automate a CI/CD pipeline with source, build/test, and deploy stages. 
    • In the source stage, a Git user pushes a commit, which invokes CodePipeline. CodePipeline retrieves source code and stores it in an Amazon Simple Storage Service (Amazon S3) artifacts bucket.
    • In the build/test stage:
      • AWS CodeBuild retrieves code from an artifacts S3 bucket and runs TaskCat. 
      • TaskCat deploys and tests CloudFormation templates and saves test results to a reports S3 bucket.
      • AWS Secrets Manager stores credentials used by CodeBuild for Git access.
    • In the deploy stage, a Lambda function merges tested code with the release branch in the GitHub repository.
  •  How to deploy
  • To deploy this AWS Solution, follow the instructions in the deployment guide, which includes these steps.

    1. Sign in to your AWS account. If you don't have an account, sign up at https://aws.amazon.com.
    2. Set up a GitHub OAuth 2 token with the scopes admin:repo_hook and repo.
    3. Launch the AWS Solution. Before you create the stack, choose the AWS Region from the top toolbar. The stack takes about 15 minutes to deploy.
    4. Verify the CI/CD pipeline in the CodePipeline console.
  •  Cost and licenses
  • This AWS Solution deploys AWS TaskCat, which is open source and free to use under the Apache 2.0 license.

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

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

    Tip: After you deploy the AWS Solution, create AWS Cost and Usage Reports to track costs associated with the AWS Solution. AWS Cost and Usage Reports deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. They provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information about the report, refer to What are AWS Cost and Usage Reports?