OpenStack Storage (Swift)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Jamie Lennox da78035043 Add a user variable to templates 8 years ago
bin Use Python 3.x compatible except construct 8 years ago
doc Add handoffs_first and handoff_delete to obj-repl 8 years ago
etc add reseller_admin_role to sample config 8 years ago
examples Add a user variable to templates 8 years ago
locale Reverted the pulling out of various middleware: 10 years ago
swift Merge "remove useless if from slo" 8 years ago
test Supply correct arguments to __init__ of a base class 8 years ago
.coveragerc Align tox.ini and fix coverage jobs in jenkins. 10 years ago
.functests Allow dot test runners from any dir 9 years ago
.gitignore fix(gitignore) : ignore *.egg and *.egg-info 8 years ago
.gitreview Add .gitreview config file for gerrit. 10 years ago
.mailmap CHANGELOG and AUTHORS and .mailmap updates for 1.9.1 8 years ago
.probetests Allow dot test runners from any dir 9 years ago
.unittests Add branch coverage reporting 9 years ago
AUTHORS CHANGELOG and AUTHORS and .mailmap updates for 1.9.1 8 years ago
CHANGELOG CHANGELOG and AUTHORS and .mailmap updates for 1.9.1 8 years ago
CONTRIBUTING.md Add CONTRIBUTING file. 9 years ago
LICENSE Convert LICENSE to use unix style line endings. 9 years ago
MANIFEST.in Add requirements files to the source distribution 9 years ago
README.md new more helpful README 9 years ago
babel.cfg add pybabel setup.py commands and initial .pot 11 years ago
requirements.txt Migrate to pbr for build 8 years ago
setup.cfg Migrate to pbr for build 8 years ago
setup.py Migrate to pbr for build 8 years ago
test-requirements.txt Start using Hacking 9 years ago
tox.ini Merge "Add support for POST commit coverage runs" 8 years ago

README.md

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