Giter Club home page Giter Club logo

cloudy-flask's Introduction

Cloudy-Flask

Started out this project to learn about developing and deploying microservices using Cloud native projects. This repo contains microservices implemented using Python's Flask-restplus to create backend services by taking a cloud native approach. The project starts out with the application running on Docker and later branches out to running on Kubernetes.

About the application

Note: Each folder contains it's microservice where they have a detailed info in their README.

Database choice: MongoDB

Application is backed by Mongodb which is exposed by a REST API.

Backend services:

  • Database API: A single database API to expose the MongoDB for CRUD operations pertaining to user actions without access control.
  • User Service: Contains JWT auth and authorization code for user actions. Look at the README for more info.
  • Email service: Would send out emails to registered users.
    • Would use Celery and Redis as task queue and message broker to accomplish this.

Current Progress

  • Implemented the Database API.
  • Implemented the Users API
  • Implemented the Email API
  • Service Discovery is done natively by Kubernetes's CoreDNS

TODO

  • Integrate Hashicorp's Vault for secrets(API keys, passwords)

Setup

Each directory would have detailed instructions about setting up the specific component.

Informatioin about generic files will be mentioned here.

All the services require you to build the image and push it to your local kubernetes cluster. You can use the ci.sh script below to do just that.

service.yaml

To view the app locally we expose it from the minikube cluster to our local VM using a service.

  • kubectl create -f service.yaml

ci.sh

This script is very useful to save bandwidth when you're developing locally. It pushes a local docker image to the minikube cluster by taking the name of the image as an argument. To utilise it move into the directory where your Dockerfile is in and type:

  • <Path>/ci.sh <name of the docker image> <name of the deployment>

Take a look at this blog post about how I develop apps in Kubernetes: https://medium.com/harsh-thakur/developing-apps-locally-on-kubernetes-eee7600ee0f8

cloudy-flask's People

Contributors

realharshthakur avatar

Stargazers

 avatar

Watchers

 avatar  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.