nspcc-dev / nspcc-dev/neofs-node

IR: Revise config and make it more convenient for administration

Open
#2,423 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

config enhancement I2 neofs-ir S4 U3
Dominant language
Go
Stars
38
Forks
51
Avg merge
1d 20h
Merged PRs (30d)
38

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with config/example/ir.yaml and the neofs-ir configuration entry points, then compare the settings with the referenced Ansible role defaults. Identify which values are required, which can have defaults, and which should be static, while expanding comments to explain optional settings. Done means the sample config clearly guides administrators through the required and optional values.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devops, distributed-systems
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.