From 2abf4a0a79a34686a92e4ba6798f5074156a97db Mon Sep 17 00:00:00 2001
From: Stephen Gordon <sgordon@redhat.com>
Date: Sun, 2 Mar 2014 15:11:54 -0500
Subject: [PATCH] Clarify effect of cpu_allocation_ratio setting

Clarify that the cpu_allocation_ratio only takes effect
internally in the scheduler. That changes to this value
are not reflected in the API, CLI, and dashboard is a
common source of confusion.

Change-Id: I48af4e47675f9476cd93253386b7cd45baefcb67
---
 .../compute/section_compute-scheduler.xml           | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/doc/config-reference/compute/section_compute-scheduler.xml b/doc/config-reference/compute/section_compute-scheduler.xml
index 1caeb6be39..2a58316a74 100644
--- a/doc/config-reference/compute/section_compute-scheduler.xml
+++ b/doc/config-reference/compute/section_compute-scheduler.xml
@@ -186,7 +186,7 @@ scheduler_available_filters=myfilter.MyFilter</programlisting>
                 instance may exceed the physical cores).</para>
             <para>This filter can be configured to allow a fixed
                 amount of vCPU overcommitment by using the
-                    <literal>cpu_allocation_ratio</literal>
+                    <option>cpu_allocation_ratio</option>
                 Configuration option in
                 <filename>nova.conf</filename>. The default setting
                 is:</para>
@@ -196,6 +196,17 @@ scheduler_available_filters=myfilter.MyFilter</programlisting>
                 that node.</para>
             <para>To disallow vCPU overcommitment set:</para>
             <programlisting language="ini">cpu_allocation_ratio=1.0</programlisting>
+            <note>
+              <para>
+                The Compute API will always return the actual number of CPU
+                cores available on a compute node regardless of the value of
+                the <option>cpu_allocation_ratio</option> configuration key. As
+                a result changes to the <option>cpu_allocation_ratio</option>
+                are not reflected via the command line clients or the
+                dashboard. Changes to this configuration key are only taken
+                into account internally in the scheduler.
+              </para>
+            </note>
         </section>
         <section xml:id="differenthostfilter">
             <title>DifferentHostFilter</title>