Skip to content

Commit 53ab704

Browse files
committed
docs: add defaults to NeoFS BlockFetcher configuration
Follow #3742. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
1 parent 3f651cd commit 53ab704

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/node-configuration.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -185,27 +185,28 @@ where:
185185
- `UnlockWallet` contains wallet settings to retrieve account to sign requests to
186186
NeoFS. Without this setting, the module will use randomly generated private key.
187187
For configuration details see [Unlock Wallet Configuration](#Unlock-Wallet-Configuration)
188-
- `Addresses` is a list of NeoFS storage nodes addresses.
189-
- `Timeout` is a timeout for a single request to NeoFS storage node.
190-
- `ContainerID` is a container ID to fetch blocks from.
188+
- `Addresses` is a list of NeoFS storage nodes addresses. This parameter is required.
189+
- `Timeout` is a timeout for a single request to NeoFS storage node (10 minutes by
190+
default).
191+
- `ContainerID` is a container ID to fetch blocks from. This parameter is required.
191192
- `BlockAttribute` is an attribute name of NeoFS object that contains block
192-
data.
193+
data. It's set to `Block` by default.
193194
- `IndexFileAttribute` is an attribute name of NeoFS index object that contains block
194-
object IDs.
195+
object IDs. It's set to `Index` by default.
195196
- `DownloaderWorkersCount` is a number of workers that download blocks from
196-
NeoFS in parallel.
197+
NeoFS in parallel (500 by default).
197198
- `OIDBatchSize` is the number of blocks to search per a single request to NeoFS
198199
in case of disabled index files search. Also, for both modes of BlockFetcher
199200
operation this setting manages the buffer size of OIDs and blocks transferring
200-
channels.
201+
channels. By default, it's set to a half of `BQueueSize` parameter.
201202
- `BQueueSize` is a size of the block queue used to manage consecutive blocks
202203
addition to the chain. It must be larger than `OIDBatchSize` and highly recommended
203-
to be `2*OIDBatchSize` or `3*OIDBatchSize`.
204+
to be `2*OIDBatchSize` or `3*OIDBatchSize`. By default, it's set to 16000.
204205
- `SkipIndexFilesSearch` is a flag that allows to skip index files search and search
205206
for blocks directly. It is set to `false` by default.
206207
- `IndexFileSize` is the number of OID objects stored in the index files. This
207208
setting depends on the NeoFS block storage configuration and is applicable only if
208-
`SkipIndexFilesSearch` is set to `false`.
209+
`SkipIndexFilesSearch` is set to `false`. It's set to 128000 by default.
209210

210211
### Metrics Services Configuration
211212

0 commit comments

Comments
 (0)