Skip to content
OpenStack Object Storage (Swift)
Latest commit 791412f Jenkins committed with openstack-gerrit Merge "Make handoffs_first a more useful "mode""
Failed to load latest commit information.
bin Merge "Fix ClientException handling in Container Sync"
doc Merge "Removed unused parameter in"
etc Merge "Removed unused parameter in"
examples Add a user variable to templates
swift Merge "Make handoffs_first a more useful "mode""
test Merge "Make handoffs_first a more useful "mode""
.alltests Script for running unit, func and probe tests at once
.coveragerc Fix .coveragrc to prevent nose tests error
.functests Modify functional tests to use ostestr/testr
.gitignore Modify functional tests to use ostestr/testr
.gitreview Add .gitreview config file for gerrit.
.mailmap authors and changelog updates for 2.6.0
.manpages Script for checking sanity of manpages
.probetests Allow specify arguments to .probetests script
.testr.conf Fix func test --until-failure and --no-discover options
.unittests Fix coverage report for newer versions of coverage
CHANGELOG authors and changelog updates for 2.6.0 Add Swift Design Principles to
LICENSE Convert LICENSE to use unix style line endings. Add requirements files to the source distribution added testing notes to the contributing doc
babel.cfg add pybabel commands and initial .pot
bandit.yaml Adding bandit for security static analysis testing in swift
requirements.txt Changed EC backend from jerasure to liberasurecode in examples and docs
setup.cfg versioned writes middleware taking the global reqs that we can
test-requirements.txt Modify functional tests to use ostestr/testr
tox.ini Enable in-process func tests to optionally use fast-post


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

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.


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

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/ 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/

For Deployers

Deployer docs are also available at A good starting point is at

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

Complete API documentation at

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


The Swift Development Team

Something went wrong with that request. Please try again.