OpenStack Object Storage (Swift)
Python
Latest commit e67a57f Dec 9, 2016 Jenkins committed with openstack-gerrit Merge "Fixups for ghost listing fix"
Permalink
Failed to load latest commit information.
api-ref/source Merge "Document access control lists (ACLs)" Nov 23, 2016
bin Set owner of drive-audit recon cache to swift user Oct 19, 2016
doc line wrap overview_expiring_objects.rst Dec 8, 2016
etc Added comment for "user" option in drive-audit config Nov 21, 2016
examples Add a user variable to templates Sep 17, 2013
install-guide/source Merge "update urls to newton" Nov 7, 2016
releasenotes 2.11.0 release notes Nov 18, 2016
swift Merge "Fixups for ghost listing fix" Dec 9, 2016
test Merge "Fixups for ghost listing fix" Dec 9, 2016
.alltests Apply bash error handling consistently in all bash scripts Oct 11, 2016
.coveragerc Fix .coveragrc to prevent nose tests error Sep 21, 2015
.functests Merge "Apply bash error handling consistently in all bash scripts" Oct 14, 2016
.gitignore Add .eggs/* to .gitignore Mar 22, 2016
.gitreview Add .gitreview config file for gerrit. Oct 24, 2011
.mailmap 2.11.0 release notes Nov 18, 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.11.0 release notes Nov 18, 2016
CHANGELOG 2.11.0 release notes Nov 18, 2016
CONTRIBUTING.rst Rework the contributor docs May 6, 2016
LICENSE Convert LICENSE to use unix style line endings. Dec 19, 2012
MANIFEST.in Fix locale directory in MANIFEST.in May 19, 2016
README.rst Show team and repo badges on README Nov 25, 2016
REVIEW_GUIDELINES.rst Fix typo: remove redundant 'that' Oct 3, 2016
babel.cfg add pybabel setup.py commands and initial .pot Jan 27, 2011
bandit.yaml Updating Bandit config file Sep 16, 2016
bindep.txt Move other-requirements.txt to bindep.txt Aug 12, 2016
requirements.txt Update pyeclib dependency to 1.3.1 Oct 6, 2016
setup.cfg modify the home-page info with the developer documentation Jul 29, 2016
setup.py taking the global reqs that we can May 21, 2014
test-requirements.txt adding reno sphinx tree Nov 10, 2016
tox.ini Merge "Drop "--allow-insecure netifaces" from tox pip install" Nov 29, 2016

README.rst

Team and repository tags

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

Getting Started

Swift is part of OpenStack and follows the code contribution, review, and testing processes common to all OpenStack projects.

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

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.

Tests

There are three types of tests included in Swift's source tree.

  1. Unit tests
  2. Functional tests
  3. Probe tests

Unit tests check that small sections of the code behave properly. For example, a unit test may test a single function to ensure that various input gives the expected output. This validates that the code is correct and regressions are not introduced.

Functional tests check that the client API is working as expected. These can be run against any endpoint claiming to support the Swift API (although some tests require multiple accounts with different privilege levels). These are "black box" tests that ensure that client apps written against Swift will continue to work.

Probe tests are "white box" tests that validate the internal workings of a Swift cluster. They are written to work against the "SAIO - Swift All In One" dev environment. For example, a probe test may create an object, delete one replica, and ensure that the background consistency processes find and correct the error.

You can run unit tests with .unittests, functional tests with .functests, and probe tests with .probetests. There is an additional .alltests script that wraps the other three.

Code Organization

  • bin/: Executable scripts that are the processes run by the deployer
  • doc/: Documentation
  • etc/: Sample config files
  • examples/: Config snippets used in the docs
  • swift/: Core code
    • account/: account server
    • cli/: code that backs some of the CLI tools in bin/
    • common/: code shared by different modules
      • middleware/: "standard", officially-supported middleware
      • ring/: code implementing Swift's ring
    • container/: container server
    • locale/: internationalization (translation) data
    • obj/: object server
    • proxy/: proxy server
  • test/: Unit, functional, and probe 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

There is an ops runbook that gives information about how to diagnose and troubleshoot common issues when running a Swift cluster.

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/

There is a large ecosystem of applications and libraries that support and work with OpenStack Swift. Several are listed on the associated projects page.


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

Thanks,

The Swift Development Team