openstack/openstack-manuals
Code Issues Proposed changes
689774bd69
openstack-manuals/doc/user-guide/section_cli_nova_baremetal.xml
Christian Berendt dcb8fa287e Standardize usage of client arguments (user-guide) 
Like documented at https://wiki.openstack.org/wiki/Documentation/Conventions#Client_arguments:_.22--option_ARGUMENT.22
we prefer to use '--option ARGUMENT'.

Change-Id: If0a33ca02cd499769d1540b74b1ab0a217c839d4
2014-09-08 12:59:08 +02:00

154 lines
8.5 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<section 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"
xml:id="baremetal">
<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>
</listitem>
<listitem>
<para><command>baremetal-interface-list</command>. Lists network
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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
</itemizedlist>
<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, user name, 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 user name
<systemitem class="username">ipmi</systemitem>, 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 |
| pm_address | 1.2.3.4 |
| interfaces | [] |
| prov_vlan_id | None |
| cpus | 1 |
| memory_mb | 512 |
| prov_mac_address | aa:bb:cc:dd:ee:ff |
| service_host | ubuntu |
| local_gb | 10 |
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+-------------------+</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></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>
<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 |
| pm_address | 1.2.3.4 |
| interfaces |
[{u'datapath_id': u'0', u'id': 1, u'port_no': 0, u'address': u'aa:bb:cc:dd:ee:ff'}] |
| prov_vlan_id | None |
| cpus | 1 |
| memory_mb | 512 |
| prov_mac_address | aa:bb:cc:dd:ee:ff |
| service_host | ubuntu |
| local_gb | 10 |
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+--------------------------------------+</computeroutput></screen></section>
</section>
View Git Blame Copy Permalink