openstack-manuals/doc/common/section_cli_nova_boot_from_volume.xml
Lars Kellogg-Stedman c349164592 make nova boot command match data from prior example
This patches the "Create volume from image and boot instance"
instructions such that the "nova boot" command in step 4 uses an image
id from the "nova image-list" command in step 1.  This will help avoid
confusion as to where exactly that id is coming from.

Change-Id: I9e11851beaa7548cd8c366f3b6d26d318b42e1a8
2015-03-20 10:09:07 -04:00

334 lines
20 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section [
<!ENTITY % openstack SYSTEM "entities/openstack.ent">
%openstack;
]>
<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="boot_from_volume">
<title>Launch an instance from a volume</title>
<para>You can boot instances from a volume instead of an image.</para>
<para>To complete these tasks, use these parameters on the nova
<command>boot</command> command:</para>
<informaltable rules="all">
<col width="30%"/>
<col width="30%"/>
<col width="30%"/>
<thead>
<tr>
<th>Task</th>
<th>nova boot parameter</th>
<th>See</th>
</tr>
</thead>
<tbody>
<tr>
<td>Boot an instance from an image and attach a non-bootable
volume.</td>
<td><parameter>--block-device</parameter></td>
<td><xref linkend="attach_volume_to_instance"/></td>
</tr>
<tr>
<td>Create a volume from an image and boot an instance from
that volume.</td>
<td><parameter>--block-device</parameter></td>
<td><xref linkend="create_volume_from_image_and_boot"/></td>
</tr>
<tr>
<td>Boot from an existing source image, volume, or
snapshot.</td>
<td><parameter>--block-device</parameter></td>
<td><xref linkend="create_volume_from_image_and_boot"/></td>
</tr>
<tr>
<td>Attach a swap disk to an instance.</td>
<td>
<parameter>--swap</parameter></td>
<td><xref linkend="attach-disk-to-instance"/></td>
</tr>
<tr>
<td>Attach an ephemeral disk to an instance.</td>
<td><parameter>--ephemeral</parameter></td>
<td><xref linkend="attach-disk-to-instance"/></td>
</tr>
</tbody>
</informaltable>
<note>
<para>To attach a volume to a running instance, see <xref
linkend="cli_attach_volume"/>.</para>
</note>
<section xml:id="attach_volume_to_instance">
<title>Boot instance from image and attach non-bootable
volume</title>
<para>Create a non-bootable volume and attach that volume to an
instance that you boot from an image.</para>
<para>To create a non-bootable volume, do not create it from an
image. The volume must be entirely empty with no partition table
and no file system.</para>
<procedure>
<step>
<para>Create a non-bootable volume:</para>
<screen><prompt>$</prompt> <userinput>cinder create --display-name my-volume 8</userinput>
<computeroutput>+--------------------------------+--------------------------------------+
| Property | Value |
+--------------------------------+--------------------------------------+
| attachments | [] |
| availability_zone | nova |
| bootable | false |
| created_at | 2014-05-09T16:33:11.000000 |
| description | None |
| encrypted | False |
| id | d620d971-b160-4c4e-8652-2513d74e2080 |
| metadata | {} |
| name | my-volume |
| os-vol-host-attr:host | None |
| os-vol-mig-status-attr:migstat | None |
| os-vol-mig-status-attr:name_id | None |
| os-vol-tenant-attr:tenant_id | ccef9e62b1e645df98728fb2b3076f27 |
| size | 8 |
| snapshot_id | None |
| source_volid | None |
| status | creating |
| user_id | fef060ae7bfd4024b3edb97dff59017a |
| volume_type | None |
+--------------------------------+--------------------------------------+</computeroutput></screen>
</step>
<step>
<para>List volumes:</para>
<screen><prompt>$</prompt> <userinput>cinder list</userinput>
<computeroutput>+--------------------------------------+-----------+-----------+------+-------------+----------+-------------+
| ID | Status | Name | Size | Volume Type | Bootable | Attached to |
+--------------------------------------+-----------+-----------+------+-------------+----------+-------------+
| d620d971-b160-4c4e-8652-2513d74e2080 | available | my-volume | 8 | None | false | |
+--------------------------------------+-----------+-----------+------+-------------+----------+-------------+</computeroutput></screen>
</step>
<step xml:id="launch_image_with_attached_volume">
<para>Boot an instance from an image and attach the empty
volume to the instance:</para>
<screen><prompt>$</prompt> <userinput>nova boot --flavor 2 --image 98901246-af91-43d8-b5e6-a4506aa8f369 \
--block-device source=volume,id=d620d971-b160-4c4e-8652-2513d74e2080,dest=volume,shutdown=preserve \
myInstanceWithVolume</userinput>
<computeroutput>+--------------------------------------+----------------------------------------------------------------+
| Property | Value |
+--------------------------------------+----------------------------------------------------------------+
| OS-DCF:diskConfig | MANUAL |
| OS-EXT-AZ:availability_zone | nova |
| OS-EXT-SRV-ATTR:host | - |
| OS-EXT-SRV-ATTR:hypervisor_hostname | - |
| OS-EXT-SRV-ATTR:instance_name | instance-00000004 |
| OS-EXT-STS:power_state | 0 |
| OS-EXT-STS:task_state | scheduling |
| OS-EXT-STS:vm_state | building |
| OS-SRV-USG:launched_at | - |
| OS-SRV-USG:terminated_at | - |
| accessIPv4 | |
| accessIPv6 | |
| adminPass | ZaiYeC8iucgU |
| config_drive | |
| created | 2014-05-09T16:34:50Z |
| flavor | m1.small (2) |
| hostId | |
| id | 1e1797f3-1662-49ff-ae8c-a77e82ee1571 |
| image | cirros-0.3.1-x86_64-uec (98901246-af91-43d8-b5e6-a4506aa8f369) |
| key_name | - |
| metadata | {} |
| name | myInstanceWithVolume |
| os-extended-volumes:volumes_attached | [{"id": "d620d971-b160-4c4e-8652-2513d74e2080"}] |
| progress | 0 |
| security_groups | default |
| status | BUILD |
| tenant_id | ccef9e62b1e645df98728fb2b3076f27 |
| updated | 2014-05-09T16:34:51Z |
| user_id | fef060ae7bfd4024b3edb97dff59017a |
+--------------------------------------+----------------------------------------------------------------+</computeroutput></screen>
</step>
</procedure>
</section>
<section xml:id="create_volume_from_image_and_boot">
<title>Create volume from image and boot instance</title>
<para>You can create a volume from an existing image, volume, or
snapshot. This procedure shows you how to create a volume from
an image, and use the volume to boot an instance.</para>
<procedure>
<step>
<para>List the available images:</para>
<screen><prompt>$</prompt> <userinput>nova image-list</userinput>
<computeroutput>+--------------------------------------+---------------------------------+--------+--------+
| ID | Name | Status | Server |
+--------------------------------------+---------------------------------+--------+--------+
| 484e05af-a14d-4567-812b-28122d1c2260 | Fedora-x86_64-20-20131211.1-sda | ACTIVE | |
| 98901246-af91-43d8-b5e6-a4506aa8f369 | cirros-0.3.1-x86_64-uec | ACTIVE | |
| b6e95589-7eb2-4171-8bab-d225d9262c73 | cirros-0.3.1-x86_64-uec-kernel | ACTIVE | |
| c90893ea-e732-40ac-a23d-4e36b2082c35 | cirros-0.3.1-x86_64-uec-ramdisk | ACTIVE | |
+--------------------------------------+---------------------------------+--------+--------+</computeroutput></screen>
<para>Note the ID of the image that you want to use to create
a volume.</para>
</step>
<step>
<para>List the available flavors:</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 | 1 | 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>
<para>Note the ID of the flavor that you want to use to create
a volume.</para>
</step>
<step>
<para>To create a bootable volume from an image and launch an
instance from this volume, use the
<parameter>--block-device</parameter> parameter.</para>
<para>For example:</para>
<screen><prompt>$</prompt> <userinput>nova boot --flavor <replaceable>FLAVOR</replaceable> --block-device source=<replaceable>SOURCE</replaceable>,id=<replaceable>ID</replaceable>,dest=<replaceable>DEST</replaceable>,size=<replaceable>SIZE</replaceable>,shutdown=<replaceable>PRESERVE</replaceable>,bootindex=<replaceable>INDEX</replaceable> <replaceable>NAME</replaceable></userinput></screen>
<para>The parameters are:</para>
<itemizedlist>
<listitem>
<para><parameter>--flavor</parameter>
<replaceable>FLAVOR</replaceable>. The flavor ID or
name.</para>
</listitem>
<listitem>
<para><parameter>--block-device</parameter>
source=<replaceable>SOURCE</replaceable>,id=<replaceable>ID</replaceable>,dest=<replaceable>DEST</replaceable>,size=<replaceable>SIZE</replaceable>,shutdown=<replaceable>PRESERVE</replaceable>,bootindex=<replaceable>INDEX</replaceable></para>
<variablelist>
<varlistentry>
<term><emphasis role="bold"
>source=<replaceable>SOURCE</replaceable></emphasis></term>
<listitem>
<para>The type of object used to create the block
device. Valid values are
<literal>volume</literal>,
<literal>snapshot</literal>,
<literal>image</literal>, and
<literal>blank</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold"
>id=<replaceable>ID</replaceable></emphasis></term>
<listitem>
<para>The ID of the source object.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold"
>dest=<replaceable>DEST</replaceable></emphasis></term>
<listitem>
<para>The type of the target virtual device. Valid
values are <literal>volume</literal> and
<literal>local</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold"
>size=<replaceable>SIZE</replaceable></emphasis></term>
<listitem>
<para>The size of the volume that is created.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold"
>shutdown={preserve|remove}</emphasis></term>
<listitem>
<para>What to do with the volume when the instance
is deleted. <literal>preserve</literal> does not
delete the volume. <literal>remove</literal>
deletes the volume.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold"
>bootindex=<replaceable>INDEX</replaceable></emphasis></term>
<listitem>
<para>Orders the boot disks. Use
<literal>0</literal> to boot from this
volume.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<para><replaceable>NAME</replaceable>. The name for the
server.</para>
</listitem>
</itemizedlist>
</step>
<step xml:id="launch_image_from_volume">
<para>Create a bootable volume from an image, before the
instance boots. The volume is not deleted when the instance
is terminated:</para>
<screen><prompt>$</prompt> <userinput>nova boot --flavor 2 \
--block-device source=image,id=484e05af-a14d-4567-812b-28122d1c2260,dest=volume,size=10,shutdown=preserve,bootindex=0 \
myInstanceFromVolume</userinput>
<computeroutput>+--------------------------------------+-------------------------------------------------+
| Property | Value |
+--------------------------------------+-------------------------------------------------+
| OS-EXT-STS:task_state | scheduling |
| image | Attempt to boot from volume - no image supplied |
| OS-EXT-STS:vm_state | building |
| OS-EXT-SRV-ATTR:instance_name | instance-00000003 |
| OS-SRV-USG:launched_at | None |
| flavor | m1.small |
| id | 2e65c854-dba9-4f68-8f08-fe332e546ecc |
| security_groups | [{u'name': u'default'}] |
| user_id | 352b37f5c89144d4ad0534139266d51f |
| OS-DCF:diskConfig | MANUAL |
| accessIPv4 | |
| accessIPv6 | |
| progress | 0 |
| OS-EXT-STS:power_state | 0 |
| OS-EXT-AZ:availability_zone | nova |
| config_drive | |
| status | BUILD |
| updated | 2014-02-02T13:29:54Z |
| hostId | |
| OS-EXT-SRV-ATTR:host | None |
| OS-SRV-USG:terminated_at | None |
| key_name | None |
| OS-EXT-SRV-ATTR:hypervisor_hostname | None |
| name | myInstanceFromVolume |
| adminPass | TzjqyGsRcJo9 |
| tenant_id | f7ac731cc11f40efbc03a9f9e1d1d21f |
| created | 2014-02-02T13:29:53Z |
| os-extended-volumes:volumes_attached | [] |
| metadata | {} |
+--------------------------------------+-------------------------------------------------+</computeroutput></screen>
</step>
<step>
<para>List volumes to see the bootable volume and its attached
<literal>myInstanceFromVolume</literal> instance:</para>
<screen><prompt>$</prompt> <userinput>cinder list</userinput>
<computeroutput>+--------------------------------------+--------+--------------+------+-------------+----------+--------------------------------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+--------------------------------------+--------+--------------+------+-------------+----------+--------------------------------------+
| 2fff50ab-1a9c-4d45-ae60-1d054d6bc868 | in-use | | 10 | None | true | 2e65c854-dba9-4f68-8f08-fe332e546ecc |
+--------------------------------------+--------+--------------+------+-------------+----------+--------------------------------------+</computeroutput></screen>
</step>
</procedure>
</section>
<section xml:id="attach-disk-to-instance">
<title>Attach swap or ephemeral disk to an instance</title>
<para>Use the nova <command>boot</command>
<parameter>--swap</parameter> parameter to attach a swap disk on
boot or the nova <command>boot</command>
<parameter>--ephemeral</parameter> parameter to attach an
ephemeral disk on boot. When you terminate the instance, both
disks are deleted.</para>
<para>Boot an instance with a 512&nbsp;MB swap disk and 2&nbsp;GB
ephemeral disk:</para>
<screen><prompt>$</prompt> <userinput>nova boot --flavor <replaceable>FLAVOR</replaceable> --image <replaceable>IMAGE_ID</replaceable> --swap 512 --ephemeral size=2 <replaceable>NAME</replaceable></userinput></screen>
<note>
<para>The flavor defines the maximum swap and ephemeral disk
size. You cannot exceed these maximum values.</para>
</note>
</section>
</section>