UG edits: cli_nova_manage_instances section

- Breaking up https://review.openstack.org/#/c/89581/
- cli_nova_manage_instances and associated files

Change-Id: I301ea42b29690a67859e3ac600817792ca76afcf
This commit is contained in:
Karin Levenstein 2014-04-24 09:54:52 -04:00
parent 2cae2e7f2d
commit 2ce3d3aea0
9 changed files with 266 additions and 258 deletions

View File

@ -2,56 +2,64 @@
<section xml:id="baremetal" 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>Manage bare metal nodes</title>
<para>The bare metal driver for OpenStack Compute manages
provisioning of physical hardware using common cloud APIs and
tools such as Orchestration (Heat). The use case for this driver
is for single tenant clouds such as a high-performance computing
cluster or deploying OpenStack itself. Development efforts are
focused on moving the driver out of the Compute code base in the
Icehouse release. If you use the bare metal driver, you must
create and add a network interface to a bare metal node. Then, you
can launch an instance from a bare metal image.</para>
<para>You can list and delete bare metal nodes. When you delete a
node, any associated network interfaces are removed. You can list
and remove network interfaces that are associated with a bare
metal node.</para>
<title>Manage bare-metal nodes</title>
<para>The bare-metal driver for OpenStack Compute manages provisioning of
physical hardware by using common cloud APIs and tools such as Orchestration
(Heat). The use case for this driver is for single tenant clouds such as a
high-performance computing cluster or for deploying OpenStack itself.</para>
<para>If you use the bare-metal driver, you must create a network interface
and add it to a bare-metal node. Then, you can launch an instance from a
bare-metal image.</para>
<note><para>Development efforts are focused on moving the driver out of the Compute
code base in the Icehouse release.</para></note>
<para>You can list and delete bare-metal nodes. When you delete a node, any
associated network interfaces are removed. You can list and remove network
interfaces that are associated with a bare-metal node.</para>
<itemizedlist>
<title>Commands</title>
<para>The following commands can be used to manage bare-metal nodes.</para>
<listitem>
<para><command>baremetal-interface-add</command>. Adds a network
interface to a bare metal node.</para>
<para><command>baremetal-interface-add</command>. Adds a network interface
to a bare-metal node.</para>
</listitem>
<listitem>
<para><command>baremetal-interface-list</command>. Lists network
interfaces associated with a bare metal node.</para>
interfaces associated with a bare-metal node.</para>
</listitem>
<listitem>
<para><command>baremetal-interface-remove</command>. Removes a
network interface from a bare metal node.</para>
<para><command>baremetal-interface-remove</command>. Removes a network
interface from a bare-metal node.</para>
</listitem>
<listitem>
<para><command>baremetal-node-create</command>. Creates a bare
metal node.</para>
<para><command>baremetal-node-create</command>. Creates a bare-metal
node.</para>
</listitem>
<listitem>
<para><command>baremetal-node-delete</command>. Removes a bare
metal node and any associated interfaces.</para>
<para><command>baremetal-node-delete</command>. Removes a bare-metal node
and any associated interfaces.</para>
</listitem>
<listitem>
<para><command>baremetal-node-list</command>. Lists available
bare metal nodes.</para>
<para><command>baremetal-node-list</command>. Lists available bare-metal
nodes.</para>
</listitem>
<listitem>
<para><command>baremetal-node-show</command>. Shows information
about a bare metal node.</para>
<para><command>baremetal-node-show</command>. Shows information about a
bare-metal node.</para>
</listitem>
</itemizedlist>
<procedure>
<step>
<para>Create a bare metal node:</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-create --pm_address=1.2.3.4 --pm_user=ipmi --pm_password=ipmi $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff</userinput></screen>
<screen><computeroutput>+------------------+-------------------+
<section xml:id="cli_nova_baremetal-create">
<title>Create a bare-metal node</title>
<para>When you create a bare-metal node, your PM address, username, and
password should match those that are configured in your hardware's
BIOS/IPMI configuration.</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-create --pm_address=PM_ADDRESS --pm_user=PM_USERNAME \
--pm_password=PM_PASSWORD $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff</userinput></screen>
<para>The following example shows the command and results from creating
a node with the PM address <filename>1.2.3.4</filename>, the PM username
<literal>ipmi</literal>, and password <literal>ipmi</literal>.</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-create --pm_address=1.2.3.4 --pm_user=ipmi \
--pm_password=ipmi $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff</userinput>
<computeroutput>+------------------+-------------------+
| Property | Value |
+------------------+-------------------+
| instance_uuid | None |
@ -66,51 +74,64 @@
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+-------------------+</computeroutput></screen>
</step>
<step>
<para>Add a network interface to the node:</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-interface-add 1 aa:bb:cc:dd:ee:ff</userinput></screen>
<screen><computeroutput>+-------------+-------------------+
+------------------+-------------------+</computeroutput></screen></section>
<section xml:id="cli_nova_baremetal-interface">
<title>Add a network interface to the node:</title>
<para>For each NIC on the node, you must create an interface, specifying the
interface's MAC address.</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-interface-add 1 aa:bb:cc:dd:ee:ff</userinput>
<computeroutput>+-------------+-------------------+
| Property | Value |
+-------------+-------------------+
| datapath_id | 0 |
| id | 1 |
| port_no | 0 |
| address | aa:bb:cc:dd:ee:ff |
+-------------+-------------------+</computeroutput></screen>
</step>
<step>
<para>Launch an instance from a bare metal image:</para>
<screen><prompt>$</prompt> <userinput>nova boot --image my-baremetal-image --flavor my-baremetal-flavor test</userinput> </screen>
<screen><computeroutput>+-----------------------------+--------------------------------------+
+-------------+-------------------+</computeroutput></screen></section>
<section xml:id="cli_nova_baremetal-instancelaunch">
<title>Launch an instance
from a bare-metal image:</title>
<para>A bare-metal instance is an instance created directly on a physical
machine without any virtualization layer running underneath it. Nova
retains power control via IPMI. In some situations, Nova may retain
network control via Neutron and OpenFlow.</para>
<screen><prompt>$</prompt> <userinput>nova boot --image my-baremetal-image --flavor my-baremetal-flavor test</userinput>
<computeroutput>+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
| status | BUILD |
| id | cc302a8f-cd81-484b-89a8-b75eb3911b1b |
... wait for instance to become active ...</computeroutput></screen>
</step>
<step>
<para>List bare metal nodes and interfaces:</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-list</userinput></screen>
<para>When a node is in use, its status includes the UUID of the
instance that runs on it:</para>
<screen><computeroutput>+----+--------+------+-----------+---------+-------------------
+------+------------+-------------+-------------+---------------+
| ID | Host | CPUs | Memory_MB | Disk_GB | MAC Address
| VLAN | PM Address | PM Username | PM Password | Terminal Port |
+----+--------+------+-----------+---------+-------------------
+------+------------+-------------+-------------+---------------+
| 1 | ubuntu | 1 | 512 | 10 | aa:bb:cc:dd:ee:ff
| None | 1.2.3.4 | ipmi | | None |
+----+--------+------+-----------+---------+-------------------
+------+------------+-------------+-------------+---------------+</computeroutput></screen>
</step>
<step>
<para>Show details for a bare metal node:</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-show 1</userinput> </screen>
<screen><computeroutput>+------------------+--------------------------------------+
<note>
<para>Set the <parameter>--availability_zone</parameter> parameter to
specify which zone or node to use to start the server. Separate the zone
from the host name with a comma. For example:</para>
<screen><prompt>$</prompt> <userinput>nova boot --availability_zone=zone:<replaceable>HOST</replaceable>,<replaceable>NODE</replaceable></userinput></screen>
<para><literal>host</literal> is optional for the
<literal>--availability_zone</literal> parameter. You can specify
simply <literal>zone:,node</literal>. You must still use the
comma.</para>
</note>
</section>
<section xml:id="cli_nova_baremetal-list">
<title>List bare-metal nodes and
interfaces:</title>
<para>Use the <command>nova baremetal-node-list</command> command to view
all bare-metal nodes and interfaces. When a node is in use, its status
includes the UUID of the instance that runs on it:</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-list</userinput>
<computeroutput>+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
| ID | Host | CPUs | Memory_MB | Disk_GB | MAC Address | VLAN | PM Address | PM Username | PM Password | Terminal Port |
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
| 1 | ubuntu | 1 | 512 | 10 | aa:bb:cc:dd:ee:ff | None | 1.2.3.4 | ipmi | | None |
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+</computeroutput></screen></section>
<section xml:id="cli_nova_baremetal-details">
<title>Show details for a bare-metal node:</title>
<para>Use the <command>nova baremetal-node-list</command> command to view
the details for a bare-metal node.</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-show 1</userinput>
<computeroutput>+------------------+--------------------------------------+
| Property | Value |
+------------------+--------------------------------------+
| instance_uuid | cc302a8f-cd81-484b-89a8-b75eb3911b1b |
@ -126,17 +147,5 @@
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+--------------------------------------+</computeroutput></screen>
</step>
</procedure>
<note>
<para>Set the <parameter>--availability_zone</parameter> parameter
to specify which zone or node to use to start the server.
Separate the zone from the host name with a comma. For
example:</para>
<screen><prompt>$</prompt> <userinput>nova boot --availability_zone=zone:<replaceable>host</replaceable>,<replaceable>node</replaceable></userinput></screen>
<para><parameter>host</parameter> is optional for the
<parameter>--availability_zone</parameter> parameter.
<parameter>zone:,node</parameter> also works.</para>
</note>
+------------------+--------------------------------------+</computeroutput></screen></section>
</section>

