frostfs-node/config/example
Dmitrii Stepanov 68029d756e
All checks were successful
DCO action / DCO (pull_request) Successful in 1m57s
Vulncheck / Vulncheck (pull_request) Successful in 2m6s
Tests and linters / Run gofumpt (pull_request) Successful in 2m9s
Build / Build Components (1.22) (pull_request) Successful in 2m37s
Pre-commit hooks / Pre-commit (pull_request) Successful in 2m49s
Tests and linters / Tests (1.21) (pull_request) Successful in 3m1s
Tests and linters / Tests (1.22) (pull_request) Successful in 3m4s
Tests and linters / Staticcheck (pull_request) Successful in 3m0s
Tests and linters / Tests with -race (pull_request) Successful in 3m9s
Tests and linters / Lint (pull_request) Successful in 3m30s
Tests and linters / gopls check (pull_request) Successful in 3m40s
Build / Build Components (1.21) (pull_request) Successful in 1m12s
[#1302] writecache: Allow to specify custom page size
Signed-off-by: Dmitrii Stepanov <d.stepanov@yadro.com>
2024-08-09 12:12:07 +03:00
..
cli.yaml Move to frostfs-node 2022-12-28 15:04:29 +03:00
ir-control.yaml Move to frostfs-node 2022-12-28 15:04:29 +03:00
ir.env [#338] ir: Drop named named put fee 2023-05-24 08:44:47 +00:00
ir.yaml [#552] Add systemd notifications to ir service 2023-12-13 17:51:41 +03:00
node-control.yaml Move to frostfs-node 2022-12-28 15:04:29 +03:00
node.env [#1302] writecache: Allow to specify custom page size 2024-08-09 12:12:07 +03:00
node.json [#1302] writecache: Allow to specify custom page size 2024-08-09 12:12:07 +03:00
node.yaml [#1302] writecache: Allow to specify custom page size 2024-08-09 12:12:07 +03:00
README.md [#83] pre-commit: Add initial configuration 2023-03-13 07:07:29 +00:00

Examples of correct configuration file structures

Here are files in all supported formats and with all possible configuration values of FrostFS applications. See node.yaml for configuration notes.

All parameters are correct, however, they are for informational purposes only. It is not recommended transferring these configs for real application launches.

Config files

  • Storage node
    • JSON: node.json
    • YAML: node.yaml
  • Inner ring
    • YAML: ir.yaml
  • CLI
    • YAML: cli.yaml

Multiple configs

You can split your configuration to several files. For example, you can use separate yaml file for each shard or each service (pprof, prometheus). You must use --config-dir flag to process several configs:

$ ./bin/frotsfs-node --config ./config/example/node.yaml --config-dir ./dir/with/additional/configs

When the --config-dir flag set, the application:

  • reads all *.y[a]ml files from provided directory,
  • use Viper's MergeConfig functionality to produce the final configuration,
  • files are being processing in alphanumerical order so that 01.yaml may be extended with contents of 02.yaml, so if a field is specified in multiple files, the latest occurrence takes effect.

So if we have the following files:

# 00.yaml
logger:
  level: debug
pprof:
  enabled: true
  address: localhost:6060
prometheus:
  enabled: true
  address: localhost:9090
# dir/01.yaml
logger:
  level: info
pprof:
  enabled: false
# dir/02.yaml
logger:
  level: warn
prometheus:
  address: localhost:9091

and provide the following flags:

$ ./bin/frotsfs-node --config 00.yaml --config-dir dir

result config will be:

logger:
  level: warn
pprof:
  enabled: false
  address: localhost:6060
prometheus:
  enabled: true
  address: localhost:9091

Environment variables

  • Storage node: node.env
  • Inner ring: ir.env