TrueCloudLab/frostfs-dev-env
43
0
Fork 18
Code Issues 15 Pull requests Releases Activity Actions

[TrueCloudLab#1] Update docs

Browse source 
Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2022-12-21 14:59:19 +03:00 • committed by Alex Vanin
parent 6838092a50
commit ffe5012ab6
13 changed files with 93 additions and 225 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/basenet.md
View file

@ -7,7 +7,7 @@ host machine, so all programs running on host can connect to services exposed to
## .env settings
### LOCAL_DOMAIN=neofs.devenv
### LOCAL_DOMAIN=frostfs.devenv
Domain to use for all containers exposed to `basenet_internet`.
@ -28,7 +28,7 @@ devenv services.
Run shell in bastion:
```
neofs-dev-env$ docker exec -ti bastion /bin/bash
frostfs-dev-env$ docker exec -ti bastion /bin/bash
root@bastion:/# ip a sh
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00

38
docs/chain.md
View file

@ -4,10 +4,10 @@ A single-node N3 privnet deployment, running on
[neo-go](https://github.com/nspcc-dev/neo-go). Represents N3 MainNet.
Contracts deployed:
- NeoFS [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/neofs)
- Processing [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/processing)
- FrostFS [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/neofs)
- Processing [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/processing)
RPC available at `http://main-chain.neofs.devenv:30333`.
RPC available at `http://main-chain.frostfs.devenv:30333`.
## .env settings
@ -31,7 +31,7 @@ There is a wallet with GAS that used for contract deployment:
```
$ neo-go wallet nep17 balance \
-w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333
-r http://main-chain.frostfs.devenv:30333
Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM
GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf)
@ -40,14 +40,14 @@ GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf)
```
If you want to operate in main chain with your personal wallet (e.g. to make
a deposit in NeoFS contract), you can transfer GAS from there.
a deposit in FrostFS contract), you can transfer GAS from there.
1. Create new wallet.
```
$ neo-go wallet init -a -w wallets/neofs1.json
$ neo-go wallet init -a -w wallets/frostfs1.json
Enter the name of the account > neofs1
Enter the name of the account > frostfs1
Enter passphrase >
Confirm passphrase >
@ -57,7 +57,7 @@ Confirm passphrase >
{
"address": "NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6",
...
wallet successfully created, file location is wallets/neofs1.json
wallet successfully created, file location is wallets/frostfs1.json
```
2. Transfer GAS from `wallets/wallet.json`. The password is empty.
@ -65,7 +65,7 @@ wallet successfully created, file location is wallets/neofs1.json
```
$ neo-go wallet nep17 transfer \
-w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333 \
-r http://main-chain.frostfs.devenv:30333 \
--from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \
--to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \
--amount 50 \
@ -76,8 +76,8 @@ $ neo-go wallet nep17 transfer \
```
$ neo-go wallet nep17 balance \
-w wallets/neofs1.json \
-r http://main-chain.neofs.devenv:30333
-w wallets/frostfs1.json \
-r http://main-chain.frostfs.devenv:30333
Account NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6
GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf)
@ -98,7 +98,7 @@ Claim GAS to consensus node's wallet. Use account that contains NEO tokens.
```
$ neo-go wallet claim \
-w services/chain/node-wallet.json \
-r http://main-chain.neofs.devenv:30333 \
-r http://main-chain.frostfs.devenv:30333 \
-a NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \
Password >
70e09bbd55846dcc7cee23905b737c63e5a80d32e387bce108bc6db8e641fb90
@ -109,17 +109,17 @@ Then you can transfer GAS the same way as it was done in previous section.
```
$ neo-go wallet nep17 transfer \
-w services/chain/node-wallet.json \
-r http://main-chain.neofs.devenv:30333 \
-r http://main-chain.frostfs.devenv:30333 \
--from NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \
--to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \
--amount 50 \
--token GAS
```
## NeoFS GAS deposit
## FrostFS GAS deposit
NeoFS identifies users by their Neo wallet key pair. To start using NeoFS in
devenv you need to transfer some GAS to NeoFS contract in main chain.
FrostFS identifies users by their Neo wallet key pair. To start using FrostFS in
devenv you need to transfer some GAS to FrostFS contract in main chain.
Invoke `bin/deposit.sh` script by running `make prepare.ir` command to transfer
50 GAS from account in `wallets/wallet.json` file. Script enters passwords
@ -136,7 +136,7 @@ Script converts addresses and executes this command:
```
$ neo-go wallet nep17 transfer \
-w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333 \
-r http://main-chain.frostfs.devenv:30333 \
--from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \
--to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \
--token GAS \
@ -144,12 +144,12 @@ $ neo-go wallet nep17 transfer \
```
You can specify any wallet address scripthash in the transfer's data argument,
and NeoFS deposit will be transferred to that address.
and FrostFS deposit will be transferred to that address.
```
$ neo-go wallet nep17 transfer \
-w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333 \
-r http://main-chain.frostfs.devenv:30333 \
--from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \
--to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \
--token GAS \

14
docs/faq.md
View file

@ -1,9 +1,9 @@
# F.A.Q, tips and tricks
### How to export private key from Neo wallet for NeoFS use?
### How to export private key from Neo wallet for FrostFS use?
Private key for usage with NeoFS tools can be extracted from Neo wallet in three
Private key for usage with FrostFS tools can be extracted from Neo wallet in three
simple steps.
1. Get the key in WIF format
@ -17,7 +17,7 @@ KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
2. Convert form WIF to HEX
```
$ neofs-cli util keyer KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
$ frostfs-cli util keyer KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
PrivateKey 1dd37fba80fec4e6a6f13fd708d8dcb3b29def768017052f6c930fa1c5d90bbb
PublicKey 031a6c6fbbdf02ca351745fa86b9ba5a9452d785ac4f7fc2b7548ca2a46c4fcf4a
WIF KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
@ -35,16 +35,16 @@ $ xxd wallets/wallet.key
00000010: b29d ef76 8017 052f 6c93 0fa1 c5d9 0bbb ...v.../l.......
```
Later you will be able to provide wallet file in neofs-node config.
Later you will be able to provide wallet file in frostfs-node config.
### How to create Neo wallet JSON file using a NeoFS key file?
### How to create Neo wallet JSON file using a FrostFS key file?
You will need `neo-go` and `neofs-cli`.
You will need `neo-go` and `frostfs-cli`.
1. Get the WIF format of the private key
```
$ neofs-cli util keyer -key ./services/ir/01.key | grep WIF | awk '{print $NF}' > temp_WIF
$ frostfs-cli util keyer -key ./services/ir/01.key | grep WIF | awk '{print $NF}' > temp_WIF
```
2. Init a new empty Neo wallet

16
docs/http_gate.md
View file

@ -1,8 +1,8 @@
# HTTP Protocol gateway
Protocol Gateway to access data in NeoFS using HTTP protocol.
Protocol Gateway to access data in FrostFS using HTTP protocol.
Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-http-gate)
Source code and more information can be found in [project's GitHub repository](https://github.com/TrueCloudLab/frostfs-http-gate)
## .env settings
@ -10,10 +10,10 @@ Source code and more information can be found in [project's GitHub repository](h
Image version label to use for containers.
If you want to use locally built image, just set it's label here. Instead of
If you want to use locally built image, just set its label here. Instead of
pulling from DockerHub, the local image will be used.
### HTTP_GW_IMAGE=nspccdev/neofs-http-gw
### HTTP_GW_IMAGE=truecloudlab/frostfs-http-gw
Image label prefix to use for containers.
@ -21,7 +21,7 @@ Image label prefix to use for containers.
- Create a new container
```
$ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \
$ frostfs-cli --rpc-endpoint s01.frostfs.devenv:8080 \
--key wallets/wallet.key \
container create --basic-acl readonly --await \
--policy "REP 1 SELECT 1 FROM *"
@ -32,7 +32,7 @@ container has been persisted on sidechain
```
- Put an object into the newly created container
```
$ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \
$ frostfs-cli --rpc-endpoint s01.frostfs.devenv:8080 \
--key wallets/wallet.key \
object put --file /tmp/backup.jpeg \
--cid 4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP
@ -40,9 +40,9 @@ $ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \
ID: 6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB
CID: 4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP
```
- Call `curl -sSI -XGET http://http.neofs.devenv/get/<cid>/<oid>`
- Call `curl -sSI -XGET http://http.frostfs.devenv/get/<cid>/<oid>`
```
$ curl -sSI -XGET http://http.neofs.devenv/get/4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP/6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB
$ curl -sSI -XGET http://http.frostfs.devenv/get/4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP/6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB
HTTP/1.1 200 OK
Date: Thu, 03 Dec 2020 10:34:26 GMT
Content-Type: image/jpeg

6
docs/ir.md
View file

@ -1,6 +1,6 @@
# NeoFS Inner Ring
# FrostFS Inner Ring
NeoFS Inner Ring (Alphabet) node. According to governance scheme, Inner Ring
FrostFS Inner Ring (Alphabet) node. According to governance scheme, Inner Ring
should contain Alphabet nodes that share key with one of side chain consensus
nodes. In basic setup there is a single consensus node and single Inner Ring
(Alphabet) node.
@ -14,6 +14,6 @@ Image version label to use for Inner Ring docker containers.
If you want to use locally built image, just set it's label here. Instead of
pulling from DockerHub, the local image will be used.
### IR_IMAGE=nspccdev/neofs-ir
### IR_IMAGE=truecloudlab/frostfs-ir
Image label prefix to use for Inner Ring docker containers.

34
docs/morph.md
View file

@ -1,18 +1,18 @@
# N3 NeoFS side chain privnet service
# N3 FrostFS side chain privnet service
A single-node N3 privnet deployment, running on
[neo-go](https://github.com/nspcc-dev/neo-go). Represents N3 NeoFS SideChain.
[neo-go](https://github.com/nspcc-dev/neo-go). Represents N3 FrostFS SideChain.
Contracts deployed:
- Alphabet (AZ) [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/alphabet)
- Audit [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/audit)
- Balance [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/balance)
- Container [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/container)
- Netmap [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/netmap)
- NeoFSID [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/neofsid)
- Proxy [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/proxy)
- Reputation [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/reputation)
- Alphabet (AZ) [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/alphabet)
- Audit [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/audit)
- Balance [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/balance)
- Container [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/container)
- Netmap [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/netmap)
- NeoFSID [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/neofsid)
- Proxy [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/proxy)
- Reputation [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/reputation)
RPC available at `http://morph-chain.neofs.devenv:30333`.
RPC available at `http://morph-chain.frostfs.devenv:30333`.
## .env settings
@ -36,22 +36,22 @@ There is a wallet with GAS that used for contract deployment:
```
$ neo-go wallet nep17 balance \
-w wallets/wallet.json \
-r http://morph-chain.neofs.devenv:30333
-r http://morph-chain.frostfs.devenv:30333
Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM
GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf)
Amount : 189826.0515316
Updated: 3909
NEOFS: NeoFS Balance (69550190e740b93f92dbd5dea52246f550391057)
FROSTFS: FrostFS Balance (69550190e740b93f92dbd5dea52246f550391057)
Amount : 50
Updated: 3909
```
This way you can also monitor NeoFS internal balance of your account.
This way you can also monitor FrostFS internal balance of your account.
## NeoFS global config
## FrostFS global config
NeoFS uses global configuration to store epoch duration, maximum object size,
FrostFS uses global configuration to store epoch duration, maximum object size,
container fee and other network parameters. Global configuration is stored in
netmap contract and managed by Inner Ring (Alphabet) nodes.
@ -64,7 +64,7 @@ $ make update.epoch_duration val=30
Changing EpochDuration configration value to 30
Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password >
Sent invocation transaction bdc0fa88cd6719ef6df2b9c82de423ddec6141ca24255c2d0072688083b1de9d
Updating NeoFS epoch to 20
Updating FrostFS epoch to 20
Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password >
Sent invocation transaction 12296e1ce24dd6c04edb9c56d0a1d0e26d3226adefb0333c74a28788f44a8d0f
```

2
docs/notary.md
View file

@ -78,4 +78,4 @@ ApplicationConfiguration:
Main chain generates a block once per 15 seconds, so Inner Ring takes about
15-30 seconds to make a notary deposit in main chain after startup. Then
neofs-dev-env is ready to work.
frostfs-dev-env is ready to work.

12
docs/rest_gate.md
View file

@ -1,8 +1,8 @@
# REST Gateway
REST Gateway to access data in NeoFS using REST.
REST Gateway to access data in FrostFS using REST.
Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-rest-gw)
Source code and more information can be found in [project's GitHub repository](https://github.com/TrueCloudLab/frostfs-rest-gw)
## .env settings
@ -13,7 +13,7 @@ Image version label to use for containers.
If you want to use locally built image, just set its label here.
Instead of pulling from DockerHub, the local image will be used.
### REST_GW_IMAGE=nspccdev/neofs-rest-gw
### REST_GW_IMAGE=truecloudlab/frostfs-rest-gw
Image label prefix to use for containers.
@ -22,7 +22,7 @@ Image label prefix to use for containers.
- List container for specific owner:
```shell
$ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq
$ curl http://rest.frostfs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq
{
"containers": [
{
@ -49,7 +49,7 @@ $ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuG
- Get container info:
```shell
$ curl http://rest.neofs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq
$ curl http://rest.frostfs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq
{
"attributes": [
{
@ -67,4 +67,4 @@ $ curl http://rest.neofs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjT
}
```
See all available routes http://rest.neofs.devenv:8090/v1/docs
See all available routes http://rest.frostfs.devenv:8090/v1/docs

8
docs/s3_gate.md
View file

@ -1,8 +1,8 @@
# S3 Protocol gateway
Protocol Gateway to access data in NeoFS using AWS S3 protocol
Protocol Gateway to access data in FrostFS using AWS S3 protocol
Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-s3-gw)
Source code and more information can be found in [project's GitHub repository](https://github.com/TrueCloudLab/frostfs-s3-gw)
## .env settings
@ -10,9 +10,9 @@ Source code and more information can be found in [project's GitHub repository](h
Image version label to use for containers.
If you want to use locally built image, just set it's label here. Instead of
If you want to use locally built image, just set its label here. Instead of
pulling from DockerHub, the local image will be used.
### S3_GW_IMAGE=nspccdev/neofs-s3-gw
### S3_GW_IMAGE=truecloudlab/frostfs-s3-gw
Image label prefix to use for containers.

4
docs/storage.md
View file

@ -6,9 +6,9 @@
Image version label to use for Storage docker containers.
If you want to use locally built image, just set it's label here. Instead of
If you want to use locally built image, just set its label here. Instead of
pulling from DockerHub, the local image will be used.
### NODE_IMAGE=nspccdev/neofs-ir
### NODE_IMAGE=truecloudlab/frostfs-ir
Image label prefix to use for Storage docker containers.