Skip to content

Commit b942907

Browse files
doc: improve run host ranking docs (#6566)
1 parent 2cf06ed commit b942907

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

cylc/flow/cfgspec/globalcfg.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,11 @@ def default_for(
843843
Conf('ranking', VDR.V_STRING, desc=f'''
844844
Rank and filter run hosts based on system information.
845845
846+
By default, when a workflow is started, Cylc will pick a host
847+
for it to run on at random from :cylc:conf:`[..]available`.
848+
If no hosts are specified in :cylc:conf:`[..]available` it
849+
will start the scheduler locally.
850+
846851
Ranking can be used to provide load balancing to ensure no
847852
single run host is overloaded. It also provides thresholds
848853
beyond which Cylc will not attempt to start new schedulers on
@@ -867,6 +872,11 @@ def default_for(
867872
# rank hosts by 15min average of server load
868873
getloadavg()[2]
869874
875+
# rank hosts by the amount of available RAM (multiply by -1
876+
# to make it choose the host with the most available memory
877+
# rather than the least)
878+
-1 * virtual_memory().available
879+
870880
# rank hosts by the number of cores
871881
# (multiple by -1 because the lowest value is chosen)
872882
-1 * cpu_count()

0 commit comments

Comments
 (0)