203 lines
5.8 KiB
Markdown
203 lines
5.8 KiB
Markdown
# FrostFS All-in-One
|
|
|
|
This repository contains Dockerfile for FrostFS All-in-One image and helper
|
|
scripts to start container. All-in-One image contains binaries and config
|
|
files for:
|
|
- neo-go
|
|
- frostfs-ir
|
|
- frostfs-storage
|
|
- frostfs-cli
|
|
- frostfs-adm
|
|
- frostfs-s3-gw
|
|
- frostfs-s3-authmate
|
|
- frostfs-http-gw
|
|
|
|
Entrypoint script starts blockchain, inner ring, storage, s3, and http gateway
|
|
services and configures it in the initial start.
|
|
|
|
| Service | Port |
|
|
|-----------------------------|-------|
|
|
| neo-go RPC | 30333 |
|
|
| FrostFS Storage gRPC API | 8080 |
|
|
| FrostFS Storage Control API | 16513 |
|
|
| FrostFS HTTP Gateway | 8081 |
|
|
| FrostFS S3 Gateway | 8084 |
|
|
|
|
|
|
# Prerequisites
|
|
|
|
- docker v20.10 or higher
|
|
- docker-compose v2.10 or higher
|
|
- make v3.82 or higher
|
|
|
|
> Makefile script runs docker-compose with `--wait` flag, which is introduced in
|
|
> docker-compose v2. You can use older version of docker-compose by executing it
|
|
> manually.
|
|
|
|
# Quick Start
|
|
|
|
Clone repository and start container with docker-compose.
|
|
|
|
``` sh
|
|
$ git clone https://git.frostfs.info/TrueCloudLab/frostfs-aio.git
|
|
$ cd frostfs-aio
|
|
$ make up tick.epoch
|
|
```
|
|
|
|
Initial start initializes the storage configuration. Its readiness is based
|
|
on a healthcheck done by `docker-compose`.
|
|
|
|
Container can be stopped with:
|
|
|
|
``` sh
|
|
$ make down
|
|
```
|
|
|
|
Data and the system configuration is stored in container's volume.
|
|
Next time container is started, it will take less time to initialize.
|
|
|
|
Before updating image version, reset `frostfs-aio` by clearing its local volume
|
|
before starting container.
|
|
|
|
```
|
|
$ make clean
|
|
```
|
|
|
|
Also, you may have to make sure the storage node is in the network map.
|
|
|
|
``` sh
|
|
$ docker exec -ti aio frostfs-cli netmap snapshot -c /config/cli-cfg-sn.yaml --rpc-endpoint 127.0.0.1:8080
|
|
Epoch: 45
|
|
Node 1: 022bb4041c50d607ff871dec7e4cd7778388e0ea6849d84ccbd9aa8f32e16a8131 ONLINE /dns4/localhost/tcp/8080
|
|
Continent: Europe
|
|
Country: Germany
|
|
CountryCode: DE
|
|
Deployed: Private
|
|
Location: Falkenstein
|
|
Price: 10
|
|
SubDiv: Sachsen
|
|
SubDivCode: SN
|
|
UN-LOCODE: DE FKS
|
|
```
|
|
|
|
If you don't see the output like this, you can wait for the new Epoch to come
|
|
or force the starting of new epoch.
|
|
|
|
``` sh
|
|
$ make tick.epoch
|
|
Current epoch: 1, increase to 2.
|
|
Waiting for transactions to persist...
|
|
```
|
|
|
|
# Build images
|
|
|
|
Build frostfs-aio image locally with this command.
|
|
|
|
``` sh
|
|
$ make image-aio
|
|
```
|
|
|
|
|
|
# Simple storage
|
|
|
|
|
|
## S3 interface
|
|
|
|
### Setup S3
|
|
|
|
As soon as the storage node is in the network map (see above) you can generate S3
|
|
credentials:
|
|
|
|
``` sh
|
|
$ make s3cred
|
|
{
|
|
"access_key_id": "EXArWh8x1zeHG3851s1RtoCo7dowxF6rhLGA15nbMffT0AKRSjJ5fmcqf3Ht2VCAkfmPQUVARghRB77xHCA1BoN2p",
|
|
"secret_access_key": "d70c1dba83f0f90bb231f06f1ce0e0dfbcfb122f4b4345a3c18d3869c359b79f",
|
|
"owner_private_key": "140947599afd9ca89af4b358c3176eb046e554d942a0dc99a8e06f3e43c8f4ad",
|
|
"wallet_public_key": "0324e76288fcb900100d01802a14ef977cca45ad073561230446df14b344c858b6",
|
|
"container_id": "EXArWh8x1zeHG3851s1RtoCo7dowxF6rhLGA15nbMffT"
|
|
}
|
|
```
|
|
|
|
Now let's configure an S3 client (AWS CLI will be used as example):
|
|
|
|
``` sh
|
|
$ aws configure
|
|
AWS Access Key ID []: EXArWh8x1zeHG3851s1RtoCo7dowxF6rhLGA15nbMffT0AKRSjJ5fmcqf3Ht2VCAkfmPQUVARghRB77xHCA1BoN2p
|
|
AWS Secret Access Key []: d70c1dba83f0f90bb231f06f1ce0e0dfbcfb122f4b4345a3c18d3869c359b79f
|
|
Default region name []: us-east-1
|
|
Default output format []: json
|
|
```
|
|
|
|
### Create a container
|
|
|
|
``` sh
|
|
$ aws s3api --endpoint http://localhost:8084 create-bucket --bucket koty --acl public-read-write
|
|
```
|
|
|
|
### Put an object
|
|
|
|
``` sh
|
|
$ aws s3api --endpoint http://localhost:8084 put-object --bucket koty --key kot --body cat.jpg
|
|
{
|
|
"ETag": "8677919550a90ff7106584285f25a70ac9e7aa38bdb4ed17d34bbfb366fd71b7"
|
|
}
|
|
```
|
|
|
|
### List objects
|
|
|
|
``` sh
|
|
$ aws s3api --endpoint http://localhost:8084 list-objects --bucket koty
|
|
{
|
|
"Contents": [
|
|
{
|
|
"Key": "kot",
|
|
"LastModified": "2023-02-17T15:01:52+00:00",
|
|
"ETag": "8677919550a90ff7106584285f25a70ac9e7aa38bdb4ed17d34bbfb366fd71b7",
|
|
"Size": 174512,
|
|
"Owner": {
|
|
"DisplayName": "NWeByJPgNC97F83hTUnSbnZSBKaFvk5HNw",
|
|
"ID": "NWeByJPgNC97F83hTUnSbnZSBKaFvk5HNw"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
|
|
## frostfs-cli interface
|
|
|
|
### Create container with frostfs-cli
|
|
|
|
``` sh
|
|
$ frostfs-cli -r localhost:8080 -w /config/user-wallet.json \
|
|
--address NWeByJPgNC97F83hTUnSbnZSBKaFvk5HNw \
|
|
container create \
|
|
--policy "REP 1" --basic-acl public-read-write --await
|
|
container ID: GfWw35kHds7gKWmSvW7Zi4U39K7NMLK8EfXBQ5FPJA46
|
|
awaiting...
|
|
container has been persisted on sidechain
|
|
```
|
|
|
|
### Put an object with frostfs-cli
|
|
|
|
``` sh
|
|
$ frostfs-cli -r localhost:8080 -w /config/user-wallet.json \
|
|
--address NWeByJPgNC97F83hTUnSbnZSBKaFvk5HNw \
|
|
object put \
|
|
--cid GfWw35kHds7gKWmSvW7Zi4U39K7NMLK8EfXBQ5FPJA46 \
|
|
--file cat.jpg
|
|
[cat.jpg] Object successfully stored
|
|
OID: HByVC9A34i22BnzW3n83z9vEMxuYZoC7nNu11ZvGeCTe
|
|
CID: GfWw35kHds7gKWmSvW7Zi4U39K7NMLK8EfXBQ5FPJA46
|
|
```
|
|
|
|
### Get and object with frostfs-cli
|
|
|
|
``` sh
|
|
$ frostfs-cli -r localhost:8080 -w /config/user-wallet.json \
|
|
--address NWeByJPgNC97F83hTUnSbnZSBKaFvk5HNw \
|
|
object get \
|
|
--cid GfWw35kHds7gKWmSvW7Zi4U39K7NMLK8EfXBQ5FPJA46 \
|
|
--oid HByVC9A34i22BnzW3n83z9vEMxuYZoC7nNu11ZvGeCTe > new_cat.jpg
|
|
```
|