View File

@ -4,14 +4,16 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:html="http://www.w3.org/1999/xhtml" version="5.0">
<title>Get a console to access an instance</title>
<procedure> <step><para>To get a VNC console to access an instance, run the following
command:</para> <screen><prompt>$</prompt> <userinput>nova get-vnc-console myCirrosServer xvpvnc</userinput></screen>
<title>Access an instance through a console</title>
<para>To access an instance through a VNC console, run the
following command:</para> <screen><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>INSTANCE_NAME</replaceable> xvpvnc</userinput></screen>
<para>The command returns a URL from which you can access your instance:</para>
<screen><computeroutput>+--------+------------------------------------------------------------------------------+
| Type | Url |
+--------+------------------------------------------------------------------------------+
| xvpvnc | http://166.78.190.96:6081/console?token=c83ae3a3-15c4-4890-8d45-aefb494a8d6c |
+--------+------------------------------------------------------------------------------+</computeroutput></screen>
<note><para>To get a non-VNC console, specify the <parameter>novnc</parameter> parameter instead of the <parameter>xvpvnc</parameter> parameter.</para></note></step></procedure>
<note><para>To access an instance through a non-VNC console, specify the
<parameter>novnc</parameter> parameter instead of the
<parameter>xvpvnc</parameter> parameter.</para></note>
</section>

