openstack/openstack-manuals
Code Issues Proposed changes

Apply review edits to GlusterFS+NFS backend setup

Browse Source 
This patch applies several editorial fixes to the GlusterFS and NFS
backend setup sections. These fixes were part of the editorial review
process in https://review.openstack.org/#/c/74553/ and
https://review.openstack.org/#/c/73931/ (both of which are merged).

Change-Id: I73f823190913acb755b3362e73db70d09e5b3426
Related-Bug: #1281444
Related-Bug: #1280951
This commit is contained in:
Don Domingo 2014-03-05 11:48:41 +10:00
parent ae514e5e9b
commit cbdf37be29
2 changed files with 40 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/admin-guide-cloud/section_glusterfs_backend.xml
View File

@ -2,16 +2,16 @@
<section xml:id="glusterfs_backend" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0">
<title>Configure a GlusterFS backend</title>
<title>Configure a GlusterFS back end</title>
<para>
This section explains how to configure OpenStack Block Storage
to use GlusterFS as a backend. The used GlusterFS shares must
already exist and be accessible from the server hosting the
to use GlusterFS as a back end. You must be able to access the
GlusterFS shares from the server that hosts the
<systemitem class="service">cinder</systemitem> volume
service.
</para>
<note>
<para os="rhel;centos;fedora;opensuse;sles">The
<note>
<para os="rhel;centos;fedora;opensuse;sles">The
<systemitem class="service">cinder</systemitem> volume service
is named <literal>openstack-cinder-volume</literal> on the
following distributions:</para>
@ -27,7 +27,7 @@
<para>In Ubuntu and Debian distributions, the
<systemitem class="service">cinder</systemitem> volume
service is named <literal>cinder-volume</literal>.</para>
</note>
</note>
<para>
Mounting GlusterFS volumes requires utilities and libraries
from the <package>glusterfs-fuse</package> package. This
@ -46,7 +46,7 @@
<link xlink:href="http://gluster.org/community/documentation/index.php/Main_Page">GlusterDocumentation</link>
page.</para>
<procedure>
<title>Configuring GlusterFS for the OpenStack Block Storage</title>
<title>Configure GlusterFS for OpenStack Block Storage</title>
<para>
The GlusterFS server must also be configured accordingly in
order to allow OpenStack Block Storage to use GlusterFS shares:
@ -103,10 +103,10 @@
</step>
</procedure>
<procedure>
<title>Configuring cinder-volume to use GlusterFS</title>
<title>Configure Block Storage to use a GlusterFS back end</title>
<para>
Once the GlusterFS service is configured as needed, perform
the following procedure:
After you configure the GlusterFS service, complete these
steps:
</para>
<step>
<para>
@ -124,7 +124,7 @@
<para>Add an entry to
<filename>/etc/cinder/glusterfs</filename> for each
GlusterFS share that OpenStack Block Storage should use
for backend storage. Each entry should be a separate line,
for back end storage. Each entry should be a separate line,
and should use the following format:</para>
<programlisting><replaceable>HOST</replaceable>:/<replaceable>VOL_NAME</replaceable></programlisting>
<para>
@ -224,8 +224,7 @@ DEFAULT glusterfs_shares_config /etc/cinder/glusterfs</userinput></screen>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/cinder/cinder.conf \
DEFAULT volume_driver cinder.volume.drivers.glusterfs.GlusterfsDriver</userinput></screen>
</step>
<step>
<para>
<step><para>
You can now restart the service to apply the configuration.
</para>
<para os="rhel;centos;fedora;opensuse;sles">To restart the
@ -236,11 +235,10 @@ DEFAULT volume_driver cinder.volume.drivers.glusterfs.GlusterfsDriver</userinput
<para os="debian;ubuntu">To restart the
<systemitem class="service">cinder</systemitem> volume service
on Ubuntu or Debian, run:</para>
<screen os="debian;ubuntu"><prompt>#</prompt> <userinput>service cinder-volume restart</userinput></screen>
</step>
<screen os="debian;ubuntu"><prompt>#</prompt> <userinput>service cinder-volume restart</userinput></screen></step>
</procedure>
<para>OpenStack Block Storage is now configured to use a GlusterFS
backend.</para>
back end.</para>
<note>
<para>
In <filename>/etc/cinder/cinder.conf</filename>, the

51
doc/admin-guide-cloud/section_nfs_backend.xml
View File

