Giter VIP home page Giter VIP logo

fsnd-deploy-flask-app-to-kubernetes-using-eks's Introduction

Deploying a Flask API

This is the project repo for the fourth of five projects in the Udacity Full Stack Nanodegree: Server Deployment, Containerization, and Testing.

The purpose of this project was to containerize and deploy a Flask API to a Kubernetes cluster using Docker, AWS EKS, CodePipeline, and CodeBuild.

The Flask app that will be used for this project consists of a simple API with three endpoints:

  • GET '/': This is a simple health check, which returns the response 'Healthy'.
  • POST '/auth': This takes a email and password as json arguments and returns a JWT based on a custom secret.
  • GET '/contents': This requires a valid JWT, and returns the un-encrpyted contents of that token.

The app relies on a secret set as the environment variable JWT_SECRET to produce a JWT. The built-in Flask server is adequate for local development, but not production, so Gunicorn server was used when deploying on AWS.

Initial setup

  1. Clone this repo to serve the project.

Dependencies

  • Docker Engine
    • Installation instructions for all OSes can be found here.
    • Mac users: if you have no previous Docker Toolbox installation, you can install Docker Desktop for Mac. If you already have a Docker Toolbox installation, please read this before installing.
  • AWS Account
    • You can create an AWS account by signing up here.

Project Steps

Completing the project involves several steps:

  1. Write a Dockerfile for a simple Flask API
  2. Build and test the container locally
  3. Create an EKS cluster
  • Create cluster in the default region

eksctl create cluster --name simple-jwt-api

  • Create a cluster in a specific region, such as us-east-2

eksctl create cluster --name simple-jwt-api --region=us-east-2

  • Get AWS Account ID

aws sts get-caller-identity --query Account --output text

  • Update conifgmap/aws-auth with AWS ID and necessary permisisons
  1. Store a secret using AWS Parameter Store
  • Put secret into AWS Parameter Store

aws ssm put-parameter --name JWT_SECRET --overwrite --value "YourJWTSecret" --type SecureString

  • Once you receive project reviews, consider deleting the variable from parameter-store:

aws ssm delete-parameter --name JWT_SECRET

  1. Create a CodePipeline pipeline triggered by GitHub checkins
  • Use the AWS MAnagement Console to navigate to CloudFormation and upload ci-cd-codepipeline.cfn.yml and create the stack
  • be sure to generate and supply your Github access token
  • also be sure to check the IAM checkbox on the last page, or else CFN will not have necessary permisions
  1. Create a CodeBuild stage which will build, test, and deploy your code
  • make an edit and commit your change
  • After a minute or two, check to see if the build was initiated

For more detail about each of these steps, see the project lesson here.

fsnd-deploy-flask-app-to-kubernetes-using-eks's People

Contributors

kbehrman avatar mkturner avatar sudkul avatar swwelch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.