docs: mark Swarm.ResourceMgr as experimental
Marcin Rataj committed
Jun 12, 2022 at 21:08 UTC
88d88158c61dc657b2c9d83107ec02d0d6040cef
1 file changed
+9
-1
docs/config.md
+9
-1
@@ -1630,10 +1630,16 @@ Type: `duration`
1630
1631
### `Swarm.ResourceMgr`
1632
1633
+**EXPERIMENTAL: `Swarm.ResourceMgr` configuration will change in future release**
1634
+
1635
The [libp2p Network Resource Manager](https://github.com/libp2p/go-libp2p-resource-manager#readme) allows setting limits per a scope,
1636
and tracking recource usage over time.
1637
1638
#### `Swarm.ResourceMgr.Enabled`
1639
+
1640
+**EXPERIMENTAL: `Swarm.ResourceMgr` is in active development, enable it only if you want to provide maintainers with feedback**
1641
+
1642
+
1643
Enables the libp2p Network Resource Manager and auguments the default limits
1644
using user-defined ones in `Swarm.ResourceMgr.Limits` (if present).
1645
@@ -1643,12 +1649,14 @@ Type: `flag`
1649
1650
#### `Swarm.ResourceMgr.Limits`
1651
1652
+**EXPERIMENTAL: `Swarm.ResourceMgr.Limits` configuration will change in future release, exposed here only for convenience**
1653
+
1654
Map of resource limits [per scope](https://github.com/libp2p/go-libp2p-resource-manager#resource-scopes).
1655
1656
The map supports fields from [`BasicLimiterConfig`](https://github.com/libp2p/go-libp2p-resource-manager/blob/v0.3.0/limit_config.go#L165-L185)
1657
struct from [go-libp2p-resource-manager](https://github.com/libp2p/go-libp2p-resource-manager#readme).
1658
1651
-Example:
1659
+**Example: (format may change in future release)**
1660
1661
```json
1662
{