OpenStack Storage (Swift)
Go to file
tong li 68355d7ea5 Instruction for multi node setup misses /var/run/swift creation
Multiple Server Swift Installation (Ubuntu) instruction does not
indicate that the directory /var/run/swift needs to be created.
That directory actually needs to be created and the ownship needs
to be changed to the user/group which swift service runs under.

This patch will fix the document and gives the steps how to create
the directory and set the ownership right. It also gives instruction
on how the script can be added so that swift services can be resarted
after system reboots.

Change-Id: Id61aa67cc0d6f66d749701e6ea824b1ff3b2c478
Fixes: bug #1156631
2013-03-18 13:57:40 -04:00
bin Fix format device 2013-03-16 12:41:14 +04:00
doc Instruction for multi node setup misses /var/run/swift creation 2013-03-18 13:57:40 -04:00
etc Account quotas 2013-03-08 14:31:35 +01:00
locale Reverted the pulling out of various middleware: 2012-05-16 21:25:10 +00:00
swift Merge "Remove check for valid Origin for the "actual request"." 2013-03-14 11:29:17 +00:00
test Merge "Add tests and doc entry for request.environ[reseller_request]" 2013-03-16 19:29:47 +00:00
tools Fixed version req for netifaces to 0.5 2013-01-10 23:07:02 +00:00
.coveragerc Align tox.ini and fix coverage jobs in jenkins. 2012-06-08 20:05:14 -04:00
.functests Allow dot test runners from any dir 2012-12-07 14:08:49 -08:00
.gitignore Ignore pycscope files 2012-12-04 11:17:38 -05:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:05:49 -04:00
.mailmap Account and container info fixes and improvement. 2013-02-16 23:32:27 +01:00
.probetests Allow dot test runners from any dir 2012-12-07 14:08:49 -08:00
.unittests one dot, 5% increase in coverage 2012-12-17 09:45:46 -08:00
AUTHORS Add tests and doc entry for request.environ[reseller_request] 2013-03-10 19:21:13 +01:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
CHANGELOG Fix spelling mistakes 2013-02-12 16:39:40 -08:00
CONTRIBUTING.md Add CONTRIBUTING file. 2012-11-21 11:23:15 -08:00
LICENSE Convert LICENSE to use unix style line endings. 2012-12-19 12:48:27 -05:00
MANIFEST.in Add missing CONTRIBUTING.md to source tarball 2013-03-13 11:35:42 +01:00
README.md new more helpful README 2012-09-13 20:59:41 -07:00
setup.cfg Align tox.ini and fix coverage jobs in jenkins. 2012-06-08 20:05:14 -04:00
setup.py Account quotas 2013-03-08 14:31:35 +01:00
tox.ini Upgrade pep8 to 1.3.3. 2012-11-26 18:15:21 -08:00

Swift

A distributed object storage system designed to scale from a single machine to thousands of servers. Swift is optimized for multi-tenancy and high concurrency. Swift is ideal for backups, web and mobile content, and any other unstructured data that can grow without bound.

Swift provides a simple, REST-based API fully documented at http://doc.openstack.org/.

Swift was originally developed as the basis for Rackspace's Cloud Files and was open-sourced in 2010 as part of the OpenStack project. It has since grown to include contributions from many companies and has spawned a thriving ecosystem of 3rd party tools. Swift's contributors are listed in the AUTHORS file.

Docs

To build documentation install sphinx (pip install sphinx), run python setup.py build_sphinx, and then browse to /doc/build/html/index.html. These docs are auto-generated after every commit and available online at http://docs.openstack.org/developer/swift/.

For Developers

The best place to get started is the "SAIO - Swift All In One". This document will walk you through setting up a development cluster of Swift in a VM. The SAIO environment is ideal for running small-scale tests against swift and trying out new features and bug fixes.

You can run unit tests with .unittests and functional tests with .functests.

Code Organization

  • bin/: Executable scripts that are the processes run by the deployer
  • doc/: Documentation
  • etc/: Sample config files
  • swift/: Core code
    • account/: account server
    • common/: code shared by different modules
      • middleware/: "standard", officially-supported middleware
      • ring/: code implementing Swift's ring
    • container/: container server
    • obj/: object server
    • proxy/: proxy server
  • test/: Unit and functional tests

Data Flow

Swift is a WSGI application and uses eventlet's WSGI server. After the processes are running, the entry point for new requests is the Application class in swift/proxy/server.py. From there, a controller is chosen, and the request is processed. The proxy may choose to forward the request to a back- end server. For example, the entry point for requests to the object server is the ObjectController class in swift/obj/server.py.

For Deployers

Deployer docs are also available at http://docs.openstack.org/developer/swift/. A good starting point is at http://docs.openstack.org/developer/swift/deployment_guide.html

You can run functional tests against a swift cluster with .functests. These functional tests require /etc/swift/test.conf to run. A sample config file can be found in this source tree in test/sample.conf.

For Client Apps

For client applications, official Python language bindings are provided at http://github.com/openstack/python-swiftclient.

Complete API documentation at http://docs.openstack.org/api/openstack-object-storage/1.0/content/


For more information come hang out in #openstack-swift on freenode.

Thanks,

The Swift Development Team