View File

@ -7,24 +7,10 @@
<para>You change the size of a server by changing its flavor.</para>
<procedure>
<step>
<para>List the available flavors:</para>
<screen><prompt>$</prompt> <userinput>nova flavor-list</userinput></screen>
<screen><computeroutput>+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
| 1 | m1.tiny | 512 | 0 | 0 | | 1 | 1.0 | True |
| 2 | m1.small | 2048 | 20 | 0 | | 1 | 1.0 | True |
| 3 | m1.medium | 4096 | 40 | 0 | | 2 | 1.0 | True |
| 4 | m1.large | 8192 | 80 | 0 | | 4 | 1.0 | True |
| 5 | m1.xlarge | 16384 | 160 | 0 | | 8 | 1.0 | True |
+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+</computeroutput></screen>
</step>
<step>
<para>Show information about your server, including its
size:</para>
<screen><prompt>$</prompt> <userinput>nova show myCirrosServer</userinput></screen>
<screen><computeroutput>+-------------------------------------+----------------------------------------------------------------+
<para>Show information about your server, including its size, which is shown as the value of the flavor
property.</para>
<screen><prompt>$</prompt> <userinput>nova show myCirrosServer</userinput>
<computeroutput>+-------------------------------------+----------------------------------------------------------------+
| Property | Value |
+-------------------------------------+----------------------------------------------------------------+
| status | ACTIVE |
@ -54,13 +40,24 @@
| OS-EXT-AZ:availability_zone | nova |
| config_drive | |
+-------------------------------------+----------------------------------------------------------------+</computeroutput></screen>
<para>The size of the server is <literal>m1.small
(2)</literal>.</para>
<para>The size (flavor) of the server is <literal>m1.small (2)</literal>.</para>
</step>
<step>
<para>To resize the server, pass the server ID and the desired
flavor to the nova <command>resize</command> command. Include
the <literal>--poll</literal> parameter to report the resize
<para>List the available flavors with the following command:</para>
<screen><prompt>$</prompt> <userinput>nova flavor-list</userinput>
<computeroutput>+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
| 1 | m1.tiny | 512 | 0 | 0 | | 1 | 1.0 | True |
| 2 | m1.small | 2048 | 20 | 0 | | 1 | 1.0 | True |
| 3 | m1.medium | 4096 | 40 | 0 | | 2 | 1.0 | True |
| 4 | m1.large | 8192 | 80 | 0 | | 4 | 1.0 | True |
| 5 | m1.xlarge | 16384 | 160 | 0 | | 8 | 1.0 | True |
+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+</computeroutput></screen>
</step>
<step>
<para>To resize the server, pass the server ID or name and the new flavor to the <command>nova
resize</command> command. Include the <literal>--poll</literal> parameter to report the resize
progress.</para>
<screen><prompt>$</prompt> <userinput>nova resize myCirrosServer 4 --poll</userinput></screen>
<screen><computeroutput>Instance resizing... 100% complete
@ -68,24 +65,23 @@ Finished</computeroutput> </screen>
</step>
<step>
<para>Show the status for your server:</para>
<screen><prompt>$</prompt> <userinput>nova list</userinput></screen>
<screen><computeroutput>+--------------------------------------+-------------+--------+-----------------------------------------+
<screen><prompt>$</prompt> <userinput>nova list</userinput>
<computeroutput>+--------------------------------------+----------------+--------+-----------------------------------------+
| ID | Name | Status | Networks |
+--------------------------------------+-------------+--------+-----------------------------------------+
| 970e4ca0-f9b7-4c44-80ed-bf0152c96ae1 | resize-demo | RESIZE | private=172.16.101.6, public=10.4.113.6 |
+--------------------------------------+-------------+--------+-----------------------------------------+</computeroutput></screen>
+--------------------------------------+----------------+--------+-----------------------------------------+
| 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | myCirrosServer | RESIZE | private=172.16.101.6, public=10.4.113.6 |
+--------------------------------------+----------------+--------+-----------------------------------------+</computeroutput></screen>
<para>When the resize completes, the status becomes VERIFY_RESIZE.</para>
</step>
<step>
<para>When the resize completes, the status becomes
<literal>VERIFY_RESIZE</literal>. To confirm the
resize:</para>
<screen><prompt>$</prompt> <userinput>nova resize-confirm 6beefcf7-9de6-48b3-9ba9-e11b343189b3</userinput></screen>
<para>Confirm the resize:</para>
<screen><prompt>$</prompt> <userinput>nova resize-confirm 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5</userinput></screen>
<para>The server status becomes ACTIVE.</para>
</step>
<step>
<para>If the resize fails or does not work as expected, you can
revert the resize:</para>
<screen><prompt>$</prompt> <userinput>nova resize-revert 6beefcf7-9de6-48b3-9ba9-e11b343189b3</userinput></screen>
<screen><prompt>$</prompt> <userinput>nova resize-revert 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5</userinput></screen>
<para>The server status becomes ACTIVE.</para>
</step>
</procedure>

