DEV Community 👩‍💻👨‍💻

Cover image for AWS DevOps for your Django project: Automate CI-CD with AWS CodeCommit & GitHub in simple steps
Vin Bolisetti
Vin Bolisetti

Posted on

AWS DevOps for your Django project: Automate CI-CD with AWS CodeCommit & GitHub in simple steps

This guide covers all steps needed for setting up your CI-CD workflow with AWS CodeCommit and GitHub under the hood. In this tutorial we will clone a sample django application from GitHub, configure CodeDeploy agent in EC2 and finally setup our CI-CD pipeline in AWS.

Django-AWS CI-CD

Link to sample django project: GitHub

Table of Contents

  1. Clone GitHub repo (Optional)
  2. Preparing Django project files (Optional)
  3. Create yaml files to automate AWS CI-CD (Optional)
  4. Create roles in AWS
  5. Launching EC2 instance for AWS CI-CD
  6. Configure AWS Code Deploy
  7. Configure AWS Code Pipeline

1. Clone GitHub repo (Optional)

  • Open your chosen command-line interface
  • Create new project folder -->
$ mkdir folder_name
Enter fullscreen mode Exit fullscreen mode
  • Go in to your project folder -->
 $ cd folder_name
Enter fullscreen mode Exit fullscreen mode
  • Clone the remote repository -->
$ git clone git@github.com:vinclairvoyant/django-aws_cicd.git
Enter fullscreen mode Exit fullscreen mode

2. Preparing Django project files (Optional)

For those who have cloned repo need not require to do any changes to the django files and can skip this step 2, but for others who are deploying their own django project shall continue with below steps:

If you are deploying your own django application then make sure to allow all hosts by Changing ALLOWED_HOSTS in your django settings file as shown below. (Not recommended for security reasons, eventually we want to change this to an IP)

Image description

Make sure you have requirements.txt file for installing required dependencies.

3. Create yaml files to automate AWS CI-CD (Optional)

For this basic tutorial we will create 3 files appspec.yml, before_install.sh & after_install.sh to automate the deployment process handled by AWS CI-CD.

Folder/file structure:

Folder/file structure

Create appscpec.yml file inside your root project directory where manage.py file is.

Step 1: Create CodeDeploy appspec.yml file

version: 0.0
os: linux
files:
  - source: /
    destination: /home/ubuntu/django-aws_cicd
hooks:
  BeforeInstall:
      - location: scripts/before_install.sh
  AfterInstall:
      - location: scripts/after_install.sh
Enter fullscreen mode Exit fullscreen mode

mkdir scripts
vi scripts/before_install.yml

Step 2: Create before_install.yml file

#!/usr/bin/env bash

# clean codedeploy-agent files for a fresh install
sudo rm -rf /home/ubuntu/install

# install CodeDeploy agent
sudo apt-get -y update
sudo apt-get -y install ruby
sudo apt-get -y install wget
cd /home/ubuntu
wget https://aws-codedeploy-us-east-1.s3.amazonaws.com/latest/install
sudo chmod +x ./install 
sudo ./install auto

# update os & install python3
sudo apt-get update
sudo apt-get install -y python3 python3-dev python3-pip python3-venv
pip install --user --upgrade virtualenv

# delete app
sudo rm -rf /home/ubuntu/django-aws_cicd
Enter fullscreen mode Exit fullscreen mode

vi scripts/after_install.yml

Step 3: Create after_install.sh file

#!/usr/bin/env bash

# kill any servers that may be running in the background 
sudo pkill -f runserver

# kill frontend servers if you are deploying frontend
# sudo pkill -f tailwind
# sudo pkill -f node

cd /home/ubuntu/django-aws_cicd/

# activate virtual environment
python3 -m venv venv
source venv/bin/activate

install requirements.txt
pip install -r /home/ubuntu/django-aws_cicd/requirements.txt

# run server
screen -d -m python3 manage.py runserver 0:8000
Enter fullscreen mode Exit fullscreen mode

Before we start setting up AWS CI-CD we need to ensure all changes made locally inside django files are pushed to github.

AWS CI-CD Configuration:

Let's get started configuring AWS for CI-CD pipeline, for this we are going to be using 3 services mainly IAM roles, CodeDeploy & CodePipeline.

4. Create roles in AWS

We want to create 2 IAM roles:

AmazonEC2RoleforAWSCodeDeploy provides EC2 access to S3 bucket to download revision:

Step 1:
1.1
Step 2:
1.2
Step 3:
1.3
Step 4:
1.4

AWSCodeDeployRole for CodeDeploy service access to expand tags and interact with Auto Scaling on your behalf.

Step 1:
2.1
Step 2:
2.2
Step 3:
2.3
Step 4:
2.4
Step 5:
2.5
Step 6:
2.6

5. Launching EC2 instance for AWS CI-CD

When launching a new EC2 instance ensure to add AmazonEC2RoleforAWSCodeDeploy IAM role that we created.

ec2_1

ec2_2

#!/usr/bin/env bash
sudo apt-get -y update
sudo apt-get -y install ruby
sudo apt-get -y install wget
cd /home/ubuntu
wget https://aws-codedeploy-us-east-1.s3.amazonaws.com/latest/install
sudo chmod +x ./install 
sudo ./install auto

Enter fullscreen mode Exit fullscreen mode

You must provide a name to your instance if you had not provided when creating an instance, instance name will be required when creating CodeDeploy deployment group in upcoming steps.

ec2_3

Configure Security group attached to EC2 to allow port 8000:

sg_1

Once you launch your instance wait for few minutes for status checks to be completed.

6. Configure AWS Code Deploy

For creating CodeDeploy we first need to create application and then create deployment group, steps below:

Step 1: Search for CodeDeploy service in AWS
cd_1
Step 2: On the left navigation panel open Deploy -> Select Applications and then click on Create application
cd_2
Step 3: Provide any application name of your choice, for Compute Platform choose EC2/On-premises from the drop down and then click on Create application
cd_3
Step 4: Will be redirected inside application that we just created, now click on Create deployment group
cd_4
Step 5: Enter a deployment group name of your choice and then choose the service role that we created for CodeDeploy, in this tutorial we named it CodeDeployRole
cd_5
Step 6: Environment configuration choose Amazon EC2 instances and then add the ec2 instance we created, for Key choose Name and for Value choose in this tutorial we named the instance aws-cicd.
cd_6
Step 7: Uncheck the Enable load balancing and then click on Create deployment group.
cd_7

7. Configure AWS Code Pipeline

CodePipeline brings everything together to build the final CI-CD

Initial Step: On left navigation panel open Pipeline then click on Pipelines and finally click on Create Pipeline
cp_1
Step 1: Enter a pipeline name of your choice, a role name gets automatically created for you, now click Next

cp_2
cp_3
Step 2: From the drop down choose GitHub (Version 2), click on Connect to GitHub, once you have a successful connection choose Repository name, branch name and then click Next

cp_4
cp_5
cp_6
cp_7
Step 3:
Build is out of scope for this tutorial, click on Skip build stage
cp_8
Step 4: From Deploy provider drop downs choose AWS CodeDeploy, choose the application name and deployment group that we created from step 6 and then click Next.
cp_9
Step 5: Review the page, scroll down to the bottom of the page and then click on Create pipeline
cp_10

We have completed setting up and creating CI-CD pipeline on AWS, we can check the progress either by clicking on the Details in Deploy section or in the left panel Deployments, then scroll down and click on View events to see the status of deployment.
cp_12
cp_13
cp_14

Run Application:

Go to EC2 instance, copy the Public IPv4 DNS

cp_15

navigate using this url:

http://<Public IPv4 DNS>:8000
Enter fullscreen mode Exit fullscreen mode

You should see this django app running...

success

Top comments (2)

Collapse
 
david_simpson profile image
David Simpson

Thanks for the article, well done!

Collapse
 
tapasrihari profile image
Tapa Srihari Narayan

Thanks for sharing ...

🌚 Friends don't let friends browse without dark mode.

Sorry, it's true.