Skip to content

Latest commit

 

History

History
145 lines (106 loc) · 4.5 KB

README.md

File metadata and controls

145 lines (106 loc) · 4.5 KB
Raw

NimbusFS

NimbusFS is a robust, distributed, peer-to-peer Content Addressable Storage (CAS) system implemented in Go. It provides a scalable and efficient solution for storing and retrieving data across a network of nodes.

Table of Contents

Features

  • Content Addressable Storage (CAS): Ensures data integrity and deduplication.
  • Peer-to-Peer Architecture: Enables decentralized data storage and retrieval.
  • Distributed System: Scales horizontally for increased storage capacity and fault tolerance.
  • Encryption: Provides data security with AES encryption.
  • Flexible Transport Layer: Supports TCP with potential for easy expansion to other protocols.
  • Custom Encoding: Uses GOB encoding for efficient data serialization.

Architecture

NimbusFS is built on several key components:

  1. FileServer: The core component managing file operations and peer interactions.
  2. Store: Handles local file storage with a customizable path transform function.
  3. TCPTransport: Manages network communications between peers.

Resources

Educational Videos

These educational videos provided foundational knowledge and inspiration for building NimbusFS:

Getting Started

Prerequisites

  • Go 1.15 or higher

Installation

  1. Clone the repository: 
    git clone https://github.com/MonalBarse/NimbusFS
cd NimbusFS
  2. Build 
    go mod tidy
make build

Usage

NimbusFS comes with a Makefile for easy building, running, and testing.

Building the Application

To build the application, run:

make run

This command will build the application and then execute it.

Running Tests

To run the tests for all packages, use:

make test

Understanding the Default Behavior

The main.go file sets up a network of three file servers:

  1. Server 1 listens on port 3000
  2. Server 2 listens on port 7000
  3. Server 3 listens on port 5000 and connects to the other two servers

The program then demonstrates the functionality by:

  1. Storing 20 files (named "picture_0.png" to "picture_19.png") on Server 3
  2. Immediately deleting these files from Server 3's local storage
  3. Retrieving these files from the network
  4. Printing the contents of each retrieved file

This showcases the distributed nature of NimbusFS, where files can be retrieved from the network even if they're not present in the local storage of the requesting node.

Customizing the Network

  • To create your own network of NimbusFS nodes, you can modify the main.go file. Use the makeServer function to create new server instances:

    server := makeServer(listenAddr, bootstrapNodes...)

    Where:

    • listenAddr is the address the server will listen on (e.g., ":3000")
    • bootstrapNodes are the addresses of existing nodes to connect to (can be empty for the first node)

  • Then start each server with:

    go server.Start()

  • Storing and Retrieving Files

    • To store a file: 
      goCopydata := bytes.NewReader([]byte("file contents"))
server.Store("filename.txt", data)
    • To retrieve a file: 
      goCopyr, err := server.Get("filename.txt")
if err != nil {
  log.Fatal(err)
}
contents, err := io.ReadAll(r)
if err != nil {
  log.Fatal(err)
}
fmt.Println(string(contents))

Contributing

Contributions are welcome! Please read the contribution guidelines before submitting a pull request.

License

This project is licensed under the Apache-2.0 license - see the LICENSE file for details.