TrueCloudLab/frostfs-node
20
1
Fork 27
Code Issues 96 Pull requests 4 Projects Releases 1 Activity Actions

[#906] neofs-adm/docs: Fix language

Browse source 
Signed-off-by: Elizaveta Chichindaeva <elizaveta@nspcc.ru>
This commit is contained in:
Elizaveta Chichindaeva 2021-10-11 17:26:28 +03:00 committed by Alex Vanin
parent d50e8f2e72
commit 6c155f62c4
2 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
cmd/neofs-adm/README.md
View file

@ -3,16 +3,16 @@
## Overview ## Overview
Admin tool provides an easier way to deploy and maintain private installation Admin tool provides an easier way to deploy and maintain private installation
of NeoFS. Private installation contains a set of consensus N3 nodes, NeoFS of NeoFS. Private installation provides a set of consensus N3 nodes, NeoFS
Alphabet, and Storage nodes. Admin tool generates consensus keys, initializes Alphabet, and Storage nodes. Admin tool generates consensus keys, initializes
side chain and provides functions to update the network and register new side chain, and provides functions to update the network and register new
Storage nodes. Storage nodes.
## Build ## Build
To build binary locally use `make bin/neofs-adm` command. To build binary locally, use `make bin/neofs-adm` command.
For clean build inside docker container use `make docker/bin/neofs-adm`. For clean build inside a docker container use `make docker/bin/neofs-adm`.
Build docker image with `make image-adm`. Build docker image with `make image-adm`.
@ -27,7 +27,7 @@ contracts. Find them in the latest release of
Config section provides `init` command that creates configuration file for the Config section provides `init` command that creates configuration file for the
private installation deployment and updates. Config file is optional, all private installation deployment and updates. Config file is optional, all
parameters may be passed by arguments or read from standard input (wallet parameters can be passed by arguments or read from standard input (wallet
passwords). passwords).
Config example: Config example:
@ -57,14 +57,14 @@ credentials: # passwords for consensus node / alphabet wallets
#### Network deployment #### Network deployment
- Use `generate-alphabet` to generate set of wallets for consensus and - Use `generate-alphabet` to generate a set of wallets for consensus and
Alphabet nodes. Alphabet nodes.
- `init` will initialize side chain by deploying smart contracts and - `init` will initialize side chain by deploying smart contracts and
setting provided NeoFS network configuration. setting provided NeoFS network configuration.
- `generate-storage-wallet` generates wallet for the Storage node that - `generate-storage-wallet` generates wallet for the Storage node that
is ready for deployment. It also transfers a bit of side chain GAS so this is ready for deployment. It also transfers a bit of side chain GAS, so this
wallet can be used for NeoFS bootstrap. wallet can be used for NeoFS bootstrap.
#### Network maintenance #### Network maintenance
@ -72,20 +72,20 @@ credentials: # passwords for consensus node / alphabet wallets
- `force-new-epoch` increments NeoFS epoch number and enforces new epoch - `force-new-epoch` increments NeoFS epoch number and enforces new epoch
handlers in NeoFS nodes. handlers in NeoFS nodes.
- `refill-gas` transfers side chain GAS to specified wallet. - `refill-gas` transfers side chain GAS to the specified wallet.
- `update-contracts` starts contract update routine. - `update-contracts` starts contract update routine.
#### Container migration #### Container migration
If network has to be redeployed, these commands will migrate all container meta If the network has to be redeployed, these commands will migrate all container meta
info. These commands **do not migrate actual objects**. info. These commands **do not migrate actual objects**.
- `dump-containers` saves all containers and metadata registered in container - `dump-containers` saves all containers and metadata registered in the container
contract to a file. contract to a file.
- `restore-containers` restores previously saved containers in container - `restore-containers` restores previously saved containers by their repeated registration in
contract. container contract.
#### Network info #### Network info

12
cmd/neofs-adm/docs/deploy.md
View file

@ -14,12 +14,12 @@ To follow this guide you need:
## Step 1: Prepare network configuration ## Step 1: Prepare network configuration
To start the network you need a set of consensus nodes, the same number of To start the network, you need a set of consensus nodes, the same number of
Alphabet nodes and Storage nodes. While the number of Storage nodes can be Alphabet nodes and Storage nodes. While the number of Storage nodes can be
scaled almost infinitely, the number of consensus and Alphabet nodes can't be changed scaled almost infinitely, the number of consensus and Alphabet nodes can't be changed
so easily right now. Consider this before going any further. so easily right now. Consider this before going any further.
`neofs-adm` works best with predefined configuration. At first, create `neofs-adm` works best with predefined configuration. First, create
network configuration file. In this example, there is going to be only one network configuration file. In this example, there is going to be only one
consensus / Alphabet node in the network. consensus / Alphabet node in the network.
@ -87,7 +87,7 @@ NiMKabp3ddi3xShmLAXhTfbnuWb4cSJT6E (1 out of 1 multisig contract):
``` ```
Put the list of public keys into `ProtocolConfiguration.StandbyCommittee` Put the list of public keys into `ProtocolConfiguration.StandbyCommittee`
section. Specify wallet path and password in `ApplicationConfiguration.P2PNotary` section. Specify the wallet path and the password in `ApplicationConfiguration.P2PNotary`
and `ApplicationConfiguration.UnlockWallet` sections. and `ApplicationConfiguration.UnlockWallet` sections.
```yaml ```yaml
@ -105,10 +105,10 @@ ApplicationConfiguration:
Password: "hunter2" Password: "hunter2"
``` ```
Then launch consensus node. They should connect to each other and start Then, launch consensus node. They should connect to each other and start
producing blocks in consensus. You might want to deploy additional RPC producing blocks in consensus. You might want to deploy additional RPC
nodes at this stage because Storage nodes should be connected to the chain too. nodes at this stage because Storage nodes should be connected to the chain too.
It is not recommended to use consensus node as RPC node due to security policies It is not recommended to use consensus node as an RPC node due to security policies
and possible overload issues. and possible overload issues.
## Step 3: Initialize side chain ## Step 3: Initialize side chain
@ -148,7 +148,7 @@ Waiting for transactions to persist...
## Step 4: Launch Alphabet nodes ## Step 4: Launch Alphabet nodes
Configure Alphabet nodes with the wallets, generated in step 1. For Configure Alphabet nodes with the wallets generated in step 1. For
`morph.validators` use list of public keys from `morph.validators` use list of public keys from
`ProtocolConfiguration.StandbyCommittee`. `ProtocolConfiguration.StandbyCommittee`.