aarifullin/frostfs-node
1
0
Fork 0
forked from TrueCloudLab/frostfs-node
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#11] Rename NeoFS to FrostFS in docs

Browse source 
Signed-off-by: Evgenii Stratonikov <e.stratonikov@yadro.com>
This commit is contained in:
Evgenii Stratonikov 2023-01-11 17:26:49 +03:00 committed by fyrchik
parent 3d1d2ee7b1
commit d4d2a8c865
7 changed files with 38 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
cmd/frostfs-adm/README.md
View file

@ -3,7 +3,7 @@
## 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 provides a set of N3 consensus nodes, NeoFS of FrostFS. Private installation provides a set of N3 consensus nodes, FrostFS
Alphabet, and Storage nodes. Admin tool generates consensus keys, initializes Alphabet, and Storage nodes. Admin tool generates consensus keys, initializes
the sidechain, and provides functions to update the network and register new the sidechain, and provides functions to update the network and register new
Storage nodes. Storage nodes.
@ -16,7 +16,7 @@ For clean build inside a docker container, use `make docker/bin/frostfs-adm`.
Build docker image with `make image-adm`. Build docker image with `make image-adm`.
At NeoFS private install deployment, frostfs-adm requires compiled NeoFS At FrostFS private install deployment, frostfs-adm requires compiled FrostFS
contracts. Find them in the latest release of contracts. Find them in the latest release of
[frostfs-contract repository](https://github.com/TrueCloudLab/frostfs-contract/releases). [frostfs-contract repository](https://github.com/TrueCloudLab/frostfs-contract/releases).
@ -35,8 +35,8 @@ Config example:
rpc-endpoint: https://address:port # sidechain RPC node endpoint rpc-endpoint: https://address:port # sidechain RPC node endpoint
alphabet-wallets: /path # path to consensus node / alphabet wallets storage alphabet-wallets: /path # path to consensus node / alphabet wallets storage
network: network:
max_object_size: 67108864 # max size of a single NeoFS object, bytes max_object_size: 67108864 # max size of a single FrostFS object, bytes
epoch_duration: 240 # duration of a NeoFS epoch in blocks, consider block generation frequency in the sidechain epoch_duration: 240 # duration of a FrostFS epoch in blocks, consider block generation frequency in the sidechain
basic_income_rate: 0 # basic income rate, for private consider 0 basic_income_rate: 0 # basic income rate, for private consider 0
fee: fee:
audit: 0 # network audit fee, for private installation consider 0 audit: 0 # network audit fee, for private installation consider 0
@ -62,18 +62,18 @@ credentials: # passwords for consensus node / alphabet wallets
Alphabet nodes. Alphabet nodes.
- `init` initializes the sidechain by deploying smart contracts and - `init` initializes the sidechain by deploying smart contracts and
setting provided NeoFS network configuration. setting provided FrostFS network configuration.
- `generate-storage-wallet` generates a wallet for the Storage node that - `generate-storage-wallet` generates a wallet for the Storage node that
is ready for deployment. It also transfers a bit of sidechain GAS, so this is ready for deployment. It also transfers a bit of sidechain GAS, so this
wallet can be used for NeoFS bootstrap. wallet can be used for FrostFS bootstrap.
#### Network maintenance #### Network maintenance
- `set-config` add/update configuration values in the Netmap contract. - `set-config` add/update configuration values in the Netmap contract.
- `force-new-epoch` increments NeoFS epoch number and executes new epoch - `force-new-epoch` increments FrostFS epoch number and executes new epoch
handlers in NeoFS nodes. handlers in FrostFS nodes.
- `refill-gas` transfers sidechain GAS to the specified wallet. - `refill-gas` transfers sidechain GAS to the specified wallet.
@ -94,9 +94,9 @@ info. These commands **do not migrate actual objects**.
#### Network info #### Network info
- `dump-config` prints NeoFS network configuration. - `dump-config` prints FrostFS network configuration.
- `dump-hashes` prints NeoFS contract addresses stored in NNS. - `dump-hashes` prints FrostFS contract addresses stored in NNS.
## Private network deployment ## Private network deployment

28
cmd/frostfs-adm/docs/deploy.md
View file

@ -1,6 +1,6 @@
# Step-by-step private NeoFS deployment # Step-by-step private FrostFS deployment
This is a short guide on how to deploy a private NeoFS storage network on bare This is a short guide on how to deploy a private FrostFS storage network on bare
metal without docker images. This guide does not cover details on how to start metal without docker images. This guide does not cover details on how to start
consensus, Alphabet, or Storage nodes. This guide covers only `frostfs-adm` consensus, Alphabet, or Storage nodes. This guide covers only `frostfs-adm`
related configuration details. related configuration details.
@ -118,7 +118,7 @@ and possible overload issues.
## Step 3: Initialize sidechain ## Step 3: Initialize sidechain
Use archive with compiled NeoFS contracts to initialize the sidechain. Use archive with compiled FrostFS contracts to initialize the sidechain.
``` ```
$ tar -xzvf frostfs-contract-v0.11.0.tar.gz $ tar -xzvf frostfs-contract-v0.11.0.tar.gz
@ -130,7 +130,7 @@ Stage 2: set notary and alphabet nodes in designate contract.
Waiting for transactions to persist... Waiting for transactions to persist...
Stage 3: deploy NNS contract. Stage 3: deploy NNS contract.
Waiting for transactions to persist... Waiting for transactions to persist...
Stage 4: deploy NeoFS contracts. Stage 4: deploy FrostFS contracts.
Waiting for transactions to persist... Waiting for transactions to persist...
Stage 4.1: Transfer GAS to proxy contract. Stage 4.1: Transfer GAS to proxy contract.
Waiting for transactions to persist... Waiting for transactions to persist...
@ -140,14 +140,14 @@ Stage 6: transfer NEO to alphabet contracts.
Waiting for transactions to persist... Waiting for transactions to persist...
Stage 7: set addresses in NNS. Stage 7: set addresses in NNS.
Waiting for transactions to persist... Waiting for transactions to persist...
NNS: Set alphabet0.neofs -> f692dfb4d43a15b464eb51a7041160fb29c44b6a NNS: Set alphabet0.frostfs -> f692dfb4d43a15b464eb51a7041160fb29c44b6a
NNS: Set audit.neofs -> 7df847b993affb3852074345a7c2bd622171ee0d NNS: Set audit.frostfs -> 7df847b993affb3852074345a7c2bd622171ee0d
NNS: Set balance.neofs -> 103519b3067a66307080a66570c0491ee8f68879 NNS: Set balance.frostfs -> 103519b3067a66307080a66570c0491ee8f68879
NNS: Set container.neofs -> cae60bdd689d185901e495352d0247752ce50846 NNS: Set container.frostfs -> cae60bdd689d185901e495352d0247752ce50846
NNS: Set neofsid.neofs -> c421fb60a3895865a8f24d197d6a80ef686041d2 NNS: Set frostfsid.frostfs -> c421fb60a3895865a8f24d197d6a80ef686041d2
NNS: Set netmap.neofs -> 894eb854632f50fb124412ce7951ebc00763525e NNS: Set netmap.frostfs -> 894eb854632f50fb124412ce7951ebc00763525e
NNS: Set proxy.neofs -> ac6e6fe4b373d0ca0ca4969d1e58fa0988724e7d NNS: Set proxy.frostfs -> ac6e6fe4b373d0ca0ca4969d1e58fa0988724e7d
NNS: Set reputation.neofs -> 6eda57c9d93d990573646762d1fea327ce41191f NNS: Set reputation.frostfs -> 6eda57c9d93d990573646762d1fea327ce41191f
Waiting for transactions to persist... Waiting for transactions to persist...
``` ```
@ -196,7 +196,7 @@ node:
password: "foobar" password: "foobar"
``` ```
The storage node will be included in the network map in the next NeoFS epoch. To The storage node will be included in the network map in the next FrostFS epoch. To
speed up this process, you can increment epoch counter immediately. speed up this process, you can increment epoch counter immediately.
``` ```
@ -207,5 +207,5 @@ Waiting for transactions to persist...
--- ---
After that, NeoFS Storage is ready to work. You can access it directly or After that, FrostFS Storage is ready to work. You can access it directly or
with protocol gates. with protocol gates.

6
cmd/frostfs-adm/docs/subnetwork-creation.md
View file

@ -1,6 +1,6 @@
# NeoFS subnetwork creation # FrostFS subnetwork creation
This is a short guide on how to create NeoFS subnetworks. This guide This is a short guide on how to create FrostFS subnetworks. This guide
considers that the sidechain and the inner ring (alphabet nodes) have already been considers that the sidechain and the inner ring (alphabet nodes) have already been
deployed and the sidechain contains a deployed `subnet` contract. deployed and the sidechain contains a deployed `subnet` contract.
@ -9,7 +9,7 @@ deployed and the sidechain contains a deployed `subnet` contract.
To follow this guide, you need: To follow this guide, you need:
- neo-go sidechain RPC endpoint; - neo-go sidechain RPC endpoint;
- latest released version of [frostfs-adm](https://github.com/TrueCloudLab/frostfs-node/releases); - latest released version of [frostfs-adm](https://github.com/TrueCloudLab/frostfs-node/releases);
- wallet with NeoFS account. - wallet with FrostFS account.
## Creation ## Creation

6
cmd/frostfs-adm/docs/subnetwork-usage.md
View file

@ -1,6 +1,6 @@
# Managing Subnetworks # Managing Subnetworks
This is a short guide on how to manage NeoFS subnetworks. This guide This is a short guide on how to manage FrostFS subnetworks. This guide
considers that the sidechain and the inner ring (alphabet nodes) have already been considers that the sidechain and the inner ring (alphabet nodes) have already been
deployed, and the sidechain contains a deployed `subnet` contract. deployed, and the sidechain contains a deployed `subnet` contract.
@ -12,7 +12,7 @@ deployed, and the sidechain contains a deployed `subnet` contract.
- wallet with the account that owns the subnetwork; - wallet with the account that owns the subnetwork;
- public key of the Storage Node; - public key of the Storage Node;
- public keys of the node and client administrators; - public keys of the node and client administrators;
- owner IDs of the NeoFS users. - owner IDs of the FrostFS users.
## Add node administrator ## Add node administrator
@ -99,7 +99,7 @@ configuration:
node: node:
... ...
subnet: subnet:
entries: # list of IDs of subnets to enter in a text format of NeoFS API protocol (overrides corresponding attributes) entries: # list of IDs of subnets to enter in a text format of FrostFS API protocol (overrides corresponding attributes)
- <subnetwork_ID> - <subnetwork_ID>
... ...
... ...

6
config/example/ir.yaml
View file

@ -77,7 +77,7 @@ workers:
alphabet: 10 # Number of workers to process events from alphabet contract in parallel alphabet: 10 # Number of workers to process events from alphabet contract in parallel
balance: 10 # Number of workers to process events from balance contract in parallel balance: 10 # Number of workers to process events from balance contract in parallel
container: 10 # Number of workers to process events from container contract in parallel container: 10 # Number of workers to process events from container contract in parallel
neofs: 10 # Number of workers to process events from neofs contracts in parallel frostfs: 10 # Number of workers to process events from frostfs contracts in parallel
netmap: 10 # Number of workers to process events from netmap contract in parallel netmap: 10 # Number of workers to process events from netmap contract in parallel
reputation: 10 # Number of workers to process events from reputation contract in parallel reputation: 10 # Number of workers to process events from reputation contract in parallel
subnet: 10 # Number of workers to process events from subnet contract in parallel subnet: 10 # Number of workers to process events from subnet contract in parallel
@ -105,12 +105,12 @@ netmap_cleaner:
threshold: 3 # Number of NeoFS epoch without bootstrap request from storage node before it considered stale threshold: 3 # Number of NeoFS epoch without bootstrap request from storage node before it considered stale
contracts: contracts:
neofs: ee3dee6d05dc79c24a5b8f6985e10d68b7cacc62 # Address of NeoFS contract in mainchain; ignore if mainchain is disabled frostfs: ee3dee6d05dc79c24a5b8f6985e10d68b7cacc62 # Address of FrostFS contract in mainchain; ignore if mainchain is disabled
processing: 597f5894867113a41e192801709c02497f611de8 # Address of processing contract in mainchain; ignore if mainchain is disabled or notary is disabled in mainchain processing: 597f5894867113a41e192801709c02497f611de8 # Address of processing contract in mainchain; ignore if mainchain is disabled or notary is disabled in mainchain
audit: 219e37aed2180b87e7fe945dbf97d67125e8d73f # Optional: override address of audit contract in sidechain audit: 219e37aed2180b87e7fe945dbf97d67125e8d73f # Optional: override address of audit contract in sidechain
balance: d2aa48d14b17b11bc4c68205027884a96706dd16 # Optional: override address of balance contract in sidechain balance: d2aa48d14b17b11bc4c68205027884a96706dd16 # Optional: override address of balance contract in sidechain
container: ed4a7a66fe3f9bfe50f214b49be8f215a3c886b6 # Optional: override address of container contract in sidechain container: ed4a7a66fe3f9bfe50f214b49be8f215a3c886b6 # Optional: override address of container contract in sidechain
neofsid: 9f5866decbc751a099e74c7c7bc89f609201755a # Optional: override address of neofsid contract in sidechain frostfsid: 9f5866decbc751a099e74c7c7bc89f609201755a # Optional: override address of frostfsid contract in sidechain
netmap: 83c600c81d47a1b1b7cf58eb49ae7ee7240dc742 # Optional: override address of netmap contract in sidechain netmap: 83c600c81d47a1b1b7cf58eb49ae7ee7240dc742 # Optional: override address of netmap contract in sidechain
proxy: abc8794bb40a21f2db5f21ae62741eb46c8cad1c # Optional: override address of proxy contract in sidechain; ignore if notary is disabled in sidechain proxy: abc8794bb40a21f2db5f21ae62741eb46c8cad1c # Optional: override address of proxy contract in sidechain; ignore if notary is disabled in sidechain
reputation: d793b842ff0c103fe89e385069e82a27602135ff # Optional: override address of reputation contract in sidechain reputation: d793b842ff0c103fe89e385069e82a27602135ff # Optional: override address of reputation contract in sidechain

4
docs/maintenance.md
View file

@ -25,7 +25,7 @@ Maintenance mode allowed: true
... ...
``` ```
To toggle the setting in the running NeoFS Sidechain, exec: To toggle the setting in the running FrostFS Sidechain, exec:
```shell ```shell
$ frostfs-adm morph set-config MaintenanceModeAllowed=true|false $ frostfs-adm morph set-config MaintenanceModeAllowed=true|false
``` ```
@ -46,7 +46,7 @@ in which a new version of the network map is released.
## Object service ## Object service
Nodes under maintenance MAY fail operations of the NeoFS Object API. The node Nodes under maintenance MAY fail operations of the FrostFS Object API. The node
maintained in the current repository always denies all object operations with maintained in the current repository always denies all object operations with
dedicated status `NODE_UNDER_MAINTENANCE`. dedicated status `NODE_UNDER_MAINTENANCE`.

6
docs/storage-node-configuration.md
View file

@ -1,4 +1,4 @@
# NeoFS Storage node configuration file # FrostFS Storage node configuration file
This section contains detailed FrostFS Storage node configuration file description This section contains detailed FrostFS Storage node configuration file description
including default config values and some tips to set up configurable values. including default config values and some tips to set up configurable values.
@ -18,9 +18,9 @@ There are some custom types used for brevity:
| `pprof` | [PProf configuration](#pprof-section) | | `pprof` | [PProf configuration](#pprof-section) |
| `prometheus` | [Prometheus metrics configuration](#prometheus-section) | | `prometheus` | [Prometheus metrics configuration](#prometheus-section) |
| `control` | [Control service configuration](#control-section) | | `control` | [Control service configuration](#control-section) |
| `contracts` | [Override FrostFS contracts hashes](#contracts-section) | | `contracts` | [Override FrostFS contracts hashes](#contracts-section) |
| `morph` | [N3 blockchain client configuration](#morph-section) | | `morph` | [N3 blockchain client configuration](#morph-section) |
| `apiclient` | [FrostFS API client configuration](#apiclient-section) | | `apiclient` | [FrostFS API client configuration](#apiclient-section) |
| `policer` | [Policer service configuration](#policer-section) | | `policer` | [Policer service configuration](#policer-section) |
| `replicator` | [Replicator service configuration](#replicator-section) | | `replicator` | [Replicator service configuration](#replicator-section) |
| `storage` | [Storage engine configuration](#storage-section) | | `storage` | [Storage engine configuration](#storage-section) |