Add disk free space cluster settings (#7799)

* Add disk free space cluster settings Signed-off-by: zane-neo <[email protected]> * Add value range to disk free space setting Signed-off-by: zane-neo <[email protected]> * Update _ml-commons-plugin/cluster-settings.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: zane-neo <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Jul 25, 2024 · beb3bc2 · beb3bc2
1 parent 279237d
commit beb3bc2
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/_ml-commons-plugin/cluster-settings.md b/_ml-commons-plugin/cluster-settings.md
@@ -256,6 +256,23 @@ plugins.ml_commons.jvm_heap_memory_threshold: 85
 - Default value: 85
 - Value range: [0, 100]
 
+## Set a disk free space threshold
+
+Sets a disk circuit breaker that checks disk usage before running an ML task. If the amount of disk free space exceeds the threshold, then OpenSearch triggers a circuit breaker and throws an exception to maintain optimal performance.
+
+Valid values are in byte units. To disable the circuit breaker, set this value to -1.
+
+### Setting
+
+```
+plugins.ml_commons.disk_free_space_threshold: 5G
+```
+
+### Values
+
+- Default value: 5G
+- Value range: [-1, Long.MAX_VALUE]
+
 ## Exclude node names
 
 Use this setting to specify the names of nodes on which you don't want to run ML tasks. The value should be a valid node name or a comma-separated node name list.