This project contains a microservices architecture application. The application is a very (very) simple web-based book lending app for a fictitious library. The project is intended as a demonstration for a Microservices architecture within a Containerized solution using Docker Containers and Kubernetes orchestration. The end goal is to deploy the demo with persistent volumes utilizing a CSI driver, in order to demonstrate the ability to persist database data on an external block or file storage system.
Note: this project was designed with extreme simplicity in mind, specifically to be used as a demo or a teaching/learning tool. Many liberties were taken with the architecture and the design in order to eliminate complexities such as security and scalability. This is not a secure, production quality, application but rather a learning or teaching tool for Microservices and Container technology; possibly also a reasonable starting point for a beginner or unexperienced programmer.
The demo can be deployed on your laptop or on a Kubernetes cluster. For personal laptop use there are two modes to deploy the demo. The first using docker-compose and the second using Kubernetes available through a Docker Desktop setup. In order to deploy, first follow the two steps below, then follow the relevant section for the method you want to try.
- Install Docker and Kubernetes desktop, for Windows or macOS
- Select Branch tag v1.1
- Pull the repository or download and extract the v1.1 branch zip file from GitHub into a new directory on your system.
- Copy the
sample.envfile into a new file named.env
cp sample.env .env
- Optional, change the MySQL root password in the
sample.envfile. - Build the images and bring up the app services:
docker-compose up --detach --build
- Allow all services to start (check with
docker psunder the STATUS table heading) - Point your web browser at: http://localhost:8000/ to access the library's web page.
- Use the canned set of users in the
mysql/patrons_demo.csvfile to log into the library and borrow books - Display container logs during run time and watch activity when selecting web page links
docker-compose logs --follow
- Shutdown and clean up
docker-compose down
Use the latest release or select the v1.2 or higher branch, then follow README.md in the K8s-deployment directory.
Use the latest release or select the v1.2 or higher branch, then follow the Kubernetes deployment as well as review the notes in README.md in the open-shift directory.
A detailed demo script is available for you to use as a guide to familiarize with the application and basic underlying functions. The demo script includes a step by step description including screen shots.
Wherever possible, internal ports where exposed to use as test points for the REST API endpoints. To test intermediate points within the application deploy the application with docker-compose and use the curl CLI command to "inject" REST requests directly into the running services. Suggested tests are listed in the TESTME.md files found in each of the services' directories. Refer to the design.md files for RESTapi interface details. See the docker-compose.yml file for local port numbers under the ports: tag for each service.
| Service | Framework | Description |
|---|---|---|
| Frontend | Python/Django | Expose and HTTP server for accessing the application |
| Catalog database | Python/Flask | Back end book catalog database |
| Patrons database | Python/Flask | Back end patrons' registry database |
| Borrowing database | Python/Flask | Back end borrowing transaction database |
| Borrowing service | Python/Flask | Library book borrowing logic |
See the design.md file
- Python3 (version 3.6.8)
- MySQL database server (version 5.7.27)
- Python dependencies in local
requirements.txtfiles
Django web framework, Flask web framework Python REST API CRUD Example using Flask and MySQL, MySQL Server on Ubuntu, Designing a RESTful API with Python and Flask, HTTP Status Codes