IR: Revise config and make it more convenient for administration #1054

New issue

Open

opened 2025-12-28 17:21:37 +00:00 by sami · 0 comments

sami commented

2025-12-28 17:21:37 +00:00

Owner

Originally created by @cthulhu-rider on GitHub (Jul 6, 2023).

partially inspired by @532910 administration experience

we have neofs-ir app with its sample config file

within this i propose to make several config improvements

Defaults

define values that must always be set (usually these are network endpoints, keys, etc.). If a value can be set to default, which is applicable in most practical cases, then make the configuration optional.

it is also proposed to select the values from the configuration of which we want to free the administrator and make it static in the application (if any)

Sample config

describe the comments in the sample config in as much detail as possible for administrators to understand. For example, we can take consensus section

during the normal configuration process, the administrator only needs to explicitly set the required values. Optional values should be clear on the questions why?", for what? and what value?

Refs

see configuration for Ansible NeoFS IR role and in particular this section

Originally created by @cthulhu-rider on GitHub (Jul 6, 2023). _partially inspired by @532910 administration experience_ we have `neofs-ir` app with its [sample](https://github.com/nspcc-dev/neofs-node/blob/master/config/example/ir.yaml) config file within this i propose to make several config improvements ## Defaults define values that must always be set (usually these are network endpoints, keys, etc.). If a value can be set to default, which is applicable in most practical cases, then make the configuration optional. it is also proposed to select the values from the configuration of which we want to free the administrator and make it static in the application (if any) ## Sample config describe the comments in the sample config in as much detail as possible for administrators to understand. For example, we can take `consensus` section during the normal configuration process, the administrator only needs to explicitly set the required values. Optional values should be clear on the questions `why?"`, `for what?` and `what value?` ## Refs see configuration for Ansible NeoFS IR [role](https://github.com/nspcc-dev/ansible-neofs-ir/blob/cd705ab7bd2bd7d308273bf7fe764266c6c2f50a/defaults/main.yml) and in particular [this](https://github.com/nspcc-dev/ansible-neofs-ir/blob/cd705ab7bd2bd7d308273bf7fe764266c6c2f50a/defaults/main.yml#L131-L149) section