Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.88 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.88 KB

CircleCI

Project Overview

This project uses Docker and Kubernetes to deploy an api to predict housing prices in Boston. In this project, you will apply the skills you have acquired in this course to operationalize a Machine Learning Microservice API.

Setting Up the Environment

  1. Run make setup to create a python virtual environment.
  2. Run source ~/.devops/bin/activate to activate the virtual environment.
  3. Run make install to install the necessary dependencies

Running app.py

  1. Standalone: python app.py
  2. Run in Docker: ./run_docker.sh
  3. Run in Kubernetes: ./run_kubernetes.sh

Kubernetes Steps

  1. Setup and Configure Docker locally.
  2. Setup and Configure Kubernetes locally.
  3. Create Flask app in Container.
  4. Run via kubectl.

Usage

  1. Make sure the app is running as outlined in Running app.py.
  2. Run ./make_prediction.sh to make a request to the API.s

File Explanation

  • .circleci/config.yml: This file contains the CircleCI workflow definitions.
  • model_data/: This file contains the ML model for the prediction.
  • output_txt_files/: This directory contains the results of running run_docker.sh and run_kubernetes.sh.
  • app.py: The python web API that uses the ML model to predict housing prices.
  • make_prediction.sh: A script to make a sample request to the API.
  • Makefile: A makefile to script common operations.
  • requirements.txt: A list of Python dependencies used by app.py
  • run_docker.sh: A script that deploys and runs the app using docker.
  • run_kubernetes.sh: A script that deploys and runs the app using kubernetes.
  • upload_docker.sh: A script to push the docker image to Dockerhub.