View File

@ -5,21 +5,16 @@ xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="search_ip" version="5.0">
<title>Search for an instance using IP address</title>
<para>You can search for an instance using the IP address parameter.</para>
<procedure>
<step>
<para>Use the --<parameter>ip</parameter> to search for an instance
using the IP address.</para>
<screen><prompt>$</prompt> <userinput>nova list --<parameter>ip</parameter> <replaceable>IP_ADDRESS</replaceable> </userinput>
</screen>
<para>For example, use the <command>nova list</command> command as follows:</para>
<para>You can search for an instance using the IP address parameter,
<literal>--ip</literal>, with the <command>nova list</command>
command.</para>
<screen><prompt>$</prompt> <userinput>nova list --<parameter>ip</parameter> <replaceable>IP_ADDRESS</replaceable> </userinput></screen>
<para>The following example shows the results of a search on
<filename>10.0.0.4</filename>.</para>
<screen><prompt>$</prompt> <userinput>nova list --<parameter>ip</parameter> <replaceable>10.0.0.4</replaceable></userinput>
<computeroutput>+--------------------------------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+--------------------------------------+----------------------+--------+------------+-------------+------------------+
| 8a99547e-7385-4ad1-ae50-4ecfaaad5f42 | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+--------------------------------------+----------------------+--------+------------+-------------+------------------+</computeroutput>
</screen>
</step>
</procedure>
+--------------------------------------+----------------------+--------+------------+-------------+------------------+</computeroutput></screen>
</section>

