openstack/openstack-manuals
Code Issues Proposed changes

Updated 'Launch instances' section in the End User Guide

Browse Source 
Included the new options available in the Launch an Instance window for
launching an instance in the Dashboard chapter of End User Guide. Also removed
link to the 'launch instance from volume' section as the steps seems redundant.

Add a .htacces redirection to handle the removed file (boot from
volume).

Partial-Bug: #1279133

Change-Id: I7f29aa45211d84e2dfab772235891a776492686d
This commit is contained in:
Deepti Navale 2014-03-03 15:06:03 +10:00 committed by Gauvain Pocentek
parent 5f9d27892c
commit 394538384b
4 changed files with 118 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/user-guide/section_dashboard_launch_instances.xml
View File

@ -13,19 +13,15 @@
<title>Launch and manage instances</title> <title>Launch and manage instances</title>
<para>Instances are virtual machines that run inside the <para>Instances are virtual machines that run inside the
cloud.</para> cloud.</para>
<para>You can <link <para>You can <link linkend="dashboard_launch_instances_from_image">launch
linkend="dashboard_launch_instances_from_image">launch an an instance</link> from various sources. The OpenStack
instance from an OpenStack image</link>. The OpenStack
Image Service provides a pool of images that are accessible to Image Service provides a pool of images that are accessible to
members of different projects.</para> members of different projects.</para>
<para>You can also <link <para>You can also launch an instance from an image that you have copied to
linkend="dashboard_launch_instances_from_volume">launch an a persistent volume. The instance boots from the volume, which is provided
instance from an image that you have copied to a by <systemitem class="service">cinder-volume</systemitem> through iSCSI.
persistent volume</link>. The instance boots from the When you launch an instance from a volume, especially note the following
volume, which is provided by <systemitem class="service" steps:</para>
>cinder-volume</systemitem> through iSCSI. When you launch
an instance from a volume, especially note the following
steps:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>To select from which volume to boot, launch an <para>To select from which volume to boot, launch an
@ -47,9 +43,6 @@
<xi:include <xi:include
href="section_dashboard_launch_instances_from_image.xml"/> href="section_dashboard_launch_instances_from_image.xml"/>
<?hard-pagebreak?> <?hard-pagebreak?>
<xi:include
href="section_dashboard_launch_instances_from_volume.xml"/>
<?hard-pagebreak?>
<section xml:id="ssh-into-instance"> <section xml:id="ssh-into-instance">
<title>SSH in to your instance</title> <title>SSH in to your instance</title>
<para>To SSH into your instance, you use the downloaded <para>To SSH into your instance, you use the downloaded

140
doc/user-guide/section_dashboard_launch_instances_from_image.xml
View File

