Swift Object Server implementation that enables objects created using the Swift API to be accessed as files on a POSIX filesystem.
Go to file
Prashanth Pai eb7883dc23 Remove some dead code
Used vulture utility to detect unused code in swiftonfile.
https://pypi.python.org/pypi/vulture

Change-Id: I045f5a96a48d2384718ad0f993540caa3a866309
Signed-off-by: Prashanth Pai <ppai@redhat.com>
2015-01-19 13:03:51 +05:30
bin changing references of gluster to swiftonfile 2014-07-08 11:04:31 -04:00
doc/markdown doc: Update merge requirements. 2014-10-08 11:15:56 -04:00
etc Fix bug in object name constraint 2014-12-01 13:05:29 +05:30
extras doc: Update developer documentation 2014-10-01 13:33:53 -04:00
swiftonfile Remove some dead code 2015-01-19 13:03:51 +05:30
test Remove some dead code 2015-01-19 13:03:51 +05:30
.functests Fix bug in object name constraint 2014-12-01 13:05:29 +05:30
.functests-ci changes references to swiftonfile in tests scripts 2014-07-08 11:04:31 -04:00
.gitignore Modify unit tests and func tests 2014-05-08 12:11:46 +05:30
.gitmodules Add OpenStack Swift as a git submodule 2013-09-05 04:23:50 -07:00
.gitreview Add .gitreview file 2014-09-22 12:19:08 +05:30
.travis.yml removing blank lines 2014-04-28 19:30:38 -04:00
.unittests changes references to swiftonfile in tests scripts 2014-07-08 11:04:31 -04:00
makerpm.sh changing references of gluster to swiftonfile 2014-07-08 11:04:31 -04:00
MANIFEST.in Add MANIFEST.in 2015-01-09 21:56:59 -07:00
pkgconfig.py changing references of gluster to swiftonfile 2014-07-08 11:04:31 -04:00
README.md Generalize README by adding references to GPFS. 2015-01-13 17:38:00 -07:00
requirements.txt Rebase swiftonfile to swift 2.1.0 release 2014-10-07 02:02:01 +05:30
setup.py new constraints middleware 2014-10-07 16:53:44 -04:00
swiftonfile.spec changing references of gluster to swiftonfile 2014-07-08 11:04:31 -04:00
test-requirements.txt Rebase swiftonfile to swift 2.1.0 release 2014-10-07 02:02:01 +05:30
tox.ini Rebase swiftonfile to swift 2.1.0 release 2014-10-07 02:02:01 +05:30

Build Status

Swift-on-File

Swift-on-File is a Swift Object Server implementation that enables users to access the same data, both as an object and as a file. Data can be stored and retrieved through Swift's REST interface or as files from NAS interfaces including native GlusterFS, GPFS, NFS and CIFS.

Swift-on-File is to be deployed as a Swift storage policy, which provides the advantages of being able to extend an existing Swift cluster and also migrating data to and from policies with different storage backends.

The main difference from the default Swift Object Server is that Swift-on-File stores objects following the same path hierarchy as the object's URL. In contrast, the default Swift implementation stores the object following the mapping given by the Ring, and its final file path is unkown to the user.

For example, an object with URL: https://swift.example.com/v1/acct/cont/obj, would be stored the following way by the two systems:

  • Swift: /mnt/sdb1/2/node/sdb2/objects/981/f79/f566bd022b9285b05e665fd7b843bf79/1401254393.89313.data
  • SoF: /mnt/swiftonfile/acct/cont/obj

Use cases

Swift-on-File can be especially useful in cases where access over multiple protocols is desired. For example, imagine a deployment where video files are uploaded as objects over Swift's REST interface and a legacy video transcoding software access those videos as files.

Along the same lines, data can be ingested over Swift's REST interface and then analytic software like Hadoop can operate directly on the data without having to move the data to a separate location.

Another use case is where users might need to migrate data from an existing file storage systems to a Swift cluster.

Similarly, scientific applications may process file data and then select some or all of the data to publish to outside users through the swift interface.

Limitations and Future plans

Swift-On-File currently works only with Filesystems with extended attributes support. It is also recommended that these Filesystems provide data durability as Swift-On-File should not use Swift's replication mechanisms.

GlusterFS and GPFS are good examples of Filesystems that work well with Swift-on-File. Both provide a posix interface, global namespace, scalability, data replication and support for extended attributes.

Currently, files added over a NAS protocol (e.g., native GlusterFS), do not show up in container listings, still those files would be accessible over Swift's REST interface with a GET request. We are working to provide a solution to this limitation.

Future plans includes adding support for Filesystems without extended attributes, which should extend the ability to migrate data for legacy storage systems.

Get involved:

To learn more about Swift-On-File, you can watch this presentation given at the Atlanta Openstack Summit: Breaking the Mold with Openstack Swift and GlusterFS. Presentation slides can be found here.

Join us in contributing to the project. Feel free to file bugs, help with documentation or work directly on the code. You can communicate with us using GitHub issues or find us in the #swiftonfile channel on Freenode.

Guides to get started:

  1. Quick Start Guide with XFS/GlusterFS
  2. Developer Guide