View File

@ -7,38 +7,38 @@
<para>Use one of the following methods to stop and start an
instance.</para>
<section xml:id="pause_server">
<title>Pause and un-pause an instance</title>
<procedure xml:id="nova_cli_pause_unpause">
<step>
<para>To pause a server, run the following command:</para>
<screen><prompt>$</prompt> <userinput>nova pause <replaceable>SERVER</replaceable></userinput> </screen>
<title>Pause and unpause an instance</title>
<itemizedlist>
<listitem>
<para>To pause an instance, run the following command:</para>
<screen><prompt>$</prompt> <userinput>nova pause <replaceable>INSTANCE_NAME</replaceable></userinput> </screen>
<para>This command stores the state of the VM in RAM. A paused
instance continues to run in a frozen state.</para>
<para>To un-pause the server, run the following
command:</para>
<screen><prompt>$</prompt> <userinput>nova unpause <replaceable>SERVER</replaceable></userinput> </screen>
</step>
</procedure>
instance continues to run in a frozen state.</para></listitem>
<listitem><para>To unpause the instance, run the following command:</para>
<screen><prompt>$</prompt> <userinput>nova unpause <replaceable>INSTANCE_NAME</replaceable></userinput> </screen>
</listitem>
</itemizedlist>
</section>
<section xml:id="suspend_resume">
<title>Suspend and resume an instance</title>
<procedure xml:id="nova_cli_suspend_resume">
<para>Administrative users might want to suspend an infrequently
used instance or to perform system maintenance.</para>
<step>
<para>When you suspend an instance, its VM state is stored on
disk, all memory is written to disk, and the virtual machine
is stopped. Suspending an instance is similar to placing a
device in hibernation; memory and vCPUs become
available.</para>
<itemizedlist>
<para>Administrative users might want to suspend an instance if
it is infrequently used or to perform system maintenance. When
you suspend an instance, its VM state is stored on disk, all
memory is written to disk, and the virtual machine is stopped.
Suspending an instance is similar to placing a device in
hibernation; memory and vCPUs become available to create other
instances.</para>
<listitem>
<para>To initiate a hypervisor-level suspend operation, run
the following command:</para>
<screen><prompt>$</prompt> <userinput>nova suspend <replaceable>SERVER</replaceable></userinput></screen>
</step>
<step>
<para>To resume a suspended server:</para>
<screen><prompt>$</prompt> <userinput>nova resume <replaceable>SERVER</replaceable></userinput></screen>
</step>
</procedure>
<screen><prompt>$</prompt> <userinput>nova suspend <replaceable>INSTANCE_NAME</replaceable></userinput></screen>
</listitem>
<listitem>
<para>To resume a suspended instance, run the following
command:</para>
<screen><prompt>$</prompt> <userinput>nova resume <replaceable>INSTANCE_NAME</replaceable></userinput></screen>
</listitem>
</itemizedlist>
</section>
</section>

View File

@ -18,13 +18,11 @@
| d7efd3e4-d375-46d1-9d57-372b6e4bdb7f | newServer | ERROR | None | NOSTATE | |
+--------------------------------------+----------------------+--------+------------+-------------+------------------+</computeroutput></screen>
</step><step>
<para>Use the following command to delete the
<literal>newServer</literal> instance, which is in
<literal>ERROR</literal> state:</para>
<para>Run the <command>nova delete</command> command to delete the instance. The following example shows deletion
of the <filename>newServer</filename> instance, which is in <literal>ERROR</literal> state:</para>
<screen><prompt>$</prompt> <userinput>nova delete newServer</userinput></screen>
</step><step><para>The command does not notify that your server was deleted.</para>
<para>Instead, run the <command>nova list</command>
command:</para>
<para>The command does not notify that your server was deleted.</para></step><step>
<para>To verify that the server was deleted, run the <command>nova list</command> command:</para>
<screen><prompt>$</prompt> <userinput>nova list</userinput>
<computeroutput>+--------------------------------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |

View File

