Published: February 5, 2024 | Modified: February 5, 2024

In late Nov 2023, amazon announced the new CloudFormation Git sync feature. Let’s explore this new feature; how it works, how it impacts CD patterns of Infrastructure as Code (IaC), etc.

CloudFromation Git Sync Feature!

What is the CloudFormation Git sync?

Recently announced CloudFormation Git sync feature lets customers deploy and sync the CloudFormation IaC code directly from remote Git repositories. This will be a game changer in the future as this feature might empower customers to omit the Continuous Deployment tools like Jenkins, GitHub Actions, etc. altogether and hence their maintenance.

In summary, the customer is required to establish a GitHub Connection with AWS and subsequently generate a CloudFormation stack using the relevant IaC template repository information. Once the stack is set up, CloudFormation continually monitors the template files in the remote Git repository. Any new commits in the remote repo, trigger the automatic deployment of the corresponding changes to AWS.

Pre-requisite for CloudFormation Git sync

A Git repository with a valid CloudFormation IaC template

A GitHub Connector configured for the target AWS account

IAM role for Git Sync operations. It should have –

Access IAM policy

Trust policy

IAM policy

For tighter security control, one can scope down the IAM policy for certain CloudFormation Stacks using a resource block in the SyncToCloudFormation statement.

{
“Version”: “2012-10-17”,
“Statement”: [
{
“Sid”: “SyncToCloudFormation”,
“Effect”: “Allow”,
“Action”: [
“cloudformation:CreateChangeSet”,
“cloudformation:DeleteChangeSet”,
“cloudformation:DescribeChangeSet”,
“cloudformation:DescribeStackEvents”,
“cloudformation:DescribeStacks”,
“cloudformation:ExecuteChangeSet”,
“cloudformation:GetTemplate”,
“cloudformation:ListChangeSets”,
“cloudformation:ListStacks”,
“cloudformation:ValidateTemplate”
]
},
{
“Sid”: “PolicyForManagedRules”,
“Effect”: “Allow”,
“Action”: [
“events:PutRule”,
“events:PutTargets”
],
“Resource”: “*”,
“Condition”: {
“StringEquals”: {
“events:ManagedBy”: [
“cloudformation.sync.codeconnections.amazonaws.com”
]
}
}
},
{
“Sid”: “PolicyForDescribingRule”,
“Effect”: “Allow”,
“Action”: “events:DescribeRule”,
“Resource”: “*”
}
]
}

Trust policy

{
“Version”: “2012-10-17”,
“Statement”: [
{
“Sid”: “TrustPolicy”,
“Effect”: “Allow”,
“Principal”: {
“Service”: “cloudformation.sync.codeconnections.amazonaws.com”
},
“Action”: “sts:AssumeRole”
}
]
}

How to create a stack using CloudFormation Git Sync?

Let’s look at the step-by-step procedure to deploy a new CloudFormation stack using Git Sync.

Environment setup considered here –

An AWS account configured with GitHub Connection in the Developer Tools Console.

A Private GitHub repository cfn-git-sync-poc that hosts a valid CloudFormation template at cloudformation/s3-stack.yaml

An IAM role was cfn-github-role created on the target AWS account with above stated policies.

Now, it’s time to get our hands dirty!

Log in to the AWS CloudFormation console. Click on the Create stack dropdown button and choose With new resources (standard)

On a Create stack page, select Template is ready and Sync from Git

Create stack using Git

Start providing the stack details like the stack name of your choice and select automatic Deployment file creation. If you wish to create a deployment file, please refer to this file format details.

Stack details

Then, specify the Git repository information. Ensure that you have a configured and active GitHub connection to fill in the fields in this segment. Choose the repository containing the Infrastructure as Code (IaC), specify the deployment branch, and designate a Deployment file path where AWS will store the newly committed deployment file. Lastly, furnish the IAM role details that will be utilized for executing Git Sync operations.

Repository details

Lastly, enter the file path for the CloudFormation IaC template inside the remote Git repo and define the parameters that are declared in the template. These details will be used to build the Deployment file.

Template and parameter details

Click the Next button and you will enter the Stack options page.

Stack options are the same as any other CloudFormation stack hence we will not discuss them here.

After verifying/modifying Stack options click Next button on the page.

Now, you will enter the review page where you can see the Deployment file constructed using the details provided and it will be committed to the remote Git repo on defined location

Deployment file!

Review the rest of the configurations and click the Submit button.

Now, CloudFormation will commit and push the Deployment file to the remote Git repo by raising a Pull Request (PR). The message will be flagged on the page. Meanwhile, since the Deployment file is not found in the remote repo, the Provisioning status will be marked as Failed. Once PR is approved, Deployment file will be available in the remote repo.

The First deploy using CloudFormation Git Sync

Head over to GitHub and you should see a PR raised by Amazon to commit the deployment file into the remote repo.

PR raised by AWS Connector

Deployment file creation by AWS Connector in PR

Review, approve, and merge the PR.

Once PR is merged the code modification is detected by CloudFormation and it starts provisioning the stack.

Stack provisioning started

Once all defined resources are created, stack creation will complete and CloudFormation keep monitoring the Git repository for any new changes.

The Stack is deployed successfully!

In multiple environments such as development, testing, staging, and production, it’s possible to utilize distinct Stack Deployment files while leveraging a single CloudFormation IaC template file. These varied Deployment files can be organized into separate folders within the same repository for better segregation. By selecting the appropriate deployment file based on the environment where the CloudFormation stack is being established, the process becomes more streamlined. Something like –

cloudformation
├── dev
│ └── deployment.yaml
├── test
│ └── deployment.yaml
├── staging
│ └── deployment.yaml
├── production
│ └── deployment.yaml
└── template.yaml

By selecting the appropriate deployment file based on the environment where the CloudFormation stack is being established, the process becomes more streamlined. I anticipate that the Git Sync feature will evolve with additional capabilities in the future, potentially prompting customers to reconsider the necessity of separate Continuous Deployment (CD) software.

What do you think about this feature?

What are your thoughts on the CloudFormation Git Sync feature? Could it potentially revolutionize the game? Will it make several Continuous Deployment tools obsolete? It feels like an ArgoCD for Kubernetes, operating in a remarkably similar manner. For sure, it may not yet offer extensive control over commit-wide deployments, but the potential for future enhancements is exciting. This feature appears to transform the Infrastructure as Code (IaC) landscape for AWS customers, possibly luring some back from alternative IaC platforms. Witnessing its development and utilization in enterprise productions is going to be exciting!