Skip to content

Commit 5894eab

Browse files
committed
Add note on memory usage for volume-metrics-opt-in in README
1 parent 8eb8b1a commit 5894eab

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,12 @@ After deploying the driver, you can continue to these sections:
325325
| vol-metrics-refresh-period | | 240 | true | Refresh period for volume metrics in minutes. |
326326
| vol-metrics-fs-rate-limit | | 5 | true | Volume metrics routines rate limiter per file system. |
327327

328+
329+
330+
##### Understanding the Impact of vol-metrics-opt-in:
331+
Enabling the vol-metrics-opt-in parameter activates the gathering of inode and disk usage data. This functionality, particularly in scenarios with larger file systems, may result in an uptick in memory usage due to the detailed aggregation of file system information. We advise users with large-scale file systems to consider this aspect when utilizing this feature.
332+
333+
328334
### Container Arguments for deployment(controller)
329335
| Parameters | Values | Default | Optional | Description |
330336
|-----------------------------|--------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

0 commit comments

Comments
 (0)