From 463f5880565f98c3445924feeba50346fc120f3a Mon Sep 17 00:00:00 2001 From: Thiago da Silva Date: Tue, 27 May 2014 14:57:49 -0400 Subject: [PATCH 1/3] Adding roadmap section to README With the transition to Swift-on-File, we are attempting to provide better guidance to the community as to where the project is headed. Signed-off-by: Thiago da Silva --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a7d009c..c9cda28 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,41 @@ [![Build Status](https://travis-ci.org/swiftonfile/swiftonfile.svg?branch=master)](https://travis-ci.org/swiftonfile/swiftonfile) # Swift-On-File -Swift-On-File, formerly called Gluster-Swift, enables files and directories -created on any filesystem (that supports xattrs) to be accessed as objects +Swift-on-File, formerly called Gluster-Swift, enables files and directories +created on a Posix filesystem (that supports xattrs) to be accessed as objects via the Swift API. +The main difference from the default Swift Object Server is that Swift-on-File +stores objects following the same path hirearchy as that object's URL. +For example: for an object with URL: https://swift.example.com/v1/acc/cont/obj, +the default Object Server will store the object following the mapping given by +the Ring and and it final storage location and even filename is unknown to the +user (see [Swift Architecture](https://swiftstack.com/openstack-swift/architecture/) for more info). +In the case of SoF. The object will be stored in the configured Filesystem +volume with the same directory structure 'acc/cont/obj'. + +## Roadmap +Swift-On-File is in a transition period. The project was recently renamed from +Gluster-Swift to Swift-on-File to better represent its nature of a Swift backend +that supports multiple Posix Filesystems, not just GlusterFS. It is also +transitioning to become a Swift Storage Policy. While Gluster-Swift had to be +deployed as its own cluster, SoF can be deployed as a storage policy on an +existing Swift cluster. This is a tremendous change to the project as it opens +up new possibilities of how SoF can be used. + +Our last stable [release](https://github.com/swiftonfile/swiftonfile/releases) +was targetting the Swift Icehouse release. This was the last release of +Gluster-Swift. The next release will target Juno, with support for storage +policies. + +Besides the work to support Storage Policies we also plan on adding support +for other Filesystems (e.g., NFS) and also for enabling the access of objects +through multiple protocols. + +To learn more about the history of Gluster-Swift and how Swift-On-File came +to be, you can watch this presentation given at the Atlanta Openstack Summit: +[Breaking the Mold with Openstack Swift and GlusterFS](http://youtu.be/pSWdzjA8WuA) + ## Supported Filesystems: * XFS * GlusterFS From a297f1302e527f027b4cdd495f764e88921a31af Mon Sep 17 00:00:00 2001 From: Thiago da Silva Date: Tue, 27 May 2014 15:05:04 -0400 Subject: [PATCH 2/3] fixing a few sentences and adding a new url Signed-off-by: Thiago da Silva --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c9cda28..d4c2a2b 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,9 @@ The main difference from the default Swift Object Server is that Swift-on-File stores objects following the same path hirearchy as that object's URL. For example: for an object with URL: https://swift.example.com/v1/acc/cont/obj, the default Object Server will store the object following the mapping given by -the Ring and and it final storage location and even filename is unknown to the -user (see [Swift Architecture](https://swiftstack.com/openstack-swift/architecture/) for more info). -In the case of SoF. The object will be stored in the configured Filesystem -volume with the same directory structure 'acc/cont/obj'. +the Ring and its final storage location and filename are unknown to the user. +In the case of SoF, the object will be stored in the configured Filesystem +volume with the same directory structure '_acc/cont/obj_'. ## Roadmap Swift-On-File is in a transition period. The project was recently renamed from @@ -34,7 +33,8 @@ through multiple protocols. To learn more about the history of Gluster-Swift and how Swift-On-File came to be, you can watch this presentation given at the Atlanta Openstack Summit: -[Breaking the Mold with Openstack Swift and GlusterFS](http://youtu.be/pSWdzjA8WuA) +[Breaking the Mold with Openstack Swift and GlusterFS](http://youtu.be/pSWdzjA8WuA). +Presentation slides can be found [here](http://lpabon.github.io/openstack-summit-2014). ## Supported Filesystems: * XFS From 7ad4dc783b450b9ac0dfd343f2acede88c6c2d36 Mon Sep 17 00:00:00 2001 From: Thiago da Silva Date: Wed, 28 May 2014 13:56:59 -0400 Subject: [PATCH 3/3] Fixing example to differentiate between Swift and SoF Signed-off-by: Thiago da Silva --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d4c2a2b..8bee32e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ [![Build Status](https://travis-ci.org/swiftonfile/swiftonfile.svg?branch=master)](https://travis-ci.org/swiftonfile/swiftonfile) -# Swift-On-File -Swift-on-File, formerly called Gluster-Swift, enables files and directories -created on a Posix filesystem (that supports xattrs) to be accessed as objects -via the Swift API. +# Swift-on-File +Swift-on-File, formerly called Gluster-Swift, is a Swift Object Server +implementation that enables objects created using the Swift API to be accessed +as files on a Posix filesystem. The main difference from the default Swift Object Server is that Swift-on-File -stores objects following the same path hirearchy as that object's URL. +stores objects following the same path hierarchy as that object's URL. +On a vanilla openstack swift the object server will store the object following +the mapping given by the Ring and its final storage location and filename are +unknown to the user. In the case of Sof, the object will be stored in the +configured filesystem volume with the same directory structure as the object´s +URL. + For example: for an object with URL: https://swift.example.com/v1/acc/cont/obj, -the default Object Server will store the object following the mapping given by -the Ring and its final storage location and filename are unknown to the user. -In the case of SoF, the object will be stored in the configured Filesystem -volume with the same directory structure '_acc/cont/obj_'. +would be stored in the following way: +* Swift: /mnt/sdb1/2/node/sdb2/objects/981/f79/f566bd022b9285b05e665fd7b843bf79/1401254393.89313.data +* SoF: /mnt/gluster-object/acc/cont/obj ## Roadmap Swift-On-File is in a transition period. The project was recently renamed from