https://github.com/aveek-saha/paxos-db

A distributed key value store using multi paxos to achieve consensus

https://github.com/aveek-saha/paxos-db

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary

Keywords

key-value kv-store kvstore multi-paxos paxos paxos-algorithm paxos-java paxos-protocol
Last synced: 5 months ago · JSON representation

Repository

A distributed key value store using multi paxos to achieve consensus

Basic Info
  • Host: GitHub
  • Owner: Aveek-Saha
  • License: mit
  • Language: Java
  • Default Branch: master
  • Homepage:
  • Size: 448 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
key-value kv-store kvstore multi-paxos paxos paxos-algorithm paxos-java paxos-protocol
Created almost 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

Paxos Db

A replicated key value store that achieves consensus using multi-paxos.

Features

  • Three types of operations can be performed on the server with the following parameters:
    • PUT (key, value)
    • GET (key)
    • DELETE (key)
  • These operations are performed on a key value store.
  • Server is multi threaded and can respond to multiple clients at a time.
  • Client and servers communicate using RPC.
  • The server is replicated across multiple instances.
  • Replicas should be fault tolerant.
  • Paxos is used for fault tolerant consensus.
  • Replicas implement Paxos roles like the Proposers, Acceptors, and Learners.
  • Clients can sent requests to any of the replicas.
  • Only the replica that receives a client becomes the proposer for that round of paxos.
  • A coordinator is present only for facilitating the discovery of all replicas.

Running instructions

The project uses maven for building. This project MUST be run with Docker or Docker Compose which will create a coordinator and the specified number of server replicas.

Run with Docker

Docker can be used along with the shell scripts.

```sh

This script will build and start the coordinators and servers and then display logs from the coordinator

./deploy.sh

To view logs from any of the 5 servers

docker logs server-<1-5> -f

Run the client

./run_client.sh server-<1-5> <5001-5005> ```

Run with Docker Compose

You can also use docker compose to set it up

```sh

Run the docker compose command

This will create the network, start the coordinator and the specified number of replicas

docker compose up

Run: 'docker compose down' when you want to remove the resources created above

Build client image

docker build -f client.Dockerfile -t client-img --target client-build .

Run client container

docker run -it --rm --name client-con-1 --network project4_default client-img java -jar /app/client.jar project4-server-3 5001

If the above command doesnt work (it didn't work for me on windows git bash) try this one

docker run -it --rm --name client-con-1 --network project4_default client-img java -jar //app//client.jar project4-server-3 5001

```

If you want to change the number of replicas edit compose.yaml and rerun the commands.

Dockerfile replicas : 10

To change the ports that the servers run on you can also edit compose.yaml

```Dockerfile coordinator: ... entrypoint: java -jar /app/server.jar c ports: - ":" ...

server: ... entrypoint: java -jar /app/server.jar coordinator ports: - target: ... ```

Owner

  • Name: Aveek Saha
  • Login: Aveek-Saha
  • Kind: user
  • Location: Boston, MA
  • Company: @akamai

Cloud Computing, Machine Learning and Full Stack. SDE co-op @akamai. MSCS student @northeastern. Previously at @HewlettPackard, @altimetrik & @ IIT Kgp.

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 7
  • Total Committers: 1
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Aveek Saha a****8@g****m 7

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

client/pom.xml maven
  • org.json:json 20240205
server/pom.xml maven
  • org.json:json 20240205