From 6c155f62c4d0959cce7e9140cf6c8494c125c13a Mon Sep 17 00:00:00 2001 From: Elizaveta Chichindaeva Date: Mon, 11 Oct 2021 17:26:28 +0300 Subject: [PATCH] [#906] neofs-adm/docs: Fix language Signed-off-by: Elizaveta Chichindaeva --- cmd/neofs-adm/README.md | 24 ++++++++++++------------ cmd/neofs-adm/docs/deploy.md | 12 ++++++------ 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/cmd/neofs-adm/README.md b/cmd/neofs-adm/README.md index 1c5c4a83..0fd88737 100644 --- a/cmd/neofs-adm/README.md +++ b/cmd/neofs-adm/README.md @@ -3,16 +3,16 @@ ## Overview 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 -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. ## 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`. @@ -27,7 +27,7 @@ contracts. Find them in the latest release of Config section provides `init` command that creates configuration file for the 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). Config example: @@ -57,14 +57,14 @@ credentials: # passwords for consensus node / alphabet wallets #### 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. - `init` will initialize side chain by deploying smart contracts and setting provided NeoFS network configuration. - `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. #### Network maintenance @@ -72,20 +72,20 @@ credentials: # passwords for consensus node / alphabet wallets - `force-new-epoch` increments NeoFS epoch number and enforces new epoch 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. #### 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**. -- `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. -- `restore-containers` restores previously saved containers in container - contract. +- `restore-containers` restores previously saved containers by their repeated registration in + container contract. #### Network info diff --git a/cmd/neofs-adm/docs/deploy.md b/cmd/neofs-adm/docs/deploy.md index 28c2e477..15247c55 100644 --- a/cmd/neofs-adm/docs/deploy.md +++ b/cmd/neofs-adm/docs/deploy.md @@ -14,12 +14,12 @@ To follow this guide you need: ## 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 scaled almost infinitely, the number of consensus and Alphabet nodes can't be changed 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 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` -section. Specify wallet path and password in `ApplicationConfiguration.P2PNotary` +section. Specify the wallet path and the password in `ApplicationConfiguration.P2PNotary` and `ApplicationConfiguration.UnlockWallet` sections. ```yaml @@ -105,10 +105,10 @@ ApplicationConfiguration: 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 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. ## Step 3: Initialize side chain @@ -148,7 +148,7 @@ Waiting for transactions to persist... ## 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 `ProtocolConfiguration.StandbyCommittee`.