diff options
author | Luis Pabon <lpabon@redhat.com> | 2013-06-26 15:19:16 -0400 |
---|---|---|
committer | Peter Portante <pportant@redhat.com> | 2013-06-28 12:37:55 -0700 |
commit | 92fdc68d6b90f4f7327bdffe542c5e8807a3e6c5 (patch) | |
tree | 1ff0eafb7f730706fb4182c1893a39318beffd90 /doc/markdown/user_guide.md | |
parent | cc97abca0482d3023c9d2fa9d0028098d08e818b (diff) |
Initial community documentation
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>
Diffstat (limited to 'doc/markdown/user_guide.md')
-rw-r--r-- | doc/markdown/user_guide.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/markdown/user_guide.md b/doc/markdown/user_guide.md new file mode 100644 index 0000000..6108832 --- /dev/null +++ b/doc/markdown/user_guide.md @@ -0,0 +1,66 @@ +# 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 |