Skip to content

Latest commit

 

History

History
387 lines (314 loc) · 26 KB

storage-node-configuration.md

File metadata and controls

387 lines (314 loc) · 26 KB
Raw

NeoFS Storage node configuration file

This section contains detailed NeoFS Storage node configuration file description including default config values and some tips to set up configurable values.

There are some custom types used for brevity:

  1. duration -- string consisting of a number and a suffix. Suffix examples include s (seconds), m (minutes), ms (milliseconds).
  2. size -- string consisting of a number and a suffix. Suffix examples include b (bytes, default), k (kibibytes), m (mebibytes), g (gibibytes).
  3. file mode -- octal number. Usually, it starts with 0 and contain 3 digits, corresponding to file access permissions for user, group and others.
  4. public key -- hex-encoded public key
  5. hash160 -- hex-encoded 20-byte hash of a deployed contract.

Structure

Section Description
logger Logging parameters
pprof PProf configuration
prometheus Prometheus metrics configuration
control Control service configuration
contracts Override NeoFS contracts hashes
morph N3 blockchain client configuration
apiclient NeoFS API client configuration
policer Policer service configuration
replicator Replicator service configuration
storage Storage engine configuration

control section

control:
  authorized_keys:
    - 035839e45d472a3b7769a2a1bd7d54c4ccd4943c3b40f547870e83a8fcbfb3ce11
    - 028f42cfcb74499d7b15b35d9bff260a1c8d27de4f446a627406a382d8961486d6
  grpc:
    endpoint: 127.0.0.1:8090
Parameter Type Default value Description
authorized_keys []public key empty List of public keys which are used to authorize requests to the control service.
grpc.endpoint string empty Address that control service listener binds to.
grpc.conn_limit int 0 Number of accepted connections at a time, non-positive values keep connections unlimited. Connections that exceed limitation are accepted but not handled until some connection is closed.

grpc section

grpc:
  - endpoint: localhost:8080
    tls:
      enabled: true 
      certificate: /path/to/cert.pem 
      key: /path/to/key.pem
  - endpoint: internal.ip:8080
  - endpoint: external.ip:8080
    tls:
      enabled: true

Contains an array of gRPC endpoint configurations. The following table describes the format of each element.

Parameter Type Default value Description
endpoint []string empty Address that service listener binds to.
tls TLS config Address that control service listener binds to.

tls subsection

Parameter Type Default value Description
enabled bool false Address that control service listener binds to.
certificate string Path to the TLS certificate.
key string Path to the key.

pprof section

Contains configuration for the pprof profiler.

Parameter Type Default value Description
enabled bool false Flag to enable the service.
address string Address that service listener binds to.
shutdown_timeout duration 30s Time to wait for a graceful shutdown.

prometheus section

Contains configuration for the prometheus metrics service.

Parameter Type Default value Description
enabled bool false Flag to enable the service.
address string Address that service listener binds to.
shutdown_timeout duration 30s Time to wait for a graceful shutdown.

logger section

Contains logger parameters.

logger:
  level: info
Parameter Type Default value Description
level string info Logging level.
Possible values: debug, info, warn, error, dpanic, panic, fatal

contracts section

Contains override values for NeoFS side-chain contract hashes. Most of the time contract hashes are fetched from the NNS contract, so this section can be omitted.

contracts:
  balance: 5263abba1abedbf79bb57f3e40b50b4425d2d6cd
  container: 5d084790d7aa36cea7b53fe897380dab11d2cd3c
  netmap: 0cce9e948dca43a6b592efe59ddb4ecb89bdd9ca
  reputation: 441995f631c1da2b133462b71859494a5cd45e90
  proxy: ad7c6b55b737b696e5c82c85445040964a03e97f
Parameter Type Default value Description
audit hash160 Audit contract hash.
balance hash160 Balance contract hash.
container hash160 Container contract hash.
netmap hash160 Netmap contract hash.
reputation hash160 Reputation contract hash.

morph section

morph:
  dial_timeout: 30s
  cache_ttl: 15s
  endpoints:
    - wss://rpc1.morph.fs.neo.org:40341/ws
    - wss://rpc2.morph.fs.neo.org:40341/ws
Parameter Type Default value Description
dial_timeout duration 5s Timeout for dialing connections to N3 RPCs.
cache_ttl duration Morph block time Sidechain cache TTL value (min interval between similar calls).
Negative value disables caching.
Cached entities: containers, container lists, eACL tables.
endpoints []string Ordered array of webSocket N3 endpoint. Only one is connected at a time, the others are for a fallback if any network error appears.
reconnections_number int 5 Number of reconnection attempts (through the full list provided via endpoints) before RPC connection is considered lost. Non-positive values make no retries.
reconnections_delay duration 5s Time interval between attempts to reconnect an RPC node from endpoints if the connection has been lost.

storage section

Local storage engine configuration.

Parameter Type Default value Description
shard_pool_size int 20 Pool size for shard workers. Limits the amount of concurrent PUT operations on each shard.
shard_ro_error_threshold int 0 Maximum amount of storage errors to encounter before shard automatically moves to Degraded or ReadOnly mode.
shard Shard config Configuration for separate shards.

shard subsection

Contains configuration for each shard. Keys must be consecutive numbers starting from zero. default subsection has the same format and specifies defaults for missing values. The following table describes configuration for each shard.

Parameter Type Default value Description
compress bool false Flag to enable compression.
compression_exclude_content_types []string List of content-types to disable compression for. Content-type is taken from Content-Type object attribute. Each element can contain a star * as a first (last) character, which matches any prefix (suffix).
mode string read-write Shard Mode.
Possible values: read-write, read-only, degraded, degraded-read-only, disabled
resync_metabase bool false Flag to enable metabase resync on start.
writecache Writecache config Write-cache configuration.
metabase Metabase config Metabase configuration.
blobstor Blobstor config Blobstor configuration.
small_object_size size 1M Maximum size of an object stored in peapod.
gc GC config GC configuration.

