Skip to content
OpenStack Object Storage (Swift)
Python
Latest commit 96c1838 Apr 29, 2016 @briancline briancline Update mailmap, resolve identity crisis
Change-Id: Ia8e30a8c0f81068c259d5d08adad4f1a98460561
Failed to load latest commit information.
bin Merge "swift-[account|container]-info when disk is full" Apr 22, 2016
doc Fix doc build if git is absent Apr 28, 2016
etc Fix typos in Swift files Apr 7, 2016
examples Add a user variable to templates Sep 17, 2013
swift Change pids' type to set Apr 23, 2016
test Merge "Fix versioned_writes functional test skipping" Apr 26, 2016
.alltests Script for running unit, func and probe tests at once Oct 13, 2015
.coveragerc Fix .coveragrc to prevent nose tests error Sep 21, 2015
.functests Modify functional tests to use ostestr/testr Dec 15, 2015
.gitignore Add .eggs/* to .gitignore Mar 22, 2016
.gitreview Add .gitreview config file for gerrit. Oct 24, 2011
.mailmap Update mailmap, resolve identity crisis Apr 29, 2016
.manpages Script for checking sanity of manpages Feb 10, 2016
.probetests Allow specify arguments to .probetests script Dec 24, 2013
.testr.conf Fix func test --until-failure and --no-discover options Dec 16, 2015
.unittests Fix coverage report for newer versions of coverage Apr 24, 2014
AUTHORS 2.7.0 authors and changelog updates Mar 23, 2016
CHANGELOG 2.7.0 authors and changelog updates Mar 23, 2016
CONTRIBUTING.rst Convert CONTRIBUTING.md to CONTRIBUTING.rst Apr 8, 2016
LICENSE Convert LICENSE to use unix style line endings. Dec 19, 2012
MANIFEST.in Convert README.md to README.rst Apr 12, 2016
README.rst Convert README.md to README.rst Apr 12, 2016
REVIEW_GUIDELINES.rst adding review guidelines Apr 28, 2016
babel.cfg add pybabel setup.py commands and initial .pot Jan 27, 2011
bandit.yaml Adding bandit for security static analysis testing in swift Jul 31, 2015
requirements.txt Bump PyECLib requirement to >= 1.2.0 Feb 12, 2016
setup.cfg Convert README.md to README.rst Apr 12, 2016
setup.py taking the global reqs that we can May 21, 2014
test-requirements.txt Modify functional tests to use ostestr/testr Dec 15, 2015
tox.ini Merge "clear pycache and remove all pyc/pyo before starting unit test" Mar 16, 2016

README.rst

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://docs.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.

If you would like to start contributing, check out these notes to help you get started.

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

Something went wrong with that request. Please try again.