From d582009deae8d3365b49494b03500460bad08744 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Wed, 2 Apr 2014 21:41:54 +0200 Subject: [PATCH] Document the new style instance group filters Document the ServerGroupAffinityFilter and ServerGroupAntiAffinityFilter filters. Add a note about the deprecated GroupAffinityFilter and GroupAntiAffinityFilter filters. Also indicate that those filters can't work together. Update some markup. Add notes about the role of the scheduler during migration and evacuation. Change-Id: Ibc7989baa336eed698704ca2de38e04f027269b0 Closes-Bug: #1298980 Closes-Bug: #1299066 --- .../compute/section_compute-scheduler.xml | 59 +++++++++++++++++-- 1 file changed, 53 insertions(+), 6 deletions(-) diff --git a/doc/config-reference/compute/section_compute-scheduler.xml b/doc/config-reference/compute/section_compute-scheduler.xml index ef065248b7..8447f29aad 100644 --- a/doc/config-reference/compute/section_compute-scheduler.xml +++ b/doc/config-reference/compute/section_compute-scheduler.xml @@ -79,6 +79,14 @@ scheduler_default_filters=RetryFilter,AvailabilityZoneFilter,RamFilter,ComputeFi xlink:href="http://docs.openstack.org/admin-guide-cloud/content/managing-volumes.html"> OpenStack Cloud Administrator Guide for information. + The choice of a new host on instance migration is done by the + scheduler. + When evacuating instances from a host, the scheduler service does not + pick the next host. Instances are evacuated to the host explicitly + defined by the administrator. For information about instance evacuation, + refer to the Evacuate + instances section of the Cloud Administrator Guide.
Filter scheduler The Filter Scheduler @@ -110,13 +118,13 @@ scheduler_default_filters=RetryFilter,AvailabilityZoneFilter,RamFilter,ComputeFi - The scheduler_available_filters + The configuration option in nova.conf provides the Compute service with the list of the filters that are used by the scheduler. The default setting specifies all of the filter that are included with the Compute service: - scheduler_available_filters=nova.scheduler.filters.all_filters + scheduler_available_filters = nova.scheduler.filters.all_filters This configuration option can be specified multiple times. For example, if you implemented your own custom filter in Python called @@ -323,6 +331,9 @@ aggregate_image_properties_isolation_separator=.
GroupAffinityFilter + This filter is deprecated in favor of ServerGroupAffinityFilter. + The GroupAffinityFilter ensures that an instance is scheduled on to a host from a set of group hosts. To take advantage of this filter, the requester must pass @@ -331,11 +342,17 @@ aggregate_image_properties_isolation_separator=. nova command-line tool, use the --hint flag. For example: - $ nova boot --image cedef40a-ed67-4d10-800e-17455edce175 --flavor 1 \ - --hint group=foo server-1 + $ nova boot --image IMAGE_ID --flavor 1 --hint group=foo server-1 + This filter should not be enabled at the same time as GroupAntiAffinityFilter + or neither filter will work properly.
GroupAntiAffinityFilter + This filter is deprecated in favor of + ServerGroupAntiAffinityFilter. + The GroupAntiAffinityFilter ensures that each instance in a group is on a different host. To take advantage of this filter, the requester must pass a @@ -344,8 +361,10 @@ aggregate_image_properties_isolation_separator=. nova command-line tool, use the --hint flag. For example: - $ nova boot --image cedef40a-ed67-4d10-800e-17455edce175 --flavor 1 \ - --hint group=foo server-1 + $ nova boot --image IMAGE_ID --flavor 1 --hint group=foo server-1 + This filter should not be enabled at the same time as GroupAffinityFilter or + neither filter will work properly.
ImagePropertiesFilter @@ -509,6 +528,34 @@ isolated_images=342b492c-128f-4a42-8d3a-c5088cf27d13,ebd267a6-ca86-4d6c-9a0e-bd1 os:scheduler_hints key:
+
+ ServerGroupAffinityFilter + The ServerGroupAffinityFilter ensures that an instance is + scheduled on to a host from a set of group hosts. To + take advantage of this filter, the requester must create a + server group with an affinity policy, and + pass a scheduler hint, using group as the key + and the server group UUID as the value. Using the + nova command-line tool, use the + --hint flag. For + example: + $ nova server-group-create --policy affinity group-1 +$ nova boot --image IMAGE_ID --flavor 1 --hint group=SERVER_GROUP_UUID server-1 +
+
+ ServerGroupAntiAffinityFilter + The ServerGroupAntiAffinityFilter ensures that each instance in + a group is on a different host. To take advantage of this + filter, the requester must create a server group with an + anti-affinity policy, and pass a scheduler + hint, using group as the key and the server + group UUID as the value. Using the + nova command-line tool, use the + --hint flag. For + example: + $ nova server-group-create --policy anti-affinity group-1 +$ nova boot --image IMAGE_ID --flavor 1 --hint group=SERVER_GROUP_UUID server-1 +
SimpleCIDRAffinityFilter Schedule the instance based on host IP subnet range.