Added watchdog property key and flavor-key info
Added hw_watchdog_action property key and watchdog info for flavor_key section (plus minor edits). Added note about authorized users, and reference to the page in the Admin User Guide. Closes-bug: #1287406 Closes-bug: #1287450 Change-Id: Ib404d98ce504883ae22733f681e205c641720f5a
This commit is contained in:
parent
000235762d
commit
105b4f7ae5
@ -16,6 +16,8 @@
|
|||||||
image-update</command> and <command>glance image-create</command> commands. For
|
image-update</command> and <command>glance image-create</command> commands. For
|
||||||
example:</para>
|
example:</para>
|
||||||
<screen><prompt>$</prompt> <userinput>glance image-update <replaceable>img-uuid</replaceable> --property architecture=x86_64</userinput></screen>
|
<screen><prompt>$</prompt> <userinput>glance image-update <replaceable>img-uuid</replaceable> --property architecture=x86_64</userinput></screen>
|
||||||
|
<note><para>Behavior set using image properties overrides
|
||||||
|
behavior set using flavors.</para></note>
|
||||||
<table rules="all">
|
<table rules="all">
|
||||||
<caption>Property keys</caption>
|
<caption>Property keys</caption>
|
||||||
<col width="12%"/>
|
<col width="12%"/>
|
||||||
@ -231,6 +233,26 @@
|
|||||||
<literal>hw_video_ram</literal>.</td>
|
<literal>hw_video_ram</literal>.</td>
|
||||||
<td>Integer in MB (for example, '64')</td>
|
<td>Integer in MB (for example, '64')</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr valign="top">
|
||||||
|
<td>libvirt API driver</td>
|
||||||
|
<td>hw_watchdog_action</td>
|
||||||
|
<td>Enables a virtual hardware watchdog device that carries out the specified action
|
||||||
|
if the server hangs. The watchdog uses the i6300esb device (emulating a PCI
|
||||||
|
Intel 6300ESB). If <literal>hw_watchdog_action</literal> is not specified, the
|
||||||
|
watchdog is disabled.</td>
|
||||||
|
<td><itemizedlist>
|
||||||
|
<listitem><para><literal>disabled</literal>—(default) The device is not
|
||||||
|
attached. Allows the user to disable the watchdog
|
||||||
|
for the image, even if it has been enabled using the image's flavor.
|
||||||
|
</para></listitem>
|
||||||
|
<listitem><para><literal>reset</literal>—Forcefully reset the guest.</para></listitem>
|
||||||
|
<listitem><para><literal>poweroff</literal>—Forcefully power off the guest.</para></listitem>
|
||||||
|
<listitem><para><literal>pause</literal>—Pause the guest.</para></listitem>
|
||||||
|
<listitem><para><literal>none</literal>—Only enable the watchdog; do nothing if the server
|
||||||
|
hangs.</para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr valign="top">
|
<tr valign="top">
|
||||||
<td>libvirt API driver</td>
|
<td>libvirt API driver</td>
|
||||||
<td>os_command_line</td>
|
<td>os_command_line</td>
|
||||||
|
@ -1,12 +1,14 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<section xml:id="customize-flavors"
|
<!DOCTYPE section[
|
||||||
xmlns="http://docbook.org/ns/docbook"
|
<!-- Some useful entities borrowed from HTML -->
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
<!ENTITY ndash "–">
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
<!ENTITY mdash "—">
|
||||||
|
<!ENTITY hellip "…">
|
||||||
|
]>
|
||||||
|
<section xml:id="customize-flavors" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||||
<title>Flavors</title>
|
<title>Flavors</title>
|
||||||
<para>Authorized users can use the <command>nova
|
<para>Admin users can use the <command>nova flavor-</command> commands to customize and manage
|
||||||
flavor-create</command> command to create flavors. To see
|
flavors. To see the available flavor-related commands, run:</para>
|
||||||
the available flavor-related commands, run:</para>
|
|
||||||
<screen><prompt>$</prompt> <userinput>nova help | grep flavor-</userinput>
|
<screen><prompt>$</prompt> <userinput>nova help | grep flavor-</userinput>
|
||||||
<computeroutput> flavor-access-add Add flavor access for the given tenant.
|
<computeroutput> flavor-access-add Add flavor access for the given tenant.
|
||||||
flavor-access-list Print access information about the given flavor.
|
flavor-access-list Print access information about the given flavor.
|
||||||
@ -18,9 +20,15 @@
|
|||||||
flavor-list Print a list of available 'flavors' (sizes of
|
flavor-list Print a list of available 'flavors' (sizes of
|
||||||
flavor-show Show details about the given flavor.</computeroutput></screen>
|
flavor-show Show details about the given flavor.</computeroutput></screen>
|
||||||
<note>
|
<note>
|
||||||
<para>To modify an existing flavor in the dashboard, you must
|
<itemizedlist>
|
||||||
|
<listitem><para>Configuration rights can be delegated to additional users
|
||||||
|
by redefining the access controls for <option>compute_extension:flavormanage</option>
|
||||||
|
in <filename>/etc/nova/policy.json</filename> on the
|
||||||
|
<systemitem class="server">nova-api</systemitem> server.</para></listitem>
|
||||||
|
<listitem><para>To modify an existing flavor in the dashboard, you must
|
||||||
delete the flavor and create a modified one with the same
|
delete the flavor and create a modified one with the same
|
||||||
name.</para>
|
name.</para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
</note>
|
</note>
|
||||||
<para>Flavors define these elements:</para>
|
<para>Flavors define these elements:</para>
|
||||||
<table rules="all" width="75%">
|
<table rules="all" width="75%">
|
||||||
@ -88,54 +96,66 @@
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><literal>extra_specs</literal></td>
|
<td><literal>extra_specs</literal></td>
|
||||||
<td>Key and value pairs that define on which compute
|
<td><para>Key and value pairs that define on which compute
|
||||||
nodes a flavor can run. These pairs must match
|
nodes a flavor can run. These pairs must match
|
||||||
corresponding pairs on the compute nodes. Use to
|
corresponding pairs on the compute nodes. Use to
|
||||||
implement special resources, such as flavors that
|
implement special resources, such as flavors that
|
||||||
run on only compute nodes with GPU hardware.</td>
|
run on only compute nodes with GPU hardware.</para></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<para>Flavor customization can be limited by the hypervisor in
|
<para>Flavor customization can be limited by the hypervisor in use. For example the
|
||||||
use, for example the libvirt driver enables quotas on CPUs
|
<systemitem>libvirt</systemitem> driver enables quotas on CPUs available to a VM, disk
|
||||||
available to a VM, disk tuning, bandwidth I/O, and instance
|
tuning, bandwidth I/O, watchdog behavior, and instance VIF traffic control.</para>
|
||||||
VIF traffic control.</para>
|
<variablelist>
|
||||||
<para>You can configure the CPU limits with control parameters
|
<varlistentry><term>CPU limits</term>
|
||||||
with the nova tool. For example, to configure the I/O
|
<listitem><para>You can configure the CPU limits with control parameters with the <command>nova</command>
|
||||||
limit:</para>
|
client. For example, to configure the I/O limit, use:</para>
|
||||||
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:read_bytes_sec=10240000</userinput>
|
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:read_bytes_sec=10240000</userinput>
|
||||||
<prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:write_bytes_sec=10240000</userinput></screen>
|
<prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:write_bytes_sec=10240000</userinput></screen>
|
||||||
<para>There are CPU control parameters for weight shares,
|
<para>There are optional CPU control parameters for weight shares, enforcement
|
||||||
enforcement intervals for runtime quotas, and a quota for
|
intervals for runtime quotas, and a quota for maximum allowed
|
||||||
maximum allowed bandwidth.</para>
|
bandwidth:</para>
|
||||||
<para>The optional <literal>cpu_shares</literal> element specifies
|
<para>
|
||||||
the proportional weighted share for the domain. If this
|
<itemizedlist>
|
||||||
element is omitted, the service defaults to the OS provided
|
<listitem>
|
||||||
defaults. There is no unit for the value. It is a relative
|
<para><literal>cpu_shares</literal> specifies the proportional
|
||||||
measure based on the setting of other VMs. For example, a VM
|
weighted share for the domain. If this element is omitted, the
|
||||||
configured with value 2048 gets twice as much CPU time as a VM
|
service defaults to the OS provided defaults. There is no unit
|
||||||
configured with value 1024.</para>
|
for the value; it is a relative measure based on the setting of
|
||||||
<para>The optional <literal>cpu_period</literal> element specifies
|
other VMs. For example, a VM configured with value 2048 gets
|
||||||
the enforcement interval (unit: microseconds) for QEMU and LXC
|
twice as much CPU time as a VM configured with value
|
||||||
hypervisors. Within a period, each VCPU of the domain is not
|
1024.</para>
|
||||||
allowed to consume more than the quota worth of runtime. The
|
</listitem>
|
||||||
value should be in range <literal>[1000, 1000000]</literal>. A
|
<listitem>
|
||||||
period with value 0 means no value.</para>
|
<para><literal>cpu_period</literal> specifies the enforcement
|
||||||
<para>The optional <literal>cpu_quota</literal> element specifies
|
interval (unit: microseconds) for QEMU and LXC hypervisors.
|
||||||
the maximum allowed bandwidth (unit: microseconds). A domain
|
Within a period, each VCPU of the domain is not allowed to
|
||||||
with a quota with a negative value indicates that the domain
|
consume more than the quota worth of runtime. The value should
|
||||||
has infinite bandwidth, which means that it is not bandwidth
|
be in range <literal>[1000, 1000000]</literal>. A period with
|
||||||
controlled. The value should be in range <literal>[1000,
|
value 0 means no value.</para>
|
||||||
18446744073709551]</literal> or less than 0. A quota with
|
</listitem>
|
||||||
value 0 means no value. You can use this feature to ensure
|
<listitem>
|
||||||
that all vcpus run at the same speed. For example:</para>
|
<para><literal>cpu_quota</literal> specifies the maximum allowed
|
||||||
|
bandwidth (unit: microseconds). A domain with a negative-value quota
|
||||||
|
indicates that the domain has infinite bandwidth, which means that
|
||||||
|
it is not bandwidth controlled. The value should be in range
|
||||||
|
<literal>[1000, 18446744073709551]</literal> or less than 0. A
|
||||||
|
quota with value 0 means no value. You can use this feature to
|
||||||
|
ensure that all vCPUs run at the same speed. For example:</para>
|
||||||
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.low_cpu set quota:cpu_quota=10000</userinput>
|
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.low_cpu set quota:cpu_quota=10000</userinput>
|
||||||
<prompt>$</prompt> <userinput>nova flavor-key m1.low_cpu set quota:cpu_period=20000</userinput></screen>
|
<prompt>$</prompt> <userinput>nova flavor-key m1.low_cpu set quota:cpu_period=20000</userinput></screen>
|
||||||
<para>In this example, the instance of
|
<para>In this example, the instance of
|
||||||
<literal>m1.low_cpu</literal> can only consume a maximum
|
<literal>m1.low_cpu</literal> can only consume a maximum
|
||||||
of 50% CPU of a physical CPU computing capability.</para>
|
of 50% CPU of a physical CPU computing capability.</para>
|
||||||
<para>Through disk I/O quotas, you can set maximum disk write to
|
</listitem>
|
||||||
10 MB per second for a VM user. For example:</para>
|
</itemizedlist>
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry><term>Disk tuning</term>
|
||||||
|
<listitem><para>Using disk I/O quotas, you can set maximum disk write to 10 MB per second for a VM user. For
|
||||||
|
example:</para>
|
||||||
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.medium set disk_write_bytes_sec=10485760</userinput></screen>
|
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.medium set disk_write_bytes_sec=10485760</userinput></screen>
|
||||||
<para>The disk I/O options are:</para>
|
<para>The disk I/O options are:</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
@ -178,32 +198,67 @@
|
|||||||
<listitem>
|
<listitem>
|
||||||
<para>vif_outbound_peak</para>
|
<para>vif_outbound_peak</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist></listitem>
|
||||||
<para>Incoming and outgoing traffic can be shaped independently.
|
</varlistentry>
|
||||||
The bandwidth element can have at most one inbound and at most
|
<varlistentry><term>Bandwidth I/O</term>
|
||||||
one outbound child element. Leaving any of these children
|
<listitem><para>Incoming and outgoing traffic can be shaped independently. The bandwidth element can have at
|
||||||
element out result in no quality of service (QoS) applied on
|
most one inbound and at most one outbound child element. If you leave any of
|
||||||
that traffic direction. So, when you want to shape only the
|
these children element out, no quality of service (QoS) is applied on that
|
||||||
network's incoming traffic, use inbound only, and vice versa.
|
traffic direction. So, if you want to shape only the network's incoming traffic,
|
||||||
Each of these elements have one mandatory attribute
|
use inbound only (and vice versa). Each element has one mandatory attribute
|
||||||
average.</para>
|
average, which specifies the average bit rate on the interface being shaped.</para>
|
||||||
<para>It specifies average bit rate on the interface being shaped.
|
<para>There are also two optional attributes (integer): <option>peak</option>, which
|
||||||
Then there are two optional attributes: peak, which specifies
|
specifies maximum rate at which bridge can send data (kilobytes/second), and
|
||||||
maximum rate at which bridge can send data, and burst, amount
|
<option>burst</option>, the amount of bytes that can be burst at peak speed
|
||||||
of bytes that can be burst at peak speed. Accepted values for
|
(kilobytes). The rate is shared equally within domains connected to the
|
||||||
attributes are integer numbers, The units for average and peak
|
network.</para>
|
||||||
attributes are kilobytes per second, and for the burst just
|
<para>The following example configures a bandwidth limit for instance network
|
||||||
kilobytes. The rate is shared equally within domains connected
|
traffic:</para>
|
||||||
to the network.</para>
|
|
||||||
<para>This example configures a bandwidth limit for instance
|
|
||||||
network traffic:</para>
|
|
||||||
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:inbound_average=10240</userinput>
|
<screen><prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:inbound_average=10240</userinput>
|
||||||
<prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:outbound_average=10240</userinput></screen>
|
<prompt>$</prompt> <userinput>nova flavor-key m1.small set quota:outbound_average=10240</userinput></screen></listitem>
|
||||||
<para>Flavors can also be assigned to particular projects. By
|
</varlistentry>
|
||||||
|
<varlistentry><term>Watchdog behavior</term>
|
||||||
|
<listitem><para>For the <systemitem>libvirt</systemitem> driver, you can enable and set the behavior of a
|
||||||
|
virtual hardware watchdog device for each flavor. Watchdog devices keep an eye
|
||||||
|
on the guest server, and carry out the configured action if the server hangs.
|
||||||
|
The watchdog uses the i6300esb device (emulating a PCI Intel 6300ESB). If
|
||||||
|
<literal>hw_watchdog_action</literal> is not specified, the watchdog is
|
||||||
|
disabled.</para>
|
||||||
|
<para>To set the behavior, use:</para>
|
||||||
|
<screen><prompt>$</prompt> <userinput>nova flavor-key <replaceable>flavorName</replaceable> set hw_watchdog_action=<replaceable>action</replaceable></userinput></screen>
|
||||||
|
<para>Valid <replaceable>action</replaceable> values are:</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para><literal>disabled</literal>—(default) The device is not
|
||||||
|
attached.</para></listitem>
|
||||||
|
<listitem>
|
||||||
|
<para><literal>reset</literal>—Forcefully reset the guest.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para><literal>poweroff</literal>—Forcefully power off the
|
||||||
|
guest.</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para><literal>pause</literal>—Pause the guest.</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para><literal>none</literal>—Only enable the watchdog; do
|
||||||
|
nothing if the server hangs.</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
<note><para>Watchdog behavior set using a specific image's properties will override behavior set using
|
||||||
|
flavors.</para></note>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry><term>Instance VIF traffic control</term>
|
||||||
|
<listitem><para>Flavors can also be assigned to particular projects. By
|
||||||
default, a flavor is public and available to all projects.
|
default, a flavor is public and available to all projects.
|
||||||
Private flavors are only accessible to those on the access
|
Private flavors are only accessible to those on the access
|
||||||
list and are invisible to other projects. To create and assign
|
list and are invisible to other projects. To create and assign
|
||||||
a private flavor to a project, run these commands:</para>
|
a private flavor to a project, run these commands:</para>
|
||||||
<screen><prompt>$</prompt> <userinput>nova flavor-create --is-public false p1.medium auto 512 40 4</userinput>
|
<screen><prompt>$</prompt> <userinput>nova flavor-create --is-public false p1.medium auto 512 40 4</userinput>
|
||||||
<prompt>$</prompt> <userinput>nova flavor-access-add 259d06a0-ba6d-4e60-b42d-ab3144411d58 86f94150ed744e08be565c2ff608eef9</userinput></screen>
|
<prompt>$</prompt> <userinput>nova flavor-access-add 259d06a0-ba6d-4e60-b42d-ab3144411d58 86f94150ed744e08be565c2ff608eef9</userinput></screen></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
|
@ -10,6 +10,12 @@
|
|||||||
simply, a flavor is an available hardware configuration for a
|
simply, a flavor is an available hardware configuration for a
|
||||||
server. It defines the <quote>size</quote> of a virtual server
|
server. It defines the <quote>size</quote> of a virtual server
|
||||||
that can be launched.</para>
|
that can be launched.</para>
|
||||||
|
<note>
|
||||||
|
<para>Flavors can also determine on which compute host a flavor
|
||||||
|
can be used to launch an instance. For information
|
||||||
|
about customizing flavors, refer to the <link
|
||||||
|
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
|
||||||
|
><citetitle>OpenStack Cloud Administrator Guide</citetitle></link>.</para></note>
|
||||||
<para>A flavor consists of the following parameters:</para>
|
<para>A flavor consists of the following parameters:</para>
|
||||||
<variablelist>
|
<variablelist>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
|
Loading…
Reference in New Issue
Block a user