blobstor subsection

Contains a list of substorages each with it's own type. Currently only 2 types are supported: fstree and peapod.

blobstor:
  - type: peapod
    path: /path/to/peapod.db
    depth: 1
    width: 4
  - type: fstree
    path: /path/to/blobstor
    perm: 0644
    size: 4194304
    depth: 1
    width: 4
    opened_cache_capacity: 50

Common options for sub-storages

Parameter Type Default value Description
path string Path to the root of the blobstor.
perm file mode 0640 Default permission for created files and directories.

fstree type options

Parameter Type Default value Description
path string Path to the root of the blobstor.
perm file mode 0640 Default permission for created files and directories.
depth int 4 File-system tree depth.

peapod type options

Parameter Type Default value Description
path string Path to the Peapod database file.
perm file mode 0640 Default permission for created files and directories.
flush_interval duration 10ms Time interval between batch writes to disk.

gc subsection

Contains garbage-collection service configuration. It iterates over the blobstor and removes object the node no longer needs.

gc:
  remover_batch_size: 200
  remover_sleep_interval: 5m
Parameter Type Default value Description
remover_batch_size int 100 Amount of objects to grab in a single batch.
remover_sleep_interval duration 1m Time to sleep between iterations.

metabase subsection

metabase:
  path: /path/to/meta.db
  perm: 0644
  max_batch_size: 200
  max_batch_delay: 20ms
Parameter Type Default value Description
path string Path to the metabase file.
perm file mode 0640 Permissions to set for the database file.
max_batch_size int 1000 Maximum amount of write operations to perform in a single transaction.
max_batch_delay duration 10ms Maximum delay before a batch starts.

writecache subsection

writecache:
  enabled: true
  path: /path/to/writecache
  capacity: 4294967296
  small_object_size: 16384
  max_object_size: 134217728
  workers_number: 30
Parameter Type Default value Description
path string Path to the metabase file.
capacity size unrestricted Approximate maximum size of the writecache. If the writecache is full, objects are written to the blobstor directly.
small_object_size size 32K Maximum object size for "small" objects. This objects are stored in a key-value database instead of a file-system.
max_object_size size 64M Maximum object size allowed to be stored in the writecache.
workers_number int 20 Amount of background workers that move data from the writecache to the blobstor.
max_batch_size int 1000 Maximum amount of small object PUT operations to perform in a single transaction.
max_batch_delay duration 10ms Maximum delay before a batch starts.

node section

node:
  wallet:
    path: /path/to/wallet.json
    address: NcpJzXcSDrh5CCizf4K9Ro6w4t59J5LKzz
    password: password
  addresses:
    - grpc://external.ip:8082
  attribute:
    - "Price:11"
    - "UN-LOCODE:RU MSK"
    - "key:value"
  relay: false
  persistent_sessions:
    path: /sessions
  persistent_state:
    path: /state
Parameter Type Default value Description
key string Path to the binary-encoded private key.
wallet Wallet config Wallet configuration. Has no effect if key is provided.
addresses []string Addresses advertised in the netmap.
attribute []string Node attributes as a list of key-value pairs in <key>:<value> format. See also docs about verified nodes' domains.
relay bool Enable relay mode.
persistent_sessions Persistent sessions config Persistent session token store configuration.
persistent_state Persistent state config Persistent state configuration.

wallet subsection

N3 wallet configuration.

Parameter Type Default value Description
path string Path to the wallet file.
address string Wallet address to use.
password string Password to open the wallet.

persistent_sessions subsection

Contains persistent session token store configuration. By default sessions do not persist between restarts.

Parameter Type Default value Description
path string Path to the database.

persistent_state subsection

Configures persistent storage for auxiliary information, such as last seen block height. It is used to correctly handle node restarts or crashes.

Parameter Type Default value Description
path string .neofs-storage-state Path to the database.

apiclient section

Configuration for the NeoFS API client used for communication with other NeoFS nodes.

apiclient:
  dial_timeout: 15s
  stream_timeout: 20s
  reconnect_timeout: 30s
Parameter Type Default value Description
dial_timeout duration 5s Timeout for dialing connections to other storage or inner ring nodes.
stream_timeout duration 15s Timeout for individual operations in a streaming RPC.
reconnect_timeout duration 30s Time to wait before reconnecting to a failed node.

policer section

Configuration for the Policer service. It ensures that object is stored according to the intended policy.

policer:
  head_timeout: 15s
  replication_cooldown: 100ms
  object_batch_size: 10
  max_workers: 20
Parameter Type Default value Description
head_timeout duration 5s Timeout for performing the HEAD operation.
replication_cooldown duration 1s Cooldown time between replication tasks submitting.
object_batch_size int 10 Replication's objects batch size.
max_workers int 20 Replication's worker pool's maximum size.

replicator section

Configuration for the Replicator service.

replicator:
  put_timeout: 15s
  pool_size: 10
Parameter Type Default value Description
put_timeout duration 1m Timeout for performing the PUT operation.
pool_size int Equal to object.put.pool_size_remote Maximum amount of concurrent replications.

object section

Contains object-service related parameters.

object:
  put:
    pool_size_remote: 100
Parameter Type Default value Description
delete.tombstone_lifetime int 5 Tombstone lifetime for removed objects in epochs.
put.pool_size_remote int 10 Max pool size for performing remote PUT operations. Used by Policer and Replicator services.