https://github.com/arthur-x/retain
A cloud file storage service that allows syncing files across multiple nodes.
https://github.com/arthur-x/retain
cloud-storage-services
Last synced: 29 days ago
JSON representation
A cloud file storage service that allows syncing files across multiple nodes.
- Host: GitHub
- URL: https://github.com/arthur-x/retain
- Owner: arthur-x
- Created: 2022-09-06T08:31:16.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-12T08:55:38.000Z (over 3 years ago)
- Last Synced: 2025-03-04T15:46:32.781Z (over 1 year ago)
- Topics: cloud-storage-services
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Retain
Retain is a cloud file storage service that lets you sync files across multiple nodes, supporting creation, modification, deletion and fetching specific versions of a file (in progress). Retain is an ongoing extension of the CSE 224 project *Surfstore*.
## Usage
1. Download and unzip the release. On Linux, run your server using this:
```shell
bin/retainServe -s -p -l -d (blockStoreAddr*)
```
Here, `service` should be one of three values: meta, block, or both. This is used to specify the service provided by the server. `port` defines the port number that the server listens to (default=8080). `-l` configures the server to only listen on localhost. `-d` configures the server to output log statements. Lastly, (blockStoreAddr\*) is the BlockStore address that the server is configured with. If `service=both` then the blockStoreAddr should be the `ip:port` of this server.
2. Run your client using this:
```shell
bin/retainSync -d
```
### Examples
```shell
bin/retainServe -s both -p 8081 -l localhost:8081
```
This starts a server that listens only to localhost on port 8081 and services both the BlockStore and MetaStore interface.
```shell
Run the commands below on separate terminals (or nodes)
> bin/retainServe -s block -p 8081 -l
> bin/retainServe -s meta -l localhost:8081
```
The first line starts a server that services only the BlockStore interface and listens only to localhost on port 8081. The second line starts a server that services only the MetaStore interface, listens only to localhost on port 8080, and references the BlockStore we created as the underlying BlockStore. (Note: if these are on separate nodes, then you should use the public ip address and remove `-l`)
From a new terminal (or a new node), choose a base directory with some files in it.
```shell
> mkdir dataA
> cp ~/pic.jpg dataA/
> bin/retainSync server_addr:port dataA 4096
```
This would sync pic.jpg to the server hosted on `server_addr:port`, using `dataA` as the base directory, with a block size of 4096 bytes.
From another terminal (or a new node), run the client to sync with the server.
```shell
> mkdir dataB
> bin/retainSync server_addr:port dataB 4096
> ls dataB/
pic.jpg index.txt
```
We observe that pic.jpg has been synced to this client.