@ -3,17 +3,23 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="usage_statistics">
<title>Show usage statistics for hosts and instances</title><para xlink:href="http://graphite.wikidot.com">You can show basic
statistics on resource usage for hosts and instances.</para>
<note> <para xlink:href="http://graphite.wikidot.com">For more sophisticated
<note>
<para xlink:href="http://graphite.wikidot.com">For more sophisticated
monitoring, see the <link
xlink:href="https://launchpad.net/ceilometer"
>Ceilometer</link> project, which is under
development. You can also use tools, such as <link
xlink:href="http://ganglia.info/">Ganglia</link> or
<link xlink:href="http://graphite.wikidot.com/"
>Graphite</link>, to gather more detailed data.</para></note>
<procedure xml:id="host_usage_statistics">
<title>To show host usage statistics</title>
<step><para>List the hosts and the nova-related services that run on
>Graphite</link>, to gather more detailed data.</para>
</note>
<section xml:id="host_usage_statistics">
<title>Show host usage statistics</title>
<para>The following examples show the host usage statistics for a host
called <filename>devstack</filename>.</para>
<itemizedlist>
<listitem>
<para>List the hosts and the nova-related services that run on
them:</para><screen><prompt>$</prompt> <userinput>nova host-list</userinput>
<computeroutput>+-----------+-------------+----------+
| host_name | service | zone |
@ -24,11 +30,10 @@
| devstack | network | internal |
| devstack | scheduler | internal |
| devstack | consoleauth | internal |
+-----------+-------------+----------+</computeroutput></screen>
</step>
<step><para>Get a summary of resource usage of all of the instances running
on the host.</para>
<screen><prompt>$</prompt> <userinput>nova host-describe <replaceable>devstack</replaceable></userinput>
+-----------+-------------+----------+</computeroutput></screen></listitem>
<listitem><para>Get a summary of resource usage of all of the instances running on
the host:</para>
<screen><prompt>$</prompt> <userinput>nova host-describe devstack</userinput>
<computeroutput>+-----------+----------------------------------+-----+-----------+---------+
| HOST | PROJECT | cpu | memory_mb | disk_gb |
+----------+----------------------------------+-----+-----------+---------+
@ -40,38 +45,43 @@
+----------+----------------------------------+-----+-----------+---------+</computeroutput></screen>
<para>The <literal>cpu</literal> column shows the sum of
the virtual CPUs for instances running on the host.</para>
<para>The <literal>memory_mb</literal> column shows the
sum of the memory (in MB) allocated to the instances
that run on the hosts.</para>
<para>The <literal>disk_gb</literal> column shows the sum
of the root and ephemeral disk sizes (in GB) of the
instances that run on the hosts.</para>
<para>The <literal>used_now</literal> row shows the sum
of the resources allocated to the instances
that run on the host plus the resources allocated to
the virtual machine of the host itself.</para>
<para>The <literal>used_max</literal> row shows the sum
of the resources allocated to the instances
that run on the host.</para>
<note> <para>These values are computed by using only information
about the flavors of the instances that run on the
hosts. This command does not query the CPU usage,
memory usage, or hard disk usage of the physical
host.</para> </note> </step> </procedure>
<procedure xml:id="instance_usage_statistics">
<title>To show instance usage statistics</title>
<step>
<para>Get CPU, memory, I/O, and network statistics for an
<para>The <literal>memory_mb</literal> column shows the sum of the
memory (in MB) allocated to the instances that run on the
host.</para>
<para>The <literal>disk_gb</literal> column shows the sum of the
root and ephemeral disk sizes (in GB) of the instances that
run on the host.</para>
<para>The row that has the value <literal>used_now</literal> in the
<literal>PROJECT</literal> column shows the sum of the
resources allocated to the instances that run on the host,
plus the resources allocated to the virtual machine of the
host itself.</para>
<para>The row that has the value <literal>used_max</literal> row in
the <literal>PROJECT</literal> column shows the sum of the
resources allocated to the instances that run on the
host.</para></listitem>
</itemizedlist>
<note>
<para>These values are computed by using information about the flavors of the
instances that run on the hosts. This command does not query the
CPU usage, memory usage, or hard disk usage of the physical
host.</para>
</note>
</section>
<section xml:id="instance_usage_statistics">
<title>Show instance usage statistics</title>
<itemizedlist>
<listitem><para>Get CPU, memory, I/O, and network statistics for an
instance.</para>
<para>First, list instances:</para>
<orderedlist><listitem><para>List instances:</para>
<screen><prompt>$</prompt> <userinput>nova list</userinput>
<computeroutput>+--------------------------------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+--------------------------------------+----------------------+--------+------------+-------------+------------------+
| 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 |
| 8a99547e-7385-4ad1-ae50-4ecfaaad5f42 | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+--------------------------------------+----------------------+--------+------------+-------------+------------------+</computeroutput></screen>
<para>Then, get diagnostic statistics:</para>
+--------------------------------------+----------------------+--------+------------+-------------+------------------+</computeroutput></screen></listitem>
<listitem><para>Get diagnostic statistics:</para>
<screen><prompt>$</prompt> <userinput>nova diagnostics myCirrosServer</userinput>
<computeroutput>+------------------+----------------+
| Property | Value |
@ -91,9 +101,8 @@
| vnet1_rx_packets | 5485 |
| vda_read_req | 0 |
| vda_errors | -1 |
+------------------+----------------+</computeroutput></screen>
</step>
<step> <para>Get summary statistics for each tenant:</para>
+------------------+----------------+</computeroutput></screen></listitem></orderedlist></listitem>
<listitem><para>Get summary statistics for each tenant:</para>
<screen><prompt>$</prompt> <userinput>nova usage-list</userinput>
<computeroutput>Usage from 2013-06-25 to 2013-07-24:
+----------------------------------+-----------+--------------+-----------+---------------+
@ -101,7 +110,6 @@
+----------------------------------+-----------+--------------+-----------+---------------+
| b70d90d65e464582b6b2161cf3603ced | 1 | 344064.44 | 672.00 | 0.00 |
| 66265572db174a7aa66eba661f58eb9e | 3 | 671626.76 | 327.94 | 6558.86 |
+----------------------------------+-----------+--------------+-----------+---------------+</computeroutput></screen>
</step>
</procedure>
+----------------------------------+-----------+--------------+-----------+---------------+</computeroutput></screen></listitem></itemizedlist>
</section>
</section>

