8f06baa1bf
The following commit reimplements ipfs-cluster configuration under
the following premises:
* Each component is initialized with a configuration object
defined by its module
* Each component decides how the JSON representation of its
configuration looks like
* Each component parses and validates its own configuration
* Each component exposes its own defaults
* Component configurations are make the sections of a
central JSON configuration file (which replaces the current
JSON format)
* Component configurations implement a common interface
(config.ComponentConfig) with a set of common operations
* The central configuration file is managed by a
config.ConfigManager which:
* Registers ComponentConfigs
* Assigns the correspondent sections from the JSON file to each
component and delegates the parsing
* Delegates the JSON generation for each section
* Can be notified when the configuration is updated and must be
saved to disk
The new service.json would then look as follows:
```json
{
"cluster": {
"id": "QmTVW8NoRxC5wBhV7WtAYtRn7itipEESfozWN5KmXUQnk2",
"private_key": "<...>",
"secret": "00224102ae6aaf94f2606abf69a0e278251ecc1d64815b617ff19d6d2841f786",
"peers": [],
"bootstrap": [],
"leave_on_shutdown": false,
"listen_multiaddress": "/ip4/0.0.0.0/tcp/9096",
"state_sync_interval": "1m0s",
"ipfs_sync_interval": "2m10s",
"replication_factor": -1,
"monitor_ping_interval": "15s"
},
"consensus": {
"raft": {
"heartbeat_timeout": "1s",
"election_timeout": "1s",
"commit_timeout": "50ms",
"max_append_entries": 64,
"trailing_logs": 10240,
"snapshot_interval": "2m0s",
"snapshot_threshold": 8192,
"leader_lease_timeout": "500ms"
}
},
"api": {
"restapi": {
"listen_multiaddress": "/ip4/127.0.0.1/tcp/9094",
"read_timeout": "30s",
"read_header_timeout": "5s",
"write_timeout": "1m0s",
"idle_timeout": "2m0s"
}
},
"ipfs_connector": {
"ipfshttp": {
"proxy_listen_multiaddress": "/ip4/127.0.0.1/tcp/9095",
"node_multiaddress": "/ip4/127.0.0.1/tcp/5001",
"connect_swarms_delay": "7s",
"proxy_read_timeout": "10m0s",
"proxy_read_header_timeout": "5s",
"proxy_write_timeout": "10m0s",
"proxy_idle_timeout": "1m0s"
}
},
"monitor": {
"monbasic": {
"check_interval": "15s"
}
},
"informer": {
"disk": {
"metric_ttl": "30s",
"metric_type": "freespace"
},
"numpin": {
"metric_ttl": "10s"
}
}
}
```
This new format aims to be easily extensible per component. As such,
it already surfaces quite a few new options which were hardcoded
before.
Additionally, since Go API have changed, some redundant methods have been
removed and small refactoring has happened to take advantage of the new
way.
License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
83 lines
1.6 KiB
Go
83 lines
1.6 KiB
Go
package config
|
|
|
|
import (
|
|
"encoding/json"
|
|
"time"
|
|
)
|
|
|
|
// Saver implements common functionality useful for ComponentConfigs
|
|
type Saver struct {
|
|
save chan struct{}
|
|
BaseDir string
|
|
}
|
|
|
|
// NotifySave signals the SaveCh() channel in a non-blocking fashion.
|
|
func (sv *Saver) NotifySave() {
|
|
if sv.save == nil {
|
|
sv.save = make(chan struct{})
|
|
}
|
|
|
|
// Non blocking, in case no one's listening
|
|
select {
|
|
case sv.save <- struct{}{}:
|
|
default:
|
|
logger.Warning("configuration will not be saved")
|
|
}
|
|
}
|
|
|
|
// SaveCh returns a channel which is signaled when a component wants
|
|
// to persist its configuration
|
|
func (sv *Saver) SaveCh() <-chan struct{} {
|
|
if sv.save == nil {
|
|
sv.save = make(chan struct{})
|
|
}
|
|
return sv.save
|
|
}
|
|
|
|
// SetBaseDir is a setter for BaseDir and implements
|
|
// part of the ComponentConfig interface.
|
|
func (sv *Saver) SetBaseDir(dir string) {
|
|
sv.BaseDir = dir
|
|
}
|
|
|
|
// DefaultJSONMarshal produces pretty JSON with 2-space indentation
|
|
func DefaultJSONMarshal(v interface{}) ([]byte, error) {
|
|
bs, err := json.MarshalIndent(v, "", " ")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return bs, nil
|
|
}
|
|
|
|
// SetIfNotDefault dest to the value of src if src is not the default value.
|
|
// dest must be a pointer.
|
|
func SetIfNotDefault(src interface{}, dest interface{}) {
|
|
switch src.(type) {
|
|
case time.Duration:
|
|
t := src.(time.Duration)
|
|
if t != 0 {
|
|
*dest.(*time.Duration) = t
|
|
}
|
|
case string:
|
|
str := src.(string)
|
|
if str != "" {
|
|
*dest.(*string) = str
|
|
}
|
|
case uint64:
|
|
n := src.(uint64)
|
|
if n != 0 {
|
|
*dest.(*uint64) = n
|
|
}
|
|
case int:
|
|
n := src.(int)
|
|
if n != 0 {
|
|
*dest.(*int) = n
|
|
}
|
|
case bool:
|
|
b := src.(bool)
|
|
if b {
|
|
*dest.(*bool) = b
|
|
}
|
|
}
|
|
}
|