@ -2,17 +2,17 @@
<section xml:id="nfs_backend" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0">
<title>Configure an NFS storage backend</title>
<para>This section explains how to configure the
<systemitem>cinder</systemitem> volume service to use NFS storage.
The NFS shares to be used must already exist and be accessible
from the <systemitem>cinder</systemitem> volume service host.
<title>Configure an NFS storage back end</title>
<para>This section explains how to configure OpenStack Block
Storage to use NFS storage. You must be able to access the NFS
shares from the server that hosts the
<systemitem class="service">cinder</systemitem> volume service.
</para>
<note>
<para os="rhel;centos;fedora;opensuse;sles">The
<systemitem>cinder</systemitem> volume service is named
<literal>openstack-cinder-volume</literal> on the following
distributions:</para>
<note>
<para os="rhel;centos;fedora;opensuse;sles">The
<systemitem class="service">cinder</systemitem> volume service
is named <literal>openstack-cinder-volume</literal> on the
following distributions:</para>
<itemizedlist os="rhel;centos;fedora;opensuse;sles">
<listitem os="rhel;centos;fedora"><para>CentOS</para></listitem>
<listitem os="rhel;centos;fedora"><para>Fedora</para></listitem>
@ -23,11 +23,11 @@
</para></listitem>
</itemizedlist>
<para>In Ubuntu and Debian distributions, the
<systemitem>cinder</systemitem> volume service is named
<literal>cinder-volume</literal>.</para>
</note>
<systemitem class="service">cinder</systemitem> volume
service is named <literal>cinder-volume</literal>.</para>
</note>
<procedure>
<title>Configure the cinder volume service to use NFS storage</title>
<title>Configure Block Storage to use an NFS storage back end</title>
<step>
<para>Log in as <systemitem>root</systemitem> to the system
hosting the <systemitem>cinder</systemitem> volume
@ -42,8 +42,9 @@
<step>
<para>
Add an entry to <filename>/etc/cinder/nfsshares</filename>
for each NFS share that the <systemitem>cinder</systemitem>
volume service should use for backend storage. Each entry
for each NFS share that the
<systemitem class="service">cinder</systemitem>
volume service should use for back end storage. Each entry
should be a separate line, and should use the following
format:
</para>
@ -74,7 +75,8 @@
<screen><prompt>#</prompt> <userinput>chmod 0640 /etc/cinder/nfsshares</userinput></screen>
</step>
<step>
<para>Configure the <systemitem>cinder</systemitem>
<para>Configure the
<systemitem class="service">cinder</systemitem>
volume service to use the
<filename>/etc/cinder/nfsshares</filename> file created
earlier. To do so, open the
@ -135,7 +137,8 @@ DEFAULT nfs_mount_options <replaceable>OPTIONS</replaceable></userinput></screen
</para>
</step>
<step>
<para>Configure the <systemitem>cinder</systemitem>
<para>Configure the
<systemitem class="service">cinder</systemitem>
volume service to use the correct volume driver, namely
<literal>cinder.volume.drivers.nfs.NfsDriver</literal>. To
do so, open the
@ -152,20 +155,18 @@ DEFAULT nfs_mount_options <replaceable>OPTIONS</replaceable></userinput></screen
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>openstack-config --set /etc/cinder/cinder.conf \
DEFAULT volume_driver cinder.volume.drivers.nfs.NfsDriver</userinput></screen>
</step>
<step>
<para>
<step><para>
You can now restart the service to apply the configuration.
</para>
<para os="rhel;centos;fedora;opensuse;sles">To restart the
<systemitem>cinder</systemitem> volume service on CentOS,
Fedora, openSUSE, Red Hat Enterprise Linux, or SUSE Linux
Enterprise, run:</para>
<systemitem class="service">cinder</systemitem> volume service
on CentOS, Fedora, openSUSE, Red Hat Enterprise Linux, or SUSE
Linux Enterprise, run:</para>
<screen os="rhel;centos;fedora;opensuse;sles"><prompt>#</prompt> <userinput>service openstack-cinder-volume restart</userinput></screen>
<para os="debian;ubuntu">To restart the
<systemitem>cinder</systemitem> volume service on Ubuntu or
Debian, run:</para>
<screen os="debian;ubuntu"><prompt>#</prompt> <userinput>service cinder-volume restart</userinput></screen>
</step>
<screen os="debian;ubuntu"><prompt>#</prompt> <userinput>service cinder-volume restart</userinput></screen></step>
</procedure>
<note>
<para>