openstack/swift
Code Issues Proposed changes
OpenStack Storage (Swift)
5,330 Commits 20 Branches 28 Tags 188 MiB
Python 99.6%
JavaScript 0.3%
973d9358d2
Go to file
Ondřej Nový 973d9358d2 Bump PyECLib requirement to >= 1.2.0 
This was discussed at last Swift meeting [1] and conclusion was
to require newest PyECLib version.

[1] http://eavesdrop.openstack.org/meetings/swift/2016/swift.2016-02-10-21.00.log.html#l-268

Depends-On: I0fd58f26bc0a3e7715356ff74344981f22786152
Change-Id: I54e89d99b48e00e614d2d457814c00354763c83b
2016-02-12 15:00:46 +00:00
bin Merge "Fix ClientException handling in Container Sync" 2016-01-13 14:44:00 +00:00
doc Merge "Enable in-process func tests to optionally use fast-post" 2016-02-11 08:29:56 +00:00
etc Merge "Remove executable flag from sample config file" 2016-02-11 02:05:26 +00:00
examples Add a user variable to templates 2013-09-17 11:46:04 +10:00
swift Merge "Removed default value for log_statsd_host" 2016-02-11 00:55:56 +00:00
test Merge "Enable in-process func tests to optionally use fast-post" 2016-02-11 08:29:56 +00:00
.alltests Script for running unit, func and probe tests at once 2015-10-13 09:10:09 +02:00
.coveragerc Fix .coveragrc to prevent nose tests error 2015-09-21 10:06:29 +01:00
.functests Modify functional tests to use ostestr/testr 2015-12-15 22:30:44 +00:00
.gitignore Modify functional tests to use ostestr/testr 2015-12-15 22:30:44 +00:00
.gitreview make git review easier 2015-04-01 12:41:44 -07:00
.mailmap authors and changelog updates for 2.6.0 2016-01-20 09:35:14 -08:00
.manpages Script for checking sanity of manpages 2016-02-10 14:16:56 -08:00
.probetests Allow specify arguments to .probetests script 2013-12-24 01:18:19 -08:00
.testr.conf Fix func test --until-failure and --no-discover options 2015-12-16 15:28:25 +00:00
.unittests Fix coverage report for newer versions of coverage 2014-04-24 16:50:03 +00:00
AUTHORS Merge "Update AUTHORS" 2016-01-26 20:07:14 +00:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
bandit.yaml Adding bandit for security static analysis testing in swift 2015-07-31 07:37:33 +05:30
CHANGELOG authors and changelog updates for 2.6.0 2016-01-20 09:35:14 -08:00
CONTRIBUTING.md Add Swift Design Principles to CONTRIBUTING.md 2015-03-27 13:13:31 -04: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 added testing notes to the contributing doc 2014-12-04 10:41:11 -05:00
requirements.txt Bump PyECLib requirement to >= 1.2.0 2016-02-12 15:00:46 +00:00
setup.cfg versioned writes middleware 2015-08-07 14:11:32 -04:00
setup.py taking the global reqs that we can 2014-05-21 09:37:22 -07:00
test-requirements.txt Modify functional tests to use ostestr/testr 2015-12-15 22:30:44 +00:00
tox.ini Enable in-process func tests to optionally use fast-post 2016-02-01 12:39:39 +00: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://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