coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 10:27:46 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: mark Swarm.ResourceMgr as experimental

Browse Source
This commit is contained in:
Marcin Rataj 2022-06-12 21:08:53 +02:00 committed by Adin Schmahmann
parent c4522199bd
commit 88d88158c6
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/config.md
View File

@ -1630,10 +1630,16 @@ Type: `duration`
### `Swarm.ResourceMgr` ### `Swarm.ResourceMgr`
**EXPERIMENTAL: `Swarm.ResourceMgr` configuration will change in future release**
The [libp2p Network Resource Manager](https://github.com/libp2p/go-libp2p-resource-manager#readme) allows setting limits per a scope, The [libp2p Network Resource Manager](https://github.com/libp2p/go-libp2p-resource-manager#readme) allows setting limits per a scope,
and tracking recource usage over time. and tracking recource usage over time.
#### `Swarm.ResourceMgr.Enabled` #### `Swarm.ResourceMgr.Enabled`
**EXPERIMENTAL: `Swarm.ResourceMgr` is in active development, enable it only if you want to provide maintainers with feedback**
Enables the libp2p Network Resource Manager and auguments the default limits Enables the libp2p Network Resource Manager and auguments the default limits
using user-defined ones in `Swarm.ResourceMgr.Limits` (if present). using user-defined ones in `Swarm.ResourceMgr.Limits` (if present).
@ -1643,12 +1649,14 @@ Type: `flag`
#### `Swarm.ResourceMgr.Limits` #### `Swarm.ResourceMgr.Limits`
**EXPERIMENTAL: `Swarm.ResourceMgr.Limits` configuration will change in future release, exposed here only for convenience**
Map of resource limits [per scope](https://github.com/libp2p/go-libp2p-resource-manager#resource-scopes). Map of resource limits [per scope](https://github.com/libp2p/go-libp2p-resource-manager#resource-scopes).
The map supports fields from [`BasicLimiterConfig`](https://github.com/libp2p/go-libp2p-resource-manager/blob/v0.3.0/limit_config.go#L165-L185) The map supports fields from [`BasicLimiterConfig`](https://github.com/libp2p/go-libp2p-resource-manager/blob/v0.3.0/limit_config.go#L165-L185)
struct from [go-libp2p-resource-manager](https://github.com/libp2p/go-libp2p-resource-manager#readme). struct from [go-libp2p-resource-manager](https://github.com/libp2p/go-libp2p-resource-manager#readme).
Example: **Example: (format may change in future release)**
```json ```json
{ {