Flask-Microservice-Template

Usage

To use this application, you will need to have Docker and Docker Compose installed on your system. Once you have those installed, navigate to the Application directory and run the run.sh script. This will start all the services defined in the docker-compose.yml file.

Here are the step-by-step instructions for using this microservice architecture:

1. Make sure you have Docker and Docker Compose installed on your system. If you don't have them installed, you can download them from their website.

2. Open a terminal or command prompt and navigate to the flask-microservice-template directory.

3. Run the run.sh script by typing sh run.sh and pressing enter. This will start all the services defined in the docker-compose.yml file.

4. Open a web browser and navigate to http://localhost:8000. This will take you to the main page of the application.

Architecture

This architecture consists of several microservices: service_1, service_2, and main_service. Each of these microservices has its own Dockerfile, which is used to build a Docker image for that service. The services also have their own directories named app that contain the Python files __init__.py, views.py and models.py. Additionally, each service has a requirements.txt file that specifies its dependencies and a run.py file that starts the service.

The different services are orchestrated together using a docker-compose.yml file in the Application directory.

Testing

You can test the application by running the test.sh script in the root directory. This script will run the pytest for each service.

Accessing External API Calls

You can access each API by specifying docker container name, port number and endpoint. For example:

• Container name: service_1
• Container port: 8001
• Endpoint: /service_1/api_1
• URL: http://service-1:8001/service_1/api_1

Persistant Folder

Each service has a persistent folder where data is stored and remains even when Docker is restarted. This means that any changes made within Docker are also reflected on the local machine.