View File

@ -6,35 +6,30 @@
<title>Manage IP addresses</title>
<para>Each instance can have a private, or fixed, IP address and a
public, or floating, one.</para>
<para>Private IP addresses are used for communication between
instances, and public ones are used for communication with the
outside world.</para>
<para>Private IP addresses are used for communication between instances, and
public ones are used for communication with networks outside the cloud,
including the Internet.</para>
<para>When you launch an instance, it is automatically assigned a
private IP address that stays the same until you explicitly
terminate the instance. Rebooting an instance has no effect on
the private IP address.</para>
<para>A pool of floating IPs, configured by the cloud operator, is
available in OpenStack Compute.</para>
<para>You can allocate a certain number of these to a project: The
maximum number of floating IP addresses per project is defined
by the quota.</para>
<para>You can add a floating IP address from this set to an
instance of the project. Floating IP addresses can be
dynamically disassociated and associated with other instances
of the same project at any time.</para>
<para>Before you can assign a floating IP address to an instance,
you first must allocate floating IPs to a project. After
floating IP addresses have been allocated to the current
project, you can assign them to running instances.</para>
<para>You can assign a floating IP address to one instance at a
time.</para>
<para>A pool of floating IP addresses, configured by the cloud operator, is
available in OpenStack Compute. You can allocate a certain number of
these IP addresses to a project. The maximum number of floating IP
addresses per project is defined by the quota.</para>
<para>After you allocate floating IP addresses to a project, you can add a
floating IP address from this set to an instance of the project. You can
assign a floating IP address to one instance at a time. Floating IP
addresses can be disassociated from an instance and associated with
another instance of the same project at any time.</para>
<section xml:id="floating_ips_proc">
<title>List floating IP address information</title>
<procedure>
<step>
<para>To list all floating IP addresses:</para>
<screen><prompt>$</prompt> <userinput>nova floating-ip-bulk-list</userinput></screen>
<screen><computeroutput>+------------+---------------+---------------+--------+-----------+
<itemizedlist>
<listitem>
<para>To list all floating IP addresses, run the following
command:</para>
<screen><prompt>$</prompt> <userinput>nova floating-ip-bulk-list</userinput>
<computeroutput>+------------+---------------+---------------+--------+-----------+
| project_id | address | instance_uuid | pool | interface |
+------------+---------------+---------------+--------+-----------+
| None | 172.24.4.225 | None | public | eth0 |
@ -58,10 +53,10 @@
| None | 192.168.253.5 | None | test | eth0 |
| None | 192.168.253.6 | None | test | eth0 |
+------------+---------------+---------------+--------+-----------+</computeroutput></screen>
</step>
<step>
<para>To list all pools that provide floating IP
addresses:</para>
</listitem>
<listitem>
<para>To list all pools that provide floating IP addresses, run
the following command:</para>
<screen><prompt>$</prompt> <userinput>nova floating-ip-pool-list</userinput></screen>
<screen><computeroutput>+--------+
| name |
@ -69,20 +64,20 @@
| public |
| test |
+--------+</computeroutput></screen>
</step>
</procedure>
</listitem>
</itemizedlist>
</section>
<section xml:id="floating_ip_allocate">
<title>Assign floating IP addresses</title>
<para>You can assign floating IP addresses to a project or an
<para>You can assign floating IP addresses to a project and to an
instance.</para>
<procedure>
<step>
<para>Allocate a floating IP address to the current
project. If more than one IP address pool is
available, you can specify the pool from which to
allocate the IP address. This example specifies
the <literal>public</literal> pool:</para>
<para>Run the following command to allocate a floating IP
address to the current project. If more than one IP address
pool is available, you can specify the pool from which to
allocate the IP address. This example specifies the
<literal>public</literal> pool:</para>
<screen><prompt>$</prompt> <userinput>nova floating-ip-create public</userinput></screen>
<screen><computeroutput>+--------------+-------------+----------+--------+
| Ip | Instance Id | Fixed Ip | Pool |
@ -91,20 +86,9 @@
+--------------+-------------+----------+--------+</computeroutput></screen>
</step>
<step>
<para>To release a floating IP address from the
current project:</para>
<screen><prompt>$</prompt> <userinput>nova floating-ip-delete <replaceable>FLOATING_IP</replaceable></userinput></screen>
<para>The IP address is returned to the pool of IP
addresses that are available for all projects. If
an IP address is assigned to a running instance,
it is disassociated from the instance.</para>
</step>
<step>
<para>To associate an IP address with an instance, at
least one floating IP address must be allocated to
the current project.</para>
<para>To assign a floating IP address to an
instance:</para>
<para>After at least one floating IP address is allocated to the
project, assign an IP address to an instance in the project,
as follows:</para>
<screen><prompt>$</prompt> <userinput>nova add-floating-ip <replaceable>INSTANCE_NAME_OR_ID</replaceable> <replaceable>FLOATING_IP</replaceable></userinput></screen>
<para>After you assign the IP address and configure
security group rules for the instance, the
@ -112,11 +96,20 @@
address.</para>
</step>
<step>
<para>To remove a floating IP address from an
instance, specify the same arguments that
you used to assign the IP address:</para>
<para>To remove a floating IP address from an instance, specify
the same arguments that you used to assign the IP address,
but run the following command:</para>
<screen><prompt>$</prompt> <userinput>nova remove-floating-ip <replaceable>INSTANCE_NAME_OR_ID</replaceable> <replaceable>FLOATING_IP</replaceable></userinput></screen>
</step>
<step>
<para>To release a floating IP address from the current project,
run the following command:</para>
<screen><prompt>$</prompt> <userinput>nova floating-ip-delete <replaceable>FLOATING_IP</replaceable></userinput></screen>
<para>The IP address is returned to the pool of IP addresses
that are available for all projects. If an IP address is
assigned to a running instance, it is disassociated from the
instance.</para>
</step>
</procedure>
</section>
</section>

View File

@ -4,8 +4,15 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="cli_manage_instances">
<title>Manage instances and hosts</title>
<para>Instances are virtual machines that run inside the
cloud.</para>
<para>Instances are virtual machines that run inside the cloud on
physical compute nodes. The Compute service manages instances.
A host is the node on which a group of instances
resides.</para>
<para>This section describes how to perform the different tasks
involved in instance management, such as adding floating IP
addresses, stopping and starting instances, and terminating
instances. This section also discusses node management
tasks.</para>
<xi:include href="section_cli_nova_floating_ips.xml"/>
<xi:include href="../common/section_cli_nova_resizerebuild.xml"/>
<xi:include href="../common/section_cli_nova_search_ip.xml"/>