openstack/swift
Code Issues Proposed changes
OpenStack Storage (Swift)
2,795 Commits 21 Branches 29 Tags 186 MiB
Python 99.6%
JavaScript 0.3%
1f43ee050b
Go to file
Clay Gerrard 1f43ee050b Add option to make probetests more brittle 
Currently probetests take advantage of a number of assumptions about the SUT.
Unfortunately after some time with a working SAIO, configuration drift may
result in a system that is no longer compatible with these assumptions.  To
help weary developers more quickly identify the changes they've made since
they last ran probetests successfully, some handy validators have been added
to test.probe.common

Additionally a new option 'validate_rsync' in test.conf, when enabled, will
run a series of up front validations during the setup of each probetest by
inspecting the ring, the mounted devices, and the rsync exports ("modules") in
order to ensure that when probetests fail the do so early and with specific
complaints.

To preserve existing failures, the option is disabled by default.

Change-Id: I2be11c7e67ccd0bc0589c360c170049b6288c152
2013-07-19 01:39:42 -07:00
bin Start using Hacking 2013-07-15 11:41:58 +02:00
doc Add documentation about flake8+hacking. 2013-07-15 17:14:16 +02:00
etc Record some simple object stats in the object auditor 2013-07-02 13:41:18 -07:00
examples Add example Apache config files 2013-06-20 21:56:21 +03:00
locale Reverted the pulling out of various middleware: 2012-05-16 21:25:10 +00:00
swift Forklift the DiskFile interface into it's own module 2013-07-18 08:00:14 -07:00
test Add option to make probetests more brittle 2013-07-19 01:39:42 -07: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 update .gitignore 2013-06-20 17:58:50 +08:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:05:49 -04:00
.mailmap updated changelog and authors update for 1.9.0 release 2013-06-25 21:41:28 -07:00
.probetests Allow dot test runners from any dir 2012-12-07 14:08:49 -08:00
.unittests Add branch coverage reporting 2013-06-10 10:30:40 -04:00
AUTHORS updated changelog and authors update for 1.9.0 release 2013-06-25 21:41:28 -07:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
CHANGELOG updated changelog and authors update for 1.9.0 release 2013-06-25 21:41:28 -07: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 requirements files to the source distribution 2013-06-03 19:26:20 +04:00
README.md new more helpful README 2012-09-13 20:59:41 -07:00
requirements.txt Rename requires files to standard names. 2013-05-30 22:14:01 +00:00
setup.cfg Change setup.cfg style. 2013-04-02 15:55:56 +04:00
setup.py Rename requires files to standard names. 2013-05-30 22:14:01 +00:00
test-requirements.txt Start using Hacking 2013-07-15 11:41:58 +02:00
tox.ini Start using Hacking 2013-07-15 11:41:58 +02:00

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