nervosnetwork/ckb

Config Generator Based On Hardware Resources

Open

#3,514 opened on Jul 27, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (1,210 stars) (260 forks)user submission
good first issuepinnedstalet:enhancement

Description

Feature Request

Is your feature request related to a problem? Please describe.

The default generated CKB config does not tune the options depend on the detected hardware resources. Instead the options are best suited for the recommended hardware specification: 4 CPU cores, 8G memory, and enough SSD disk space. This means CKB does not utilize all the resources when running on a more powerful machine.

Describe the solution you'd like

Although uses can tweak the config options, it's hard for most users to understand those options. It's also tedious to calculate and update a bunch of options. A facade can help where users provide simple hints about how many resources CKB can use and a config generator will generate the config file for the node.

The config generator have two interfaces:

  • Interface for end user: which options the end user should provide, for example, number of cores, available memory, disk space, and network bandwidth.
  • Interface for CKB. Which options should the generator change based on end user options?
    • db-options file for rocksdb
    • Memory limit for various caches in ckb.toml
    • Thread pool size, which is not configurable but based on detected cores now.

Contributor guide

Tech stack
rust
Domain
backendperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingCKB architectureRocksDB basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the current CKB configuration files (ckb.toml) and how RocksDB options are set. Understand the threading model and memory caches. Look at existing config generation in the codebase (e.g., in ckb/tx pool or ckb/db). Then design the user interface and the mapping to internal config options. The issue has two interfaces to define.
Config Generator Based On Hardware Resources · nervosnetwork/ckb#3514 | Good First Issue