Skip to content

Latest commit

 

History

History
200 lines (117 loc) · 7.05 KB

README.md

File metadata and controls

200 lines (117 loc) · 7.05 KB
Raw

Distributed Banking System Communication

This project demonstrates a distributed banking system that communicates using Docker containers and utilizes Apache Kafka for message passing. The system consists of multiple services, including banks, a stock market, Zookeeper, and Kafka.

This Project uses four communication types, which are UDP, TCP (also a running HTTP server on top of TCP), RPC, and MOM (message-oriented middleware).

UDP Implementation

The UDP implementation involves banks receiving stocks from the stock market and updating their total money depending on the received values of the stock market.

TCP HTTP Implementation

In the TCP HTTP implementation, a bank can receive money and go bankrupt through deduction from outside the cluster using curl.

To make a GET request to the bank service:

curl http://localhost:6789

To make a POST request to deposit money (e.g., 1000) into the bank:

curl -X POST -d "deposit=1000" http://localhost:6789

To update the portfolio value of the bank (e.g., to 3000):

curl -X POST -d "portfolio_value=3000" http://localhost:6789

(Note: The portfolio_value represents the total value of the bank.)

To make a POST request to withdraw money (e.g., 500) from the bank:


curl -X POST -d "withdrawal=500" http://localhost:6789

To make a GET request with response headers included:

curl -X GET -i http://localhost:6789

To make a POST request to deposit a specific amount (e.g., 200) with response headers included:

curl -X POST -d "deposit=200" -i http://localhost:6789

RPC Implementation

The RPC implementation allows a bank to lend money from another bank (each bank is a running container) through remote procedure call.

To trigger the RPC call execute the follwoing command:

curl -X POST -d "withdrawal=3000" http://localhost:6789

Message Oriented Middleware (MOM) Communication

In the Message Oriented Middleware communication, a bank can only get saved through a group of banks that use a two-phase commit and decide to save the bank if they have enough money.

The aim of this project is to simulate distributed communication, where one bank can get saved from other banks in case it goes bankrupt through HTTP, RPC, and MOM.

To trigger the two phase commit execute the following command:

 curl -X POST -d "withdrawal=2000" http://localhost:6789

UDP

udp

TCP with an HTTP SERVER above it

Screenshot from 2023-05-13 21-21-09 Screenshot from 2023-05-13 20-36-27

Remote Procedure Call(RPC)

Screenshot from 2023-07-11 01-29-16

Messsage Oriented Middleware(MOM)

In implementing the publish subscribe communication , Kafka is used as a solution.Also note that the two phase commit algorithm was used within the publish subscribe communication in order to ensure Atomicity, Data Consistency, Isolation and Durablility.

Screenshot from 2023-07-10 23-44-50 Screenshot from 2023-07-10 23-48-00

Screenshot from 2023-07-10 23-49-06

Requirements

How to Run

  1. Clone the repository to your local machine:
git clone https://github.com/smartlocus/Distributed-Banksystem-Communication.git
  1. Navigate to the project directory:
 cd Distributed-Banksystem-Communication
  1. Build the Docker images for the services:
docker-compose build

Note: if the docker compose build(building the images) fails, you probably need to chnage the "context" in the docker-compose.yaml file to the path where you cloned the repo. you can find the path where you cloned it through the pwd command. Copy that path and put replace the existing context value in the docker-compose.yaml

  1. Run the services:
docker-compose up

This command will start the banks, stock market, Zookeeper, and Kafka containers. The system will now be up and running, and you can access it through the specified ports. It might take some time starting all the containers and communication models depending on your system and network speed.

Services and Ports

The project consists of the following services:

  • bank: Represents a bank service. It listens on port 6789.
  • bank2: Another instance of the bank service. It listens on port 6789 as well.
  • stockmarket: Represents a stock market service. It depends on the banks and listens on ports 6790 to 7000.
  • zookeeper: Zookeeper is used for managing the Kafka cluster and coordination among brokers. It listens on port 2181.
  • kafka: Apache Kafka is a message broker used for communication between services. It listens on port 9092.

Environment Variables

The following environment variables are available to configure the services:

  • SERVER_IP: The IP address of the bank service. Default: bank
  • SERVER_PORT: The port number the bank service listens on. Default: 6789
  • SERVER_IP_THRIFT: (Commented out) The IP address of the bank service for Thrift communication.
  • SERVER_PORT_THRIFT: (Commented out) The port number the bank service listens on for Thrift communication.
  • SERVER_IP_BANK: The IP address of bank2 for inter-bank communication. Default: bank2
  • SERVER_PORT_BANK: The port number bank2 listens on for inter-bank communication. Default: 7001
  • LOAN_AMOUNT: The amount of money to lend from another bank. Default: 1000
  • KAFKA_IP: The IP address of the Kafka service. Default: kafka

Network

The services are connected to a custom Docker bridge network named "test_net_1". This network allows the containers to communicate with each other.

Persistence

No persistent docker volume is created in this project. If you want want to have persistence of data you can add the following command to each Bank(Container) to persist the data.

Bank:
 # ... 
volumes:
      - bank_data:/app/data # add this to each Bank 
 # ....

volumes:
  bank_data:  # paste this only once at the end of the docker compose file

Note

  • Make sure that the required ports (e.g., 6789, 7001, 2181, 9092) are not already in use on your system.

Feel free to modify and extend this project as needed. Happy coding!