Anton Nikiforov
3e9bf56f27
Some checks failed
DCO action / DCO (pull_request) Failing after 1m33s
Tests and linters / Run gofumpt (pull_request) Successful in 2m1s
Vulncheck / Vulncheck (pull_request) Successful in 3m31s
Tests and linters / Staticcheck (pull_request) Successful in 3m44s
Build / Build Components (pull_request) Successful in 4m10s
Tests and linters / gopls check (pull_request) Successful in 4m3s
Pre-commit hooks / Pre-commit (pull_request) Successful in 4m19s
Tests and linters / Lint (pull_request) Successful in 4m51s
Tests and linters / Tests with -race (pull_request) Successful in 6m27s
Tests and linters / Tests (pull_request) Successful in 4m10s
Signed-off-by: Anton Nikiforov <an.nikiforov@yadro.com> |
||
---|---|---|
.docker | ||
.forgejo | ||
cmd | ||
config | ||
dev | ||
docs | ||
internal | ||
misc | ||
pkg | ||
scripts | ||
.dockerignore | ||
.gitattributes | ||
.gitignore | ||
.golangci.yml | ||
.pre-commit-config.yaml | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
CREDITS.md | ||
go.mod | ||
go.sum | ||
help.mk | ||
LICENSE | ||
Makefile | ||
README.md | ||
VERSION |
FrostFS is a decentralized distributed object storage integrated with the NEO Blockchain.
Overview
FrostFS Nodes are organized in a peer-to-peer network that takes care of storing and distributing user's data. Any Neo user may participate in the network and get paid for providing storage resources to other users or store their data in FrostFS and pay a competitive price for it.
Users can reliably store object data in the FrostFS network and have a transparent data placement process due to a decentralized architecture and flexible storage policies. Each node is responsible for executing the storage policies that the users select for geographical location, reliability level, number of nodes, type of disks, capacity, etc. Thus, FrostFS gives full control over data to users.
Deep Neo Blockchain integration allows FrostFS to be used by dApps directly from NeoVM on the Smart Contract code level. This way dApps are not limited to on-chain storage and can manipulate large amounts of data without paying a prohibitive price.
FrostFS has a native gRPC API and has protocol gateways for popular protocols such as AWS S3, HTTP, FUSE and sFTP allowing developers to integrate applications without rewriting their code.
Supported platforms
Now, we only support GNU/Linux on amd64 CPUs with AVX/AVX2 instructions. More
platforms will be officially supported after release 1.0
.
The latest version of frostfs-node works with frostfs-contract v0.19.2.
Building
To make all binaries you need Go 1.22+ and make
:
make all
The resulting binaries will appear in bin/
folder.
To make a specific binary use:
make bin/frostfs-<name>
See the list of all available commands in the cmd
folder.
Building with Docker
Building can also be performed in a container:
make docker/all # build all binaries
make docker/bin/frostfs-<name> # build a specific binary
Docker images
To make docker images suitable for use in frostfs-dev-env use:
make images
Debugging
VSCode
To run and debug single node cluster with VSCode:
- Clone and build frostfs-contract repository to the same directory level as
frostfs-node
. For example:
/
├── src
├── frostfs-node
└── frostfs-contract
See frostfs-contract
's README.md for build instructions.
-
Copy
launch.json
andtasks.json
fromdev/.vscode-example
directory to.vscode
directory. If you already have such files in.vscode
directory, then merge them manually. -
Go to Run and Debug (
Ctrl+Shift+D
) and startIR+Storage node
configuration. -
To create container and put object into it run (container and object IDs will be different):
./bin/frostfs-cli container create -r 127.0.0.1:8080 --wallet ./dev/wallet.json --policy "REP 1 IN X CBF 1 SELECT 1 FROM * AS X" --await
Enter password > <- press ENTER, the is no password for wallet
CID: CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju
./bin/frostfs-cli object put -r 127.0.0.1:8080 --wallet ./dev/wallet.json --file README.md --cid CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju
Enter password >
4300 / 4300 [===========================================================================================================================================================================================================] 100.00% 0s
[README.md] Object successfully stored
OID: 78sohnudVMnPsczXqsTUcvezosan2YDNVZwDE8Kq5YwU
CID: CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju
./bin/frostfs-cli object get -r 127.0.0.1:8080 --wallet ./dev/wallet.json --cid CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju --oid 78sohnudVMnPsczXqsTUcvezosan2YDNVZwDE8Kq5YwU
...
Contributing
Feel free to contribute to this project after reading the contributing guidelines.
Before starting to work on a certain topic, create a new issue first, describing the feature/topic you are going to implement.
Credits
FrostFS is maintained by True Cloud Lab with the help and contributions from community members.
Please see CREDITS for details.