92fdc68d6b
Community documentation is being written in Markdown format because we can leverage GitHub.com's ability to render Markdown into HTML directly from files in the repo. Also, the GlusterFS Community project has decided to use Markdown as an input into the tool called pandoc which can convert the documents into multiple formats. Change-Id: Iec530f05a9a1ab3a95a1e97b791e8390068b99b4 Signed-off-by: Luis Pabon <lpabon@redhat.com> Reviewed-on: http://review.gluster.org/5256 Reviewed-by: Peter Portante <pportant@redhat.com> Tested-by: Peter Portante <pportant@redhat.com>
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
# User Guide
|
|
|
|
## Installation
|
|
|
|
### GlusterFS Installation
|
|
First, we need to install GlusterFS on the system by following the
|
|
instructions on [GlusterFS QuickStart Guide][].
|
|
|
|
### Fedora/RHEL/CentOS
|
|
Gluster for Swift depends on OpenStack Swift Grizzly, which can be
|
|
obtained by using [RedHat's RDO][] packages as follows:
|
|
|
|
~~~
|
|
yum install -y http://rdo.fedorapeople.org/openstack/openstack-grizzly/rdo-release-grizzly.rpm
|
|
~~~
|
|
|
|
### Download
|
|
Gluster for Swift uses [Jenkins][] for continuous integration and
|
|
creation of distribution builds. Download the latest RPM builds
|
|
from one of the links below:
|
|
|
|
* RHEL/CentOS 6: [Download](http://build.gluster.org/job/gluster-swift-builds-cent6/lastSuccessfulBuild/artifact/build/)
|
|
* Fedora 18+: [Download](http://build.gluster.org/job/gluster-swift-builds-f18/lastSuccessfulBuild/artifact/build/)
|
|
|
|
Install the downloaded RPM using the following command:
|
|
|
|
~~~
|
|
yum install -y RPMFILE
|
|
~~~
|
|
|
|
where *RPMFILE* is the RPM file downloaded from Jenkins.
|
|
|
|
## Configuration
|
|
TBD
|
|
|
|
## Server Control
|
|
Command to start the servers (TBD)
|
|
|
|
~~~
|
|
swift-init main start
|
|
~~~
|
|
|
|
Command to stop the servers (TBD)
|
|
|
|
~~~
|
|
swift-init main stop
|
|
~~~
|
|
|
|
Command to gracefully reload the servers
|
|
|
|
~~~
|
|
swift-init main reload
|
|
~~~
|
|
|
|
### Mounting your volumes
|
|
TBD
|
|
|
|
Once this is done, you can access GlusterFS volumes via the Swift API where
|
|
accounts are mounted volumes, containers are top-level directories,
|
|
and objects are files and sub-directories of container directories.
|
|
|
|
|
|
|
|
[GlusterFS QuickStart Guide]: http://www.gluster.org/community/documentation/index.php/QuickStart
|
|
[RedHat's RDO]: http://openstack.redhat.com/Quickstart
|
|
[Jenkins]: http://jenkins-ci.org
|