openstack-manuals/doc/user-guide/section_dashboard_manage_volumes.xml
Christian Berendt 6be4f5775f Unified the syntax of the XML root element (user-guide)
The XML root element of Docbook XML files should match the following
format:

<ELEMENT 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="THE_XML_ID_OF_THE_ELEMENT">

Change-Id: Ic59684221ba99632c71e3f9b5f97ec74f56793a4
2014-07-09 19:51:07 +02:00

268 lines
11 KiB
XML

<?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="dashboard_manage_volumes">
<title>Create and manage volumes</title>
<?dbhtml stop-chunking?>
<para>Volumes are block storage devices that you attach to
instances to enable persistent storage. You can attach a
volume to a running instance or detach a volume and attach it
to another instance at any time. You can also create a
snapshot from or delete a volume. Only administrative users
can create volume types.</para>
<section xml:id="dashboard_create_volumes">
<title>Create a volume</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click <guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Click <guibutton>Create Volume</guibutton>.</para>
<para>In the dialog box that opens, enter or select
the following values.</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
<col width="70%"/>
<tbody>
<tr>
<td>
<para>
<guilabel>Volume Name</guilabel>
</para>
</td>
<td>
<para>Specify a name for the
volume.</para>
</td>
</tr>
<tr>
<td>
<para>
<guilabel>Description</guilabel>
</para>
</td>
<td>
<para>Optionally, provide a brief description for the
volume.</para>
</td>
</tr>
<tr>
<td>
<para>
<guilabel>Type</guilabel>
</para>
</td>
<td>
<para>Leave this field blank.</para>
</td>
</tr>
<tr>
<td>
<para>
<guilabel>Size (GB)</guilabel>
</para>
</td>
<td>
<para>The size of the volume in
gigabytes.</para>
</td>
</tr>
<tr>
<td>
<para>
<guilabel>Volume Source</guilabel>
</para>
</td>
<td>
<para>Select one of the following options:</para>
<variablelist>
<varlistentry>
<term><guilabel>No source, empty volume</guilabel></term>
<listitem><para>Creates an empty volume.</para>
<note><para>An empty volume does not contain a file
system or a partition table.</para></note></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Snapshot</guilabel></term>
<listitem><para>If you choose this option, a new field
for <guilabel>Use snapshot as a source</guilabel>
displays. You can select the snapshot from the list.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Image</guilabel></term>
<listitem><para>If you choose this option, a new field
for <guilabel>Use image as a source</guilabel>
displays. You can select the image from the list.</para>
<para>Select the <guilabel>Availability Zone</guilabel>
from the list. 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>). For some cases, it
could be <literal>nova</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Volume</guilabel></term>
<listitem><para>If you choose this option, a new field
for <guilabel>Use volume as a source</guilabel>
displays. You can select the volume from the list.
</para></listitem>
</varlistentry>
</variablelist>
<note><para>Options to use a snapshot or a volume as the
source for a volume are displayed only if there are
existing snapshots or volumes.</para>
</note>
</td>
</tr>
</tbody>
</informaltable>
</step>
<step>
<para>Click <guibutton>Create Volume</guibutton>.</para>
</step>
</procedure>
<para>The dashboard shows the volume on the
<guilabel>Volumes</guilabel> tab.</para>
</section>
<section xml:id="attach_volumes_to_instances">
<title>Attach a volume to an instance</title>
<para>After you create one or more volumes, you can attach them to
instances. You can attach a volume to one instance at a time.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and click
<guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Select the volume to add to an instance and click
<guibutton>Edit Attachments</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Manage Volume Attachments</guilabel> dialog box,
select an instance.</para>
</step>
<step>
<para>Enter the name of the device from which the volume is
accessible by the instance.</para>
<note>
<para>The actual device name might differ from the volume name
because of hypervisor settings.</para>
</note>
</step>
<step>
<para>Click <guibutton>Attach Volume</guibutton>.</para>
<para>The dashboard shows the instance to which the
volume is now attached and the device name.</para>
</step>
</procedure>
<para>You can view the status of a volume in the <guilabel>Volumes</guilabel>
tab of the dashboard. The volume is either Available or In-Use.</para>
<para>Now you can log in to the instance and mount, format, and use the
disk.</para>
</section>
<section xml:id="dashboard_detach_volume">
<title>Detach a volume from an instance</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and click
<guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Select the volume and click <guibutton>Edit Attachments</guibutton>.</para>
</step>
<step>
<para>Click <guibutton>Detach Volume</guibutton> and confirm your
changes.</para>
</step>
</procedure>
<para>A message indicates whether the action was successful.</para>
</section>
<section xml:id="create_volume_snapsnots">
<title>Create a snapshot from a volume</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and click
<guilabel>Volumes</guilabel>.</para>
</step>
<step>
<para>Select a volume from which to create a snapshot.</para>
</step>
<step>
<para>From the <guilabel>More</guilabel> list, select
<guilabel>Create Snapshot</guilabel>.</para>
</step>
<step>
<para>In the dialog box that opens, enter a snapshot name and a
brief description.</para>
</step>
<step>
<para>Confirm your changes.</para>
<para>The dashboard shows the new volume snapshot in
<guilabel>Volume Snapshots</guilabel> tab.</para>
</step>
</procedure>
</section>
<section xml:id="dashboard_edit_volume">
<title>Edit a volume</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and click
<guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>From the <guilabel>CURRENT PROJECT</guilabel> on the
<guilabel>Project</guilabel> tab, select the appropriate
project.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click
<guilabel>Volumes</guilabel>.</para>
</step>
<step>
<para>Select the image that you want to edit.</para>
</step>
<step>
<para>In the <guilabel>Actions</guilabel> column, click
<guilabel>Edit Volume</guilabel>.</para>
</step>
<step>
<para>In the <guilabel>Edit Volume</guilabel> dialog box, update the
name and description of the image.</para>
</step>
<step>
<para>Click <guibutton>Edit Volume</guibutton>.</para>
</step>
</procedure>
<note>
<para>You can extend a volume by using the <guilabel>Extend Volume</guilabel>
option available in the <guibutton>More</guibutton> dropdown list
and entering the new value for volume size.</para>
</note>
</section>
<section xml:id="dashboard_delete_volume">
<title>Delete a volume</title>
<para>When you delete an instance, the data in its attached
volumes is not destroyed.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click <guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Select the check boxes for the volumes that you
want to delete.</para>
</step>
<step>
<para>Click <guibutton>Delete Volumes</guibutton> and
confirm your choice.</para>
<para>A message indicates whether the action was
successful.</para>
</step>
</procedure>
</section>
</section>