Issue #162: Rework configuration format
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>
2017-10-11 18:23:03 +00:00
|
|
|
// Package util is a utility package used by the allocator
|
2017-08-22 17:13:53 +00:00
|
|
|
// implementations. This package provides the SortNumeric function, which may be
|
|
|
|
// used by an allocator to sort peers by their metric values (ascending or
|
|
|
|
// descending).
|
2017-08-04 19:35:30 +00:00
|
|
|
package util
|
|
|
|
|
|
|
|
import (
|
2017-08-22 17:13:53 +00:00
|
|
|
"sort"
|
2017-08-04 19:35:30 +00:00
|
|
|
"strconv"
|
|
|
|
|
|
|
|
"github.com/ipfs/ipfs-cluster/api"
|
|
|
|
|
|
|
|
peer "github.com/libp2p/go-libp2p-peer"
|
|
|
|
)
|
|
|
|
|
2017-08-22 17:13:53 +00:00
|
|
|
// SortNumeric returns a list of peers sorted by their metric values. If reverse
|
|
|
|
// is false (true), peers will be sorted from smallest to largest (largest to
|
|
|
|
// smallest) metric
|
2019-02-27 17:04:35 +00:00
|
|
|
func SortNumeric(candidates map[peer.ID]*api.Metric, reverse bool) []peer.ID {
|
2017-10-26 11:45:33 +00:00
|
|
|
vMap := make(map[peer.ID]uint64)
|
2017-08-22 17:13:53 +00:00
|
|
|
peers := make([]peer.ID, 0, len(candidates))
|
|
|
|
for k, v := range candidates {
|
2017-08-04 19:35:30 +00:00
|
|
|
if v.Discard() {
|
|
|
|
continue
|
|
|
|
}
|
2017-10-26 11:45:33 +00:00
|
|
|
val, err := strconv.ParseUint(v.Value, 10, 64)
|
2017-08-04 19:35:30 +00:00
|
|
|
if err != nil {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
peers = append(peers, k)
|
|
|
|
vMap[k] = val
|
|
|
|
}
|
|
|
|
|
2017-08-22 17:13:53 +00:00
|
|
|
sorter := &metricSorter{
|
|
|
|
m: vMap,
|
|
|
|
peers: peers,
|
|
|
|
reverse: reverse,
|
2017-08-04 19:35:30 +00:00
|
|
|
}
|
2017-08-22 17:13:53 +00:00
|
|
|
sort.Sort(sorter)
|
|
|
|
return sorter.peers
|
|
|
|
}
|
|
|
|
|
|
|
|
// metricSorter implements the sort.Sort interface
|
|
|
|
type metricSorter struct {
|
|
|
|
peers []peer.ID
|
2017-10-26 11:45:33 +00:00
|
|
|
m map[peer.ID]uint64
|
2017-08-22 17:13:53 +00:00
|
|
|
reverse bool
|
2017-08-04 19:35:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Len returns the number of metrics
|
2017-08-22 17:13:53 +00:00
|
|
|
func (s metricSorter) Len() int {
|
|
|
|
return len(s.peers)
|
2017-08-04 19:35:30 +00:00
|
|
|
}
|
|
|
|
|
2017-08-22 17:13:53 +00:00
|
|
|
// Swap Swaps the elements in positions i and j
|
|
|
|
func (s metricSorter) Swap(i, j int) {
|
|
|
|
temp := s.peers[i]
|
|
|
|
s.peers[i] = s.peers[j]
|
|
|
|
s.peers[j] = temp
|
2017-08-04 19:35:30 +00:00
|
|
|
}
|
|
|
|
|
2017-08-22 17:13:53 +00:00
|
|
|
// Less reports if the element in position i is Less than the element in j
|
2017-08-04 19:35:30 +00:00
|
|
|
// (important to override this)
|
2017-08-22 17:13:53 +00:00
|
|
|
func (s metricSorter) Less(i, j int) bool {
|
|
|
|
peeri := s.peers[i]
|
|
|
|
peerj := s.peers[j]
|
2017-08-04 19:35:30 +00:00
|
|
|
|
2017-08-22 17:13:53 +00:00
|
|
|
x := s.m[peeri]
|
|
|
|
y := s.m[peerj]
|
2017-08-04 19:35:30 +00:00
|
|
|
|
2017-08-22 17:13:53 +00:00
|
|
|
if s.reverse {
|
2017-08-04 19:35:30 +00:00
|
|
|
return x > y
|
|
|
|
}
|
|
|
|
return x < y
|
|
|
|
}
|