@ -9,7 +9,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="dashboard_launch_instances_from_image"> xml:id="dashboard_launch_instances_from_image">
<title>Launch an instance from an image</title> <title>Launch an instance</title>
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<para>When you launch an instance from an image, OpenStack creates <para>When you launch an instance from an image, OpenStack creates
a local copy of the image on the compute node where the a local copy of the image on the compute node where the
@ -22,6 +22,10 @@
<para>The dashboard shows the images that have been <para>The dashboard shows the images that have been
uploaded to OpenStack Image Service and are available uploaded to OpenStack Image Service and are available
for this project.</para> for this project.</para>
<para>For details on creating images, see <link
xlink:href="http://docs.openstack.org/image-guide/content/ch_creating_images_manually.html">
Creating images manually</link> in the <citetitle>OpenStack Virtual
Machine Image Guide</citetitle>.</para>
</step> </step>
<step> <step>
<para>Select an image and click <para>Select an image and click
@ -30,10 +34,10 @@
<step> <step>
<para>In the <guilabel>Launch Instance</guilabel> window, <para>In the <guilabel>Launch Instance</guilabel> window,
specify the following values:</para> specify the following values:</para>
<informaltable rules="all"> <informaltable rules="all" width="75%">
<col width="30%"/> <col width="30%"/>
<col width="70%"/> <col width="70%"/>
<thead> <thead>
<tr> <tr>
<th colspan="2" align="center" <th colspan="2" align="center"
><guilabel>Details</guilabel> tab</th> ><guilabel>Details</guilabel> tab</th>
@ -41,15 +45,29 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><para><guilabel>Instance <td><para><guilabel>Availability Zone</guilabel></para></td>
Source</guilabel></para></td> <td>
<td><para>Image or snapshot.</para></td> <para>By default, this value is set to the availability
zone given by the cloud provider (for example,
<literal>us-west</literal> or <literal>apac-south</literal>).
Though, it could be <literal>nova</literal> for most cases.
</para>
</td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Instance <td><para><guilabel>Instance Name</guilabel></para></td>
Name</guilabel></para></td> <td><para>The name to assign to the virtual machine.
<td><para>The name to assign to the virtual </para>
machine.</para></td> <note>
<para>The name you assign here becomes the initial host
name of the server. After the server is built, if you
change the server name in the API or change the host
name directly, the names are not updated in the dashboard.</para>
<para>Server names are not guaranteed to be unique when
created so you could have two instances with the same
host name.</para>
</note>
</td>
</tr> </tr>
<tr> <tr>
<td> <td>
@ -64,6 +82,76 @@
a value greater than 1. Default is 1. a value greater than 1. Default is 1.
</para></td> </para></td>
</tr> </tr>
<tr>
<td>
<para>
<guilabel>Instance Boot Source</guilabel>
</para>
</td>
<td><para>Your options are:</para>
<itemizedlist>
<listitem>
<para>
<guilabel>Boot from image</guilabel> - If you choose
this option, a new field for <guilabel>Image Name</guilabel>
displays. You can select the image from the
dropdown list.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from snapshot</guilabel> - If you
choose this option, a new field for <guilabel>Instance Snapshot</guilabel>
displays. You can select the snapshot from
the dropdown list.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from volume</guilabel> - If you
choose this option, a new field for <guilabel>Volume</guilabel>
displays. You can select the volume from the
dropdown list.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from image (creates a new volume)
</guilabel> - With this option, you can boot from
an image and create a volume by entering the <guilabel>Device Size</guilabel>
and <guilabel>Device Name</guilabel> for your
volume.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from volume snapshot (creates a new
volume)</guilabel> - Using this option, you can
boot from a volume snapshot and create a new
volume by choosing <guilabel>Volume Snapshot</guilabel>
from a dropdown list and adding a <guilabel>Device Name</guilabel>
for your volume.
</para>
</listitem>
</itemizedlist>
<para>Since you are launching an instance from an image,
<guilabel>Boot from image</guilabel> is chosen by
default.</para>
</td>
</tr>
<tr>
<td>
<para>
<guilabel>Image Name</guilabel>
</para>
</td>
<td>
<para>This field changes based on your previous selection.
Since you have chosen to launch an instance using an image,
the <guilabel>Image Name</guilabel> field displays.
Select the image name from the dropdown list.</para>
</td>
</tr>
<tr> <tr>
<th colspan="2" align="center" <th colspan="2" align="center"
><guilabel>Access &amp; ><guilabel>Access &amp;
@ -71,7 +159,7 @@
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Keypair</guilabel></para></td> <td><para><guilabel>Keypair</guilabel></para></td>
<td><para>A keypair.</para> <td><para>Select a keypair from the dropdown list.</para>
<para>In case an image uses a static root <para>In case an image uses a static root
password or a static key set (neither password or a static key set (neither
is recommended), you do not need to is recommended), you do not need to
@ -81,7 +169,6 @@
<tr> <tr>
<td><para><guilabel>Security <td><para><guilabel>Security
Groups</guilabel></para></td> Groups</guilabel></para></td>
<td><para>Activate the security groups that <td><para>Activate the security groups that
you want to assign to the you want to assign to the
instance.</para> instance.</para>
@ -98,24 +185,14 @@
</tr> </tr>
<tr> <tr>
<th colspan="2" align="center" <th colspan="2" align="center"
><guilabel>Volume Options</guilabel> ><guilabel>Networking</guilabel>
tab</th> tab</th>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Volume <td><para><guilabel>Selected Networks</guilabel></para></td>
Options</guilabel></para></td> <td><para>To add a network to the instance, click the
<td><para>Not applicable when you launch an <guibutton>+</guibutton> in the <guilabel>Available
instance from an image.</para><para>To Networks</guilabel> field.</para></td>
launch from a volume or volume
snapshot, select the appropriate
option in the <guilabel>Volume
Options</guilabel> drop-down list.
Then, choose the volume or
snapshot.</para>
<para>For information about how to create
a bootable volume, see <xref
linkend="dashboard_launch_instances_from_volume"
/>.</para></td>
</tr> </tr>
<tr> <tr>
<th colspan="2" align="center" <th colspan="2" align="center"
@ -125,9 +202,8 @@
<tr> <tr>
<td><para><guilabel>Customization <td><para><guilabel>Customization
Script</guilabel></para></td> Script</guilabel></para></td>
<td><para>A customization script that runs <td><para>A customization script that runs after your
after your instance instance launches.</para></td>
launches.</para></td>
</tr> </tr>
</tbody> </tbody>
</informaltable> </informaltable>

73
doc/user-guide/section_dashboard_launch_instances_from_volume.xml
View File

@ -1,73 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
]>
<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="dashboard_launch_instances_from_volume">
<title>Launch an instance from a volume</title>
<?dbhtml stop-chunking?>
<para>You can launch an instance directly from an image that has
been copied to a persistent volume.</para>
<procedure>
<step>
<para>Create a volume that is large enough to store an
unzipped image.</para>
</step>
<step>
<para>Create an image.</para>
<para>For details, see <link
xlink:href="http://docs.openstack.org/image-guide/content/ch_creating_images_manually.html"
>Creating images manually</link> in the
<citetitle>OpenStack Virtual Machine Image
Guide</citetitle>.</para>
</step>
<step>
<para>Launch an instance.</para>
</step>
<step>
<para>Attach the volume to the instance.</para>
</step>
<step>
<para>Assuming that the attached volume is mounted as
<literal>/dev/vdb</literal>, use one of the
following commands to copy the image to the attached
volume:</para>
<itemizedlist>
<listitem>
<para>For a raw image:</para>
<screen><prompt>$</prompt> <userinput>cat IMAGE >/dev/vdb</userinput></screen>
<para>Alternatively, use
<command>dd</command>.</para>
</listitem>
<listitem>
<para>For a non-raw image:</para>
<screen><prompt>$</prompt> <userinput>qemu-img convert -O raw IMAGE /dev/vdb</userinput></screen>
</listitem>
<listitem>
<para>For a *.tar.bz2 image:</para>
<screen><prompt>$</prompt> <userinput>tar xfjO IMAGE >/dev/vdb</userinput></screen>
</listitem>
</itemizedlist>
</step>
<step>
<para>Because only <emphasis role="italic"
>detached</emphasis> volumes are available for
booting, detach the volume.</para>
</step>
<step>
<para>Now, you can launch an instance from an image
that has been copied to the volume. The
instance is booted from the volume, which is provided
by <systemitem class="service"
>cinder-volume</systemitem> through iSCSI. To launch
an instance from the volume, see <xref
linkend="dashboard_launch_instances_from_image"
/>.</para>
</step>
</procedure>
</section>

3
www/.htaccess
View File

@ -72,6 +72,9 @@ redirectmatch 301 /api/openstack-compute/programmer/content/.*$ /api/quick-start
# Redirect CLI Guide to new End User Guide # Redirect CLI Guide to new End User Guide
redirectmatch 301 /trunk/cli/quick-start/content/.*$ /user-guide/content/ redirectmatch 301 /trunk/cli/quick-start/content/.*$ /user-guide/content/
# Redirecting removed pages from the user guide
redirect 301 /user-guide/content/dashboard_launch_instances_from_volume.html /user-guide/content/dashboard_launch_instances_from_image.html
# Redirect docs.openstack.org index.html subpage pointers to main page # Redirect docs.openstack.org index.html subpage pointers to main page
redirect 301 /install/ / redirect 301 /install/ /
redirect 301 /basic-install/ / redirect 301 /basic-install/ /