docs: sync missing plugin documentation from volcano core repository#502
docs: sync missing plugin documentation from volcano core repository#502hemantch01 wants to merge 1 commit into
Conversation
Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for several Volcano scheduler plugins, including DeviceShare, HCCLRank, Overcommit, Pod Disruption Budget (PDB), Rescheduling, ResourceQuota, and Usage-based scheduling. The feedback identifies necessary corrections in the Usage-based scheduling guide, specifically regarding the correct nesting of the 'enablePredicate' parameter within the 'arguments' block, the use of 'memory' instead of 'mem' for threshold keys to maintain consistency, and the correction of the metrics type string for the Prometheus Adaptor.
| - name: usage # usage based scheduling plugin | ||
| enablePredicate: false # If false, new pod scheduling is not disabled when node load reaches the threshold. If true or empty, new pod scheduling is disabled. | ||
| arguments: | ||
| usage.weight: 5 | ||
| cpu.weight: 1 | ||
| memory.weight: 1 | ||
| thresholds: | ||
| cpu: 80 # The node cannot schedule new pods if its actual CPU load reaches 80%. | ||
| mem: 70 # The node cannot schedule new pods if its actual Memory load reaches 70%. |
There was a problem hiding this comment.
The enablePredicate configuration should be placed within the arguments block of the plugin configuration to be correctly parsed by the Volcano scheduler. Additionally, the threshold key for memory is typically memory rather than mem to maintain consistency with other resource naming conventions in Volcano.
| - name: usage # usage based scheduling plugin | |
| enablePredicate: false # If false, new pod scheduling is not disabled when node load reaches the threshold. If true or empty, new pod scheduling is disabled. | |
| arguments: | |
| usage.weight: 5 | |
| cpu.weight: 1 | |
| memory.weight: 1 | |
| thresholds: | |
| cpu: 80 # The node cannot schedule new pods if its actual CPU load reaches 80%. | |
| mem: 70 # The node cannot schedule new pods if its actual Memory load reaches 70%. | |
| - name: usage # usage based scheduling plugin | |
| arguments: | |
| enablePredicate: false # If false, new pod scheduling is not disabled when node load reaches the threshold. If true or empty, new pod scheduling is disabled. | |
| usage.weight: 5 | |
| cpu.weight: 1 | |
| memory.weight: 1 | |
| thresholds: | |
| cpu: 80 # The node cannot schedule new pods if its actual CPU load reaches 80%. | |
| memory: 70 # The node cannot schedule new pods if its actual Memory load reaches 70%. |
| metricsQuery: avg_over_time(((1-node_memory_MemAvailable_bytes/<<.Series>>))[10m:30s]) | ||
| ``` | ||
|
|
||
| Set the metrics `type` in the scheduler configmap to `prometheus_adaptor`. |
There was a problem hiding this comment.
The metrics type for the Prometheus Adaptor in Volcano is prometheus_adapt, not prometheus_adaptor. This matches the description provided in the configuration section on line 61.
| Set the metrics `type` in the scheduler configmap to `prometheus_adaptor`. | |
| Set the metrics `type` in the scheduler configmap to `prometheus_adapt`. |
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
/kind documentation
What this PR does / why we need it:
This PR synchronizes the website documentation with the current features available in the main
volcano-sh/volcanorepository. Currently, several active plugins in the core codebase lack proper user guides, creating a gap for users attempting to discover or configure these features.This update introduces detailed documentation for differnt plugins:
usage,rescheduling,resourcequota,pdb,overcommit, anddeviceshare.hcclrank.Each guide includes:
Fixes [Docs] Sync missing plugin documentation from Volcano main repository #501