openstack
/
nova
Code Issues Proposed changes

Fix wrong method name in doc filter_scheduler 

Replace 'weight_object' with '_weight_object' in doc
and add more details about how to implement subclass
of weights.BaseHostWeigher.

Change-Id: Ia15c04fdd07dbb19c08051b721eb822a244f8986
This commit is contained in:
ChangBo Guo(gcb) 2015-09-30 13:56:17 +08:00
parent 415b221e33
commit 2b2b9569dd
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/filter_scheduler.rst
View File

@ -354,11 +354,12 @@ easily. Therefore the final weight for the object will be::
weight = w1_multiplier * norm(w1) + w2_multiplier * norm(w2) + ...
A weigher should be a subclass of ``weights.BaseHostWeigher`` and they must
implement the ``weight_multiplier`` and ``weight_objects`` methods. If the
``weight_objects`` method is overridden it just return a list of weights, and not
modify the weight of the object directly, since final weights are normalized and
computed by ``weight.BaseWeightHandler``.
A weigher should be a subclass of ``weights.BaseHostWeigher`` and they can implement
both the ``weight_multiplier`` and ``_weight_object`` methods or just implement the
``weight_objects`` method. ``weight_objects`` method is overridden only if you need
access to all objects in order to calculate weights, and it just return a list of weights,
and not modify the weight of the object directly, since final weights are normalized
and computed by ``weight.BaseWeightHandler``.
The Filter Scheduler weighs hosts based on the config option
`scheduler_weight_classes`, this defaults to