diff --git a/doc/config-reference/compute/section_compute-cells.xml b/doc/config-reference/compute/section_compute-cells.xml
index 5e0498a37f..d66a2e09f6 100644
--- a/doc/config-reference/compute/section_compute-cells.xml
+++ b/doc/config-reference/compute/section_compute-cells.xml
@@ -72,11 +72,9 @@
scheduler_filter_classes
- Filter classes that the cells scheduler should
- use. By default, uses
- "nova.cells.filters.all_filters"
- to map to all cells filters included with
- nova.
+ Filter classes that the cells scheduler should use. By default, uses
+ "nova.cells.filters.all_filters" to map to all
+ cells filters included with Compute.
@@ -176,32 +174,66 @@ rabbit_virtual_host=cell1_vhost
Cell scheduling configuration
- New for the Havana release, you can configure some cells with
- higher weights so that those cells are given priority for new VMs to
- be launched.
+ To determine the best cell for launching a new instance, Compute uses a set of
+ filters and weights configured in /etc/nova/nova.conf. The
+ following options are available to prioritize cells for scheduling:
+
+
+
+ scheduler_filter_classes
- Specifies the list of filter
+ classes. By default nova.cells.weights.all_filters
is
+ specified, which maps to all cells filters included with Compute (see
+ .
+
+
+ scheduler_weight_classes
- Specifies the list of weight
+ classes. By default nova.cells.weights.all_weighers
is
+ specified, which maps to all cell weight algorithms (weighers) included with
+ Compute. The following modules are available:
+
+ mute_child
: Downgrades the likelihood of child cells
+ being chosen for scheduling requests, which haven't sent capacity or
+ capability updates in a while. Options include
+ mute_weight_multiplier
(multiplier for mute
+ children; value should be negative) and
+ mute_weight_value
(assigned to mute children;
+ should be a positive value).
+
+
+ ram_by_instance_type
: Select cells with the most RAM
+ capacity for the instance type being requested. Because higher
+ weights win, Compute returns the number of available units for the
+ instance type requested. The ram_weight_multiplier
+ option defaults to 10.0 that adds to the weight by a factor of 10.
+ Use a negative number to stack VMs on one host instead of spreading
+ out new VMs to more hosts in the cell.
+
+ weight_offset
: Allows modifying the database to weight a particular cell. You can
+ use this when you want to disable a cell (for example, '0'), or to
+ set a default cell by making its weight_offset very high (for
+ example, '999999999999999'). The highest weight will be the first
+ cell to be scheduled for launching an instance.
+
+
+
+ Additionally, the following options are available for the cell scheduler:
+
+
+
+ scheduler_retries
- Specifies how many times the scheduler
+ will try to launch a new instance when no cells are available (default=10).
+
+
+ scheduler_retry_delay
- Specifies the delay (in seconds)
+ between retries (default=2).
+
+
+
As an admin user, you can also add a filter that directs builds to
a particular cell. The policy.json file must
have a line with "cells_scheduler_filter:TargetCellFilter"
: "is_admin:True" to let an admin user specify a
scheduler hint to direct a build to a particular cell.
- There are two modules available by default in the
- nova.conf file so that cell selection is no
- longer random. These are selected with the default
- nova.conf file which has
- scheduler_weight_classes=nova.cells.weights.all_weighers
- as the default.
- ram_by_instance_type: Select cells with the most RAM capacity for the
- instance type being requested. Since higher weights win,
- Compute returns the number of available units for the
- instance type requested. In nova.conf there's a
- ram_weight_multiplier defaulted to 10.0 that adds to the
- weight by a factor of 10.
- weight_offset: Allows modifying the database to weight a particular cell.
- You can use this when you want to disable a cell. Originally
- designed so you can set a default cell by making its
- weight_offset very high, like 999999999999999. The highest
- weight will be first cell scheduled for launching
- VMs.
Optional cell configuration