RingSync is a Python-based project that leverages user-friendly REST API, gRPC, protocol buffers, and Docker to ensure the seamless storage, retrieval, updation and deletion of objects while maintaining high availability, fault tolerance, and data consistency.
This repository contains the codebase for a consistently hashed, ring topology based architecture with replication designed for a cloud-based object storage system built on the key principles of distributed computing as a part of the assignment from the Semester-I '23-24 offering of the CS G527 Cloud Computing course.
- Python 3.x
- gRPC (Google Remote Procedure Call): gRPC tools and gRPC Python Libraries
- Protobuf ‘protoc’ compiler (for .proto files)
- Docker (code was run and tested on v4.24)
- docker Python Library
- mmh3 Python Library
- Flask Python Library
Please ensure that you have these dependencies installed and configured before running the scripts.
Note: 1) The operating systems of the machines on which the files are to be run must be Linux-based. 2) Ensure that all the required software and libraries are installed on your system. For more information on which libraries and software are needed, kindly go through technical design documentation.
- Clone the repository.
- Navigate to the directory of the repository. Create a Docker image named ‘ringserver’ via the following instruction:
docker build -t ringserver .
- Run the intermediate server with the following instruction
python intermediate.py
- Run the endserver initialiser script to register all N nodes (containers) with the intermediate server:
python endInitialiser.py
- You should have N containers running the ringserver image now. Now, any client can perform the desired CRUD operations by accessing the portal
python portal.py
Note: It might be needed to modify the IP addresses according to the necessities of the machines running this system on your end. Please do so accordingly before trying out the code.