Skip to content

Latest commit

 

History

History
101 lines (78 loc) · 2.82 KB

README.md

File metadata and controls

101 lines (78 loc) · 2.82 KB
Raw

Flask-Pulumi-GitHub-Actions

License

Welcome

Hello. Want to get started with Flask, Pulumi and GitHub Actions quickly? Good. You came to the right place. This repository contains the important parts of a GitOps Pipeline, tests, Continuous Integration and Continuous Deployment. All you have to do is input your AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and PULUMI_ACCESS_TOKEN.

Project Structure

.
├── LICENSE
├── README.md
├── appspec.yml
├── infrastructure
│   ├── Pulumi.accure.yaml
│   ├── Pulumi.yaml
│   ├── __main__.py
│   └── requirements.txt
├── scripts
│   └── execute.sh
└── simple
    ├── accure.service
    ├── app.py
    ├── Dockerfile
    ├── nginx
    │   └── accure
    ├── requirements.txt
    ├── test_app.py
    └── wsgi.py

Quick Start

Locally

  1. Clone the repo
$ git clone https://github.com/edeediong/Flask-Pulumi-GitHub-Actions.git
$ cd Flask-Pulumi-GitHub-Actions
  1. Initialize and activate a virtualenv:
$ virtualenv --no-site-packages env
$ source env/bin/activate
  1. Install the dependencies:
$ pip install -r requirements.txt
  1. Run the development server:
$ python app.py
  1. Navigate to http://localhost:5000

Production

  1. Clone the repo
$ git clone https://github.com/edeediong/Flask-Pulumi-GitHub-Actions.git
$ cd Flask-Pulumi-GitHub-Actions
  1. Initialize pulumi
pulumi stack init stack-name
pulumi config set aws:region <value>
  1. Create a .pulumi folder with a file called ci.json. This file is used to tell the Pulumi Action that the GitHub branch main is the branch for the stack created. Below is the content of the file:
{
    "main": "<stack-name>"
}
  1. Also ensure the pip packages needed to execute your code are placed in requirements.txt. In this case the only package to be added is pulumi_aws.
  2. Push code and watch entire GitOps Pipeline executed.

GitOps Pipeline

Introduction

This article explains the entire idea of GitOps. For this deployment, I used the following tools:

  • GitHub Actions for the Continuous Integration part of the project (running tests)
  • Pulumi for the Infrastructure as Code part of the project (provisioning the infrastructure)
  • AWS CodeDeploy for Continuous Deployment, used in automating the deployment to the server
  • AWS S3 to store the source code of the repository and push to AWS EC2.
  • AWS EC2 to serve the source code
  • AWS IAM to create access keys used by the repository.