dstepanov-yadro/frostfs-dev-env
1
0
Fork 0
forked from TrueCloudLab/frostfs-dev-env
Code Issues Pull requests Projects Releases Packages Wiki Activity

[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
Show stats Download patch file Download diff file Expand all files Collapse all files

129
.github/logo.svg vendored
View file

@ -1,129 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
sodipodi:docname="logo_fs.svg"
inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
id="svg57"
version="1.1"
viewBox="0 0 105 25"
height="25mm"
width="105mm">
<defs
id="defs51">
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath434">
<path
d="M 0,0 H 1366 V 768 H 0 Z"
id="path432" />
</clipPath>
</defs>
<sodipodi:namedview
inkscape:window-maximized="0"
inkscape:window-y="0"
inkscape:window-x="130"
inkscape:window-height="1040"
inkscape:window-width="1274"
height="50mm"
units="mm"
showgrid="false"
inkscape:document-rotation="0"
inkscape:current-layer="layer1"
inkscape:document-units="mm"
inkscape:cy="344.49897"
inkscape:cx="468.64708"
inkscape:zoom="0.7"
inkscape:pageshadow="2"
inkscape:pageopacity="0.0"
borderopacity="1.0"
bordercolor="#666666"
pagecolor="#ffffff"
id="base" />
<metadata
id="metadata54">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
id="layer1"
inkscape:groupmode="layer"
inkscape:label="Layer 1">
<g
id="g424"
transform="matrix(0.35277777,0,0,-0.35277777,63.946468,10.194047)">
<path
d="m 0,0 v -8.093 h 12.287 v -3.94 H 0 V -24.067 H -4.534 V 3.898 H 15.677 V 0 Z"
style="fill:#00e396;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path426" />
</g>
<g
transform="matrix(0.35277777,0,0,-0.35277777,-315.43002,107.34005)"
id="g428">
<g
id="g430"
clip-path="url(#clipPath434)">
<g
id="g436"
transform="translate(1112.874,278.2981)">
<path
d="M 0,0 C 1.822,-0.932 3.354,-2.359 4.597,-4.28 L 1.165,-7.373 c -0.791,1.695 -1.779,2.924 -2.966,3.686 -1.186,0.763 -2.768,1.145 -4.745,1.145 -1.949,0 -3.461,-0.389 -4.534,-1.166 -1.074,-0.777 -1.61,-1.772 -1.61,-2.987 0,-1.13 0.523,-2.027 1.568,-2.69 1.045,-0.664 2.909,-1.236 5.593,-1.716 2.514,-0.452 4.512,-1.024 5.995,-1.716 1.483,-0.693 2.564,-1.554 3.242,-2.585 0.677,-1.031 1.016,-2.309 1.016,-3.834 0,-1.639 -0.466,-3.079 -1.398,-4.322 -0.932,-1.243 -2.239,-2.197 -3.919,-2.86 -1.681,-0.664 -3.623,-0.996 -5.826,-0.996 -5.678,0 -9.689,1.892 -12.033,5.678 l 3.178,3.178 c 0.903,-1.695 2.068,-2.939 3.495,-3.729 1.426,-0.791 3.199,-1.186 5.318,-1.186 2.005,0 3.58,0.345 4.724,1.038 1.144,0.692 1.716,1.674 1.716,2.945 0,1.017 -0.516,1.835 -1.547,2.457 -1.031,0.621 -2.832,1.172 -5.402,1.653 -2.571,0.479 -4.618,1.073 -6.143,1.779 -1.526,0.706 -2.635,1.582 -3.326,2.627 -0.693,1.045 -1.039,2.316 -1.039,3.813 0,1.582 0.438,3.023 1.314,4.322 0.875,1.299 2.14,2.33 3.792,3.093 1.653,0.763 3.58,1.144 5.783,1.144 C -4.018,1.398 -1.822,0.932 0,0"
style="fill:#00e396;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path438" />
</g>
<g
id="g440"
transform="translate(993.0239,277.5454)">
<path
d="m 0,0 c 2.054,-1.831 3.083,-4.465 3.083,-7.902 v -17.935 h -4.484 v 16.366 c 0,2.914 -0.626,5.024 -1.877,6.332 -1.253,1.308 -2.924,1.962 -5.016,1.962 -1.495,0 -2.896,-0.327 -4.204,-0.981 -1.308,-0.654 -2.381,-1.719 -3.222,-3.194 -0.841,-1.477 -1.261,-3.335 -1.261,-5.576 v -14.909 h -4.484 V 1.328 l 4.086,-1.674 0.118,-1.84 c 0.933,1.681 2.222,2.923 3.867,3.727 1.643,0.803 3.493,1.205 5.548,1.205 C -4.671,2.746 -2.055,1.83 0,0"
style="fill:#000033;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path442" />
</g>
<g
id="g444"
transform="translate(1027.9968,264.0386)">
<path
d="m 0,0 h -21.128 c 0.261,-2.84 1.205,-5.044 2.83,-6.613 1.625,-1.57 3.727,-2.355 6.305,-2.355 2.054,0 3.763,0.356 5.128,1.065 1.363,0.71 2.288,1.738 2.774,3.083 l 3.755,-1.961 c -1.121,-1.981 -2.616,-3.495 -4.484,-4.54 -1.868,-1.046 -4.259,-1.569 -7.173,-1.569 -4.223,0 -7.538,1.289 -9.948,3.867 -2.41,2.578 -3.615,6.146 -3.615,10.704 0,4.558 1.149,8.127 3.447,10.705 2.298,2.578 5.557,3.867 9.779,3.867 2.615,0 4.876,-0.58 6.782,-1.738 1.905,-1.158 3.343,-2.728 4.315,-4.707 C -0.262,7.827 0.224,5.605 0.224,3.139 0.224,2.092 0.149,1.046 0,0 m -18.298,10.144 c -1.513,-1.457 -2.438,-3.512 -2.775,-6.165 h 16.982 c -0.3,2.615 -1.159,4.661 -2.578,6.137 -1.42,1.476 -3.307,2.214 -5.661,2.214 -2.466,0 -4.455,-0.728 -5.968,-2.186"
style="fill:#000033;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path446" />
</g>
<g
id="g448"
transform="translate(1057.8818,276.4246)">
<path
d="m 0,0 c 2.41,-2.578 3.615,-6.147 3.615,-10.705 0,-4.558 -1.205,-8.126 -3.615,-10.704 -2.41,-2.578 -5.726,-3.867 -9.948,-3.867 -4.222,0 -7.537,1.289 -9.947,3.867 -2.41,2.578 -3.615,6.146 -3.615,10.704 0,4.558 1.205,8.127 3.615,10.705 2.41,2.578 5.725,3.867 9.947,3.867 C -5.726,3.867 -2.41,2.578 0,0 m -16.617,-2.858 c -1.607,-1.906 -2.41,-4.522 -2.41,-7.847 0,-3.326 0.803,-5.94 2.41,-7.846 1.607,-1.905 3.83,-2.858 6.669,-2.858 2.839,0 5.063,0.953 6.67,2.858 1.606,1.906 2.41,4.52 2.41,7.846 0,3.325 -0.804,5.941 -2.41,7.847 C -4.885,-0.953 -7.109,0 -9.948,0 c -2.839,0 -5.062,-0.953 -6.669,-2.858"
style="fill:#000033;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path450" />
</g>
</g>
</g>
<g
id="g452"
transform="matrix(0.35277777,0,0,-0.35277777,5.8329581,6.5590171)">
<path
d="m 0,0 0.001,-38.946 25.286,-9.076 V -8.753 L 52.626,1.321 27.815,10.207 Z"
style="fill:#00e599;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path454" />
</g>
<g
id="g456"
transform="matrix(0.35277777,0,0,-0.35277777,15.479008,10.041927)">
<path
d="M 0,0 V -21.306 L 25.293,-30.364 25.282,9.347 Z"
style="fill:#00b091;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path458" />
</g>
</g>
</svg>
Side by side

Before

Width:  |  Height:  |  Size: 6.5 KiB

18
CONTRIBUTING.md
View file

@ -3,8 +3,8 @@
First, thank you for contributing! We love and encourage pull requests from First, thank you for contributing! We love and encourage pull requests from
everyone. Please follow the guidelines: everyone. Please follow the guidelines:
- Check the open [issues](https://github.com/nspcc-dev/neofs-dev-env/issues) and - Check the open [issues](https://github.com/TrueCloudLab/frostfs-dev-env/issues) and
[pull requests](https://github.com/nspcc-dev/neofs-dev-env/pulls) for existing [pull requests](https://github.com/TrueCloudLab/frostfs-dev-env/pulls) for existing
discussions. discussions.
- Open an issue first, to discuss a new feature or enhancement. - Open an issue first, to discuss a new feature or enhancement.
@ -21,23 +21,23 @@ everyone. Please follow the guidelines:
## Development Workflow ## Development Workflow
Start by forking the `neofs-dev-env` repository, make changes in a branch and then Start by forking the `frostfs-dev-env` repository, make changes in a branch and then
send a pull request. We encourage pull requests to discuss code changes. Here send a pull request. We encourage pull requests to discuss code changes. Here
are the steps in details: are the steps in details:
### Setup your GitHub Repository ### Set up your GitHub Repository
Fork [NeoFS node upstream](https://github.com/nspcc-dev/neofs-dev-env/fork) source Fork [FrostFS node upstream](https://github.com/TrueCloudLab/frostfs-dev-env/fork) source
repository to your own personal repository. Copy the URL of your fork (you will repository to your own personal repository. Copy the URL of your fork (you will
need it for the `git clone` command below). need it for the `git clone` command below).
```sh ```sh
$ git clone https://github.com/nspcc-dev/neofs-dev-env $ git clone https://github.com/TrueCloudLab/frostfs-dev-env
``` ```
### Set up git remote as ``upstream`` ### Set up git remote as ``upstream``
```sh ```sh
$ cd neofs-dev-env $ cd frostfs-dev-env
$ git remote add upstream https://github.com/nspcc-dev/neofs-dev-env $ git remote add upstream https://github.com/TrueCloudLab/frostfs-dev-env
$ git fetch upstream $ git fetch upstream
$ git merge upstream/master $ git merge upstream/master
... ...
@ -103,7 +103,7 @@ contributors".
To sign your work, just add a line like this at the end of your commit message: To sign your work, just add a line like this at the end of your commit message:
``` ```
Signed-off-by: Samii Sakisaka <samii@nspcc.ru> Signed-off-by: Samii Sakisaka <samii@frostfs.info>
``` ```
This can easily be done with the `--signoff` option to `git commit`. This can easily be done with the `--signoff` option to `git commit`.

33
README.md
View file

@ -1,14 +1,11 @@
<p align="center"> <p align="center">
<img src="./.github/logo.svg" width="500px" alt="NeoFS"> <a href="https://frostfs.info">FrostFS</a> local Development and Testing environment
</p>
<p align="center">
<a href="https://fs.neo.org">NeoFS</a> local Development and Testing environment
</p> </p>
--- ---
## Overview ## Overview
Tools to set up local NeoFS network and N3 privnets. Devenv, for short. Tools to set up local FrostFS network and N3 privnets. Devenv, for short.
## Prerequisites ## Prerequisites
@ -27,7 +24,7 @@ Make sure you have installed all of the following prerequisites on your machine:
Clone repo: Clone repo:
``` ```
$ git clone https://github.com/nspcc-dev/neofs-dev-env.git $ git clone https://github.com/TrueCloudLab/frostfs-dev-env.git
``` ```
Run next commands from project's root: Run next commands from project's root:
@ -42,11 +39,11 @@ been added already, there is no need to run it separately.
``` ```
$ make hosts $ make hosts
192.168.130.10 bastion.neofs.devenv 192.168.130.10 bastion.frostfs.devenv
192.168.130.50 main-chain.neofs.devenv 192.168.130.50 main-chain.frostfs.devenv
192.168.130.61 ir01.neofs.devenv 192.168.130.61 ir01.frostfs.devenv
... ...
192.168.130.74 s04.neofs.devenv 192.168.130.74 s04.frostfs.devenv
``` ```
This command shows addresses and hostnames of components. Add `make hosts` This command shows addresses and hostnames of components. Add `make hosts`
@ -58,7 +55,7 @@ $ make up
``` ```
When all services are up, you need to make GAS deposit for test wallet to be When all services are up, you need to make GAS deposit for test wallet to be
able to pay for NeoFS operations. Test wallet is located in able to pay for FrostFS operations. Test wallet is located in
`wallets/wallet.json` with the corresponding key in `wallets/wallet.key`. The `wallets/wallet.json` with the corresponding key in `wallets/wallet.key`. The
password is empty. password is empty.
@ -68,16 +65,16 @@ password >
fa6ba62bffb04030d303dcc95bda7413e03aa3c7e6ca9c2f999d65db9ec9b82c fa6ba62bffb04030d303dcc95bda7413e03aa3c7e6ca9c2f999d65db9ec9b82c
``` ```
Also you should add self-signed node (`s04.neofs.devenv`) certificate to trusted Also, you should add self-signed node (`s04.frostfs.devenv`) certificate to trusted
store (default location might be changed using `CA_CERTS_TRUSTED_STORE` store (default location might be changed using `CA_CERTS_TRUSTED_STORE`
variable). This step is required for client services (neofs-http-gw, variable). This step is required for client services (frostfs-http-gw,
neofs-s3-gw) to interact with the node: frostfs-s3-gw) to interact with the node:
``` ```
$ sudo make prepare.storage $ sudo make prepare.storage
``` ```
Change NeoFS global configuration values with `make update.*` commands. The Change FrostFS global configuration values with `make update.*` commands. The
password of inner ring wallet is `one`. See examples in `make help`. password of inner ring wallet is `one`. See examples in `make help`.
``` ```
@ -85,7 +82,7 @@ $ make update.epoch_duration val=30
Changing EpochDuration configration value to 30 Changing EpochDuration configration value to 30
Enter account NNudMSGzEoktFzdYGYoNb3bzHzbmM1genF password > Enter account NNudMSGzEoktFzdYGYoNb3bzHzbmM1genF password >
Sent invocation transaction dbb8c1145b6d10f150135630e13bb0dc282023163f5956c6945a60db0cb45cb0 Sent invocation transaction dbb8c1145b6d10f150135630e13bb0dc282023163f5956c6945a60db0cb45cb0
Updating NeoFS epoch to 2 Updating FrostFS epoch to 2
Enter account NNudMSGzEoktFzdYGYoNb3bzHzbmM1genF password > Enter account NNudMSGzEoktFzdYGYoNb3bzHzbmM1genF password >
Sent invocation transaction 0e6eb5e190f36332e5e5f4e866c7e100826e285fd949e11c085e15224f343ba6 Sent invocation transaction 0e6eb5e190f36332e5e5f4e866c7e100826e285fd949e11c085e15224f343ba6
``` ```
@ -121,9 +118,9 @@ You can find more information on each service in `docs` directory.
Maybe you will find the answer for your question in [F.A.Q.](docs/faq.md) Maybe you will find the answer for your question in [F.A.Q.](docs/faq.md)
## Using NeoFS Admin Tool in `dev-env` ## Using FrostFS Admin Tool in `dev-env`
Devenv supports NeoFS network management via [neofs-adm](https://github.com/nspcc-dev/neofs-node/tree/master/cmd/neofs-adm). Devenv supports FrostFS network management via [frostfs-adm](https://github.com/TrueCloudLab/frostfs-node/tree/master/cmd/frostfs-adm).
`services/ir` contains the Alphabet wallet in a proper format, specify it `services/ir` contains the Alphabet wallet in a proper format, specify it
with `--alphabet-wallets` flag. with `--alphabet-wallets` flag.

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 ## .env settings
### LOCAL_DOMAIN=neofs.devenv ### LOCAL_DOMAIN=frostfs.devenv
Domain to use for all containers exposed to `basenet_internet`. Domain to use for all containers exposed to `basenet_internet`.
@ -28,7 +28,7 @@ devenv services.
Run shell in bastion: 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 root@bastion:/# ip a sh
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 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 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. [neo-go](https://github.com/nspcc-dev/neo-go). Represents N3 MainNet.
Contracts deployed: Contracts deployed:
- NeoFS [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/neofs) - FrostFS [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/neofs)
- Processing [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/processing) - 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 ## .env settings
@ -31,7 +31,7 @@ There is a wallet with GAS that used for contract deployment:
``` ```
$ neo-go wallet nep17 balance \ $ neo-go wallet nep17 balance \
-w wallets/wallet.json \ -w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333 -r http://main-chain.frostfs.devenv:30333
Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM
GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf) 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 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. 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 > Enter passphrase >
Confirm passphrase > Confirm passphrase >
@ -57,7 +57,7 @@ Confirm passphrase >
{ {
"address": "NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6", "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. 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 \ $ neo-go wallet nep17 transfer \
-w wallets/wallet.json \ -w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333 \ -r http://main-chain.frostfs.devenv:30333 \
--from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \ --from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \
--to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \ --to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \
--amount 50 \ --amount 50 \
@ -76,8 +76,8 @@ $ neo-go wallet nep17 transfer \
``` ```
$ neo-go wallet nep17 balance \ $ neo-go wallet nep17 balance \
-w wallets/neofs1.json \ -w wallets/frostfs1.json \
-r http://main-chain.neofs.devenv:30333 -r http://main-chain.frostfs.devenv:30333
Account NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 Account NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6
GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf) GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf)
@ -98,7 +98,7 @@ Claim GAS to consensus node's wallet. Use account that contains NEO tokens.
``` ```
$ neo-go wallet claim \ $ neo-go wallet claim \
-w services/chain/node-wallet.json \ -w services/chain/node-wallet.json \
-r http://main-chain.neofs.devenv:30333 \ -r http://main-chain.frostfs.devenv:30333 \
-a NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \ -a NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \
Password > Password >
70e09bbd55846dcc7cee23905b737c63e5a80d32e387bce108bc6db8e641fb90 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 \ $ neo-go wallet nep17 transfer \
-w services/chain/node-wallet.json \ -w services/chain/node-wallet.json \
-r http://main-chain.neofs.devenv:30333 \ -r http://main-chain.frostfs.devenv:30333 \
--from NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \ --from NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP \
--to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \ --to NXnzw3J9VvKXjM1BPAJK4QUpTtEQu4TpU6 \
--amount 50 \ --amount 50 \
--token GAS --token GAS
``` ```
## NeoFS GAS deposit ## FrostFS GAS deposit
NeoFS identifies users by their Neo wallet key pair. To start using NeoFS in FrostFS identifies users by their Neo wallet key pair. To start using FrostFS in
devenv you need to transfer some GAS to NeoFS contract in main chain. 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 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 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 \ $ neo-go wallet nep17 transfer \
-w wallets/wallet.json \ -w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333 \ -r http://main-chain.frostfs.devenv:30333 \
--from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \ --from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \
--to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \ --to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \
--token GAS \ --token GAS \
@ -144,12 +144,12 @@ $ neo-go wallet nep17 transfer \
``` ```
You can specify any wallet address scripthash in the transfer's data argument, 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 \ $ neo-go wallet nep17 transfer \
-w wallets/wallet.json \ -w wallets/wallet.json \
-r http://main-chain.neofs.devenv:30333 \ -r http://main-chain.frostfs.devenv:30333 \
--from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \ --from NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM \
--to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \ --to NerhjaqJsJt4LxMqUbkkVMpsF2d9TtcpFv \
--token GAS \ --token GAS \

14
docs/faq.md
View file

@ -1,9 +1,9 @@
# F.A.Q, tips and tricks # 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. simple steps.
1. Get the key in WIF format 1. Get the key in WIF format
@ -17,7 +17,7 @@ KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
2. Convert form WIF to HEX 2. Convert form WIF to HEX
``` ```
$ neofs-cli util keyer KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr $ frostfs-cli util keyer KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
PrivateKey 1dd37fba80fec4e6a6f13fd708d8dcb3b29def768017052f6c930fa1c5d90bbb PrivateKey 1dd37fba80fec4e6a6f13fd708d8dcb3b29def768017052f6c930fa1c5d90bbb
PublicKey 031a6c6fbbdf02ca351745fa86b9ba5a9452d785ac4f7fc2b7548ca2a46c4fcf4a PublicKey 031a6c6fbbdf02ca351745fa86b9ba5a9452d785ac4f7fc2b7548ca2a46c4fcf4a
WIF KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr WIF KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
@ -35,16 +35,16 @@ $ xxd wallets/wallet.key
00000010: b29d ef76 8017 052f 6c93 0fa1 c5d9 0bbb ...v.../l....... 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 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 2. Init a new empty Neo wallet

16
docs/http_gate.md
View file

@ -1,8 +1,8 @@
# HTTP Protocol gateway # 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 ## .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. 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. 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. Image label prefix to use for containers.
@ -21,7 +21,7 @@ Image label prefix to use for containers.
- Create a new container - Create a new container
``` ```
$ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \ $ frostfs-cli --rpc-endpoint s01.frostfs.devenv:8080 \
--key wallets/wallet.key \ --key wallets/wallet.key \
container create --basic-acl readonly --await \ container create --basic-acl readonly --await \
--policy "REP 1 SELECT 1 FROM *" --policy "REP 1 SELECT 1 FROM *"
@ -32,7 +32,7 @@ container has been persisted on sidechain
``` ```
- Put an object into the newly created container - 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 \ --key wallets/wallet.key \
object put --file /tmp/backup.jpeg \ object put --file /tmp/backup.jpeg \
--cid 4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP --cid 4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP
@ -40,9 +40,9 @@ $ neofs-cli --rpc-endpoint s01.neofs.devenv:8080 \
ID: 6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB ID: 6EPpYqSFMGWrNLvYE9mNnut1CPKuPBKyi1ixHakzqsSB
CID: 4LfREK1cetL4PUji5fqj9SgRTSmaC5jExEDK9HKCDjdP 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 HTTP/1.1 200 OK
Date: Thu, 03 Dec 2020 10:34:26 GMT Date: Thu, 03 Dec 2020 10:34:26 GMT
Content-Type: image/jpeg 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 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 nodes. In basic setup there is a single consensus node and single Inner Ring
(Alphabet) node. (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 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. 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. 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 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: Contracts deployed:
- Alphabet (AZ) [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/alphabet) - Alphabet (AZ) [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/alphabet)
- Audit [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/audit) - Audit [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/audit)
- Balance [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/balance) - Balance [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/balance)
- Container [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/container) - Container [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/container)
- Netmap [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/netmap) - Netmap [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/netmap)
- NeoFSID [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/neofsid) - NeoFSID [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/neofsid)
- Proxy [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/proxy) - Proxy [contract](https://github.com/TrueCloudLab/frostfs-contract/tree/master/proxy)
- Reputation [contract](https://github.com/nspcc-dev/neofs-contract/tree/master/reputation) - 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 ## .env settings
@ -36,22 +36,22 @@ There is a wallet with GAS that used for contract deployment:
``` ```
$ neo-go wallet nep17 balance \ $ neo-go wallet nep17 balance \
-w wallets/wallet.json \ -w wallets/wallet.json \
-r http://morph-chain.neofs.devenv:30333 -r http://morph-chain.frostfs.devenv:30333
Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM Account NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM
GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf) GAS: GasToken (d2a4cff31913016155e38e474a2c06d08be276cf)
Amount : 189826.0515316 Amount : 189826.0515316
Updated: 3909 Updated: 3909
NEOFS: NeoFS Balance (69550190e740b93f92dbd5dea52246f550391057) FROSTFS: FrostFS Balance (69550190e740b93f92dbd5dea52246f550391057)
Amount : 50 Amount : 50
Updated: 3909 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 container fee and other network parameters. Global configuration is stored in
netmap contract and managed by Inner Ring (Alphabet) nodes. 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 Changing EpochDuration configration value to 30
Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password > Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password >
Sent invocation transaction bdc0fa88cd6719ef6df2b9c82de423ddec6141ca24255c2d0072688083b1de9d Sent invocation transaction bdc0fa88cd6719ef6df2b9c82de423ddec6141ca24255c2d0072688083b1de9d
Updating NeoFS epoch to 20 Updating FrostFS epoch to 20
Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password > Enter account NfgHwwTi3wHAS8aFAN243C5vGbkYDpqLHP password >
Sent invocation transaction 12296e1ce24dd6c04edb9c56d0a1d0e26d3226adefb0333c74a28788f44a8d0f 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 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 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
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 ## .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. If you want to use locally built image, just set its label here.
Instead of pulling from DockerHub, the local image will be used. 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. Image label prefix to use for containers.
@ -22,7 +22,7 @@ Image label prefix to use for containers.
- List container for specific owner: - List container for specific owner:
```shell ```shell
$ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq $ curl http://rest.frostfs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq
{ {
"containers": [ "containers": [
{ {
@ -49,7 +49,7 @@ $ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuG
- Get container info: - Get container info:
```shell ```shell
$ curl http://rest.neofs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq $ curl http://rest.frostfs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq
{ {
"attributes": [ "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 # 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 ## .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. 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. 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. 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. 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. 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. Image label prefix to use for Storage docker containers.