Updated Branches: refs/heads/4.2-forward 2d08a322d -> ee0b1d768
CLOUDSTACK-2121. DOC. New docs for affinity groups. Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/ee0b1d76 Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/ee0b1d76 Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/ee0b1d76 Branch: refs/heads/4.2-forward Commit: ee0b1d768af0543d8d023d118d30fbc340da4e83 Parents: 2d08a32 Author: Jessica <[email protected]> Authored: Tue Aug 27 13:48:59 2013 -0700 Committer: Jessica <[email protected]> Committed: Tue Aug 27 13:48:59 2013 -0700 ---------------------------------------------------------------------- docs/en-US/host-allocation.xml | 91 ++++++++++++++++++++-- docs/en-US/images/change-affinity-button.png | Bin 0 -> 8570 bytes docs/en-US/stopping-and-starting-vms.xml | 2 +- docs/en-US/virtual-machines.xml | 1 + docs/en-US/working-with-hosts.xml | 1 - 5 files changed, 88 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack/blob/ee0b1d76/docs/en-US/host-allocation.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/host-allocation.xml b/docs/en-US/host-allocation.xml index d287856..9e752af 100644 --- a/docs/en-US/host-allocation.xml +++ b/docs/en-US/host-allocation.xml @@ -23,9 +23,90 @@ --> <section id="host-allocation"> - <title>Host Allocation</title> - <para>The system automatically picks the most appropriate host to run each virtual machine. End users may specify the zone in which the virtual machine will be created. End users do not have control over which host will run the virtual machine instance.</para> - <para>&PRODUCT; administrators can specify that certain hosts should have a preference for particular types of guest instances. For example, an administrator could state that a host should have a preference to run Windows guests. The default host allocator will attempt to place guests of that OS type on such hosts first. If no such host is available, the allocator will place the instance wherever there is sufficient physical capacity.</para> - <para>Both vertical and horizontal allocation is allowed. Vertical allocation consumes all the resources of a given host before allocating any guests on a second host. This reduces power consumption in the cloud. Horizontal allocation places a guest on each host in a round-robin fashion. This may yield better performance to the guests in some cases. &PRODUCT; also allows an element of CPU over-provisioning as configured by the administrator. Over-provisioning allows the administrator to commit more CPU cycles to the allocated guests than are actually available from the hardware.</para> - <para>&PRODUCT; also provides a pluggable interface for adding new allocators. These custom allocators can provide any policy the administrator desires.</para> + <title>Assigning VMs to Hosts</title> + <para>At any point in time, each virtual machine instance is running on a single host. + How does &PRODUCT; determine which host to place a VM on? There are several ways:</para> + <itemizedlist> + <listitem><para>Automatic default host allocation. &PRODUCT; can automatically pick + the most appropriate host to run each virtual machine.</para></listitem> + <listitem><para>Instance type preferences. &PRODUCT; administrators can specify that certain hosts should have a preference for particular types of guest instances. + For example, an administrator could state that a host should have a preference to run Windows guests. + The default host allocator will attempt to place guests of that OS type on such hosts first. + If no such host is available, the allocator will place the instance wherever there is sufficient physical capacity.</para></listitem> + <listitem><para>Vertical and horizontal allocation. + Vertical allocation consumes all the resources of a given host before allocating any guests on a second host. + This reduces power consumption in the cloud. Horizontal allocation places a guest on each host in a round-robin fashion. + This may yield better performance to the guests in some cases.</para></listitem> + <listitem><para>End user preferences. + Users can not control exactly which host will run a given VM instance, + but they can specify a zone for the VM. + &PRODUCT; is then restricted to allocating the VM only to one of the hosts in that zone.</para></listitem> + <listitem><para>Host tags. The administrator can assign tags to hosts. These tags can be used to + specify which host a VM should use. + The &PRODUCT; administrator decides whether to define host tags, then create a service offering using those tags and offer it to the user. + </para></listitem> + <listitem><para>Affinity groups. + By defining affinity groups and assigning VMs to them, the user or administrator can + influence (but not dictate) which VMs should run on separate hosts. + This feature is to let users specify that certain VMs won't be on the same host.</para></listitem> + <listitem><para>&PRODUCT; also provides a pluggable interface for adding new allocators. + These custom allocators can provide any policy the administrator desires.</para></listitem> + </itemizedlist> + <section id="affinity-groups"> + <title>Affinity Groups</title> + <para>By defining affinity groups and assigning VMs to them, the user or administrator can + influence (but not dictate) which VMs should run on separate hosts. + This feature is to let users specify that VMs with the same âhost anti-affinityâ type wonât be on the same host. + This serves to increase fault tolerance. + If a host fails, another VM offering the same service (for example, hosting the user's website) is still up and running on another host.</para> + <para>The scope of an affinity group is per user account.</para> + <formalpara><title>Creating a New Affinity Group</title> + <para>To add an affinity group:</para></formalpara> + <orderedlist> + <listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem> + <listitem><para>In the left navigation bar, click Affinity Groups.</para></listitem> + <listitem><para>Click Add affinity group. In the dialog box, fill in the following fields:</para> + <itemizedlist> + <listitem><para>Name. Give the group a name.</para></listitem> + <listitem><para>Description. Any desired text to tell more about the purpose of the group.</para></listitem> + <listitem><para>Type. The only supported type shipped with &PRODUCT; is Host Anti-Affinity. + This indicates that the VMs in this group should avoid being placed on the same VM with each other. + If you see other types in this list, it means that your installation of &PRODUCT; has been extended + with customized affinity group plugins.</para></listitem> + </itemizedlist> + </listitem> + </orderedlist> + <formalpara><title>Assign a New VM to an Affinity Group</title> + <para>To assign a new VM to an affinity group:</para></formalpara> + <itemizedlist> + <listitem><para>Create the VM as usual, as described in <xref linkend="creating-vms"/>. + In the Add Instance wizard, there is a new Affinity tab where you can select the affinity group.</para></listitem> + </itemizedlist> + <formalpara><title>Change Affinity Group for an Existing VM</title> + <para>To assign an existing VM to an affinity group:</para></formalpara> + <orderedlist> + <listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem> + <listitem><para>In the left navigation bar, click Instances.</para></listitem> + <listitem><para>Click the name of the VM you want to work with.</para></listitem> + <listitem><para>Stop the VM by clicking the Stop button.</para></listitem> + <listitem><para>Click the Change Affinity button. <inlinemediaobject> + <imageobject> + <imagedata fileref="./images/change-affinity-button.png"/> + </imageobject> + <textobject> + <phrase>change-affinity-button.png: button to assign an affinity group + to a virtual machine</phrase> + </textobject> + </inlinemediaobject> + </para></listitem> + </orderedlist> + <formalpara><title>View Members of an Affinity Group</title> + <para>To see which VMs are currently assigned to a particular affinity group:</para></formalpara> + <orderedlist> + <listitem><para>In the left navigation bar, click Affinity Groups.</para></listitem> + <listitem><para>Click the name of the group you are interested in.</para></listitem> + <listitem><para>Click View Instances. The members of the group are listed.</para> + <para>From here, you can click the name of any VM in the list to access all its details and controls.</para></listitem> + </orderedlist> + </section> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/ee0b1d76/docs/en-US/images/change-affinity-button.png ---------------------------------------------------------------------- diff --git a/docs/en-US/images/change-affinity-button.png b/docs/en-US/images/change-affinity-button.png new file mode 100644 index 0000000..36b4ae3 Binary files /dev/null and b/docs/en-US/images/change-affinity-button.png differ http://git-wip-us.apache.org/repos/asf/cloudstack/blob/ee0b1d76/docs/en-US/stopping-and-starting-vms.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/stopping-and-starting-vms.xml b/docs/en-US/stopping-and-starting-vms.xml index 1c8bd80..25c1f49 100644 --- a/docs/en-US/stopping-and-starting-vms.xml +++ b/docs/en-US/stopping-and-starting-vms.xml @@ -24,6 +24,6 @@ <section id="stopping-and-starting-vms"> <title>Stopping and Starting VMs</title> - <para>Once a VM instance is created, you can stop, restart, or delete it as needed. In the &PRODUCT; UI, click Instances, select the VM, and use the Stop, Start, Reboot, and Destroy links.</para> + <para>Once a VM instance is created, you can stop, restart, or delete it as needed. In the &PRODUCT; UI, click Instances, select the VM, and use the Stop, Start, Reboot, and Destroy buttons.</para> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/ee0b1d76/docs/en-US/virtual-machines.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/virtual-machines.xml b/docs/en-US/virtual-machines.xml index 0effb97..8d88478 100644 --- a/docs/en-US/virtual-machines.xml +++ b/docs/en-US/virtual-machines.xml @@ -26,6 +26,7 @@ <xi:include href="creating-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="accessing-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="stopping-and-starting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="host-allocation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="vm-snapshots.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="changing-vm-name-os-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="append-displayname-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/ee0b1d76/docs/en-US/working-with-hosts.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/working-with-hosts.xml b/docs/en-US/working-with-hosts.xml index 93adcfc..d1fc74f 100644 --- a/docs/en-US/working-with-hosts.xml +++ b/docs/en-US/working-with-hosts.xml @@ -34,7 +34,6 @@ <xi:include href="re-install-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="maintain-hypervisors-on-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="change-host-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="host-allocation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="over-provisioning-service-offering-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="vlan-provisioning.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> </chapter>
