openstack
/
swift
Code Issues Proposed changes
OpenStack Storage (Swift)
2,201 Commits 19 Branches 27 Tags 175 MiB
Python 99.6%
JavaScript 0.3%
Go to file
Samuel Merritt bf90ba2de1 Remove outdated Debian packaging guide. 
There are 3 sections in there, all useless.

Section 1 tells you how to install Swift packages from the swift-core
PPA. However, the latest version there is ancient.

Section 2 tells you how to build your own Swift packages. However, it
talks about getting the source code from the "debian" branch in bzr,
which is obviously really old.

Section 3 tells you how to take the packages from section 2 and
install them. This isn't too out-of-date, but since section 2 doesn't
work any more, section 3 is useless.

Since stale docs are worse than no docs, there's no current
information in this document, and bringing it up-to-date requires a
whole pile of work, I've chosen to delete it entirely.

Also pulled out a couple references to the PPA elsewhere.

Fixes bug 917385.
Fixes bug 1026145.

Change-Id: I510bd8619531fe110419e5488bd20d3602868d66
 		2012-11-13 13:06:48 -08:00
bin Fixed swift-bench when using -b and a conf file 2012-11-07 16:12:04 -08:00
doc Remove outdated Debian packaging guide. 2012-11-13 13:06:48 -08:00
etc add OPTIONS to proxy_logging configs and docs 2012-11-06 15:13:01 -08:00
locale Reverted the pulling out of various middleware: 2012-05-16 21:25:10 +00:00
swift Merge "fix error with setting max age and incorrect tests" 2012-11-09 23:36:41 +00:00
test fix error with setting max age and incorrect tests 2012-11-09 14:45:12 -08:00
tools Use pypi for python-swiftclient dependency. 2012-11-02 16:56:18 -07:00
.coveragerc Align tox.ini and fix coverage jobs in jenkins. 2012-06-08 20:05:14 -04:00
.functests make test runner functions return the status of running the tests 2012-04-18 15:13:09 +03:00
.gitignore Add support for venv-based test run with tox. 2012-03-07 22:44:34 -08:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:05:49 -04:00
.mailmap changelog and authors updates for 1.7 release 2012-09-04 08:36:55 -07:00
.probetests make test runner functions return the status of running the tests 2012-04-18 15:13:09 +03:00
.unittests make test runner functions return the status of running the tests 2012-04-18 15:13:09 +03:00
AUTHORS updated for 1.7.5 release 2012-11-06 18:42:07 -08:00
CHANGELOG updated for 1.7.5 release 2012-11-06 18:42:07 -08:00
LICENSE Initial commit of Swift code 2010-07-12 17:03:45 -05:00
MANIFEST.in Add README.md to the tarball. 2012-09-14 20:42:05 -04:00
README.md new more helpful README 2012-09-13 20:59:41 -07:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
setup.cfg Align tox.ini and fix coverage jobs in jenkins. 2012-06-08 20:05:14 -04:00
setup.py Add OpenStack trove classifier for PyPI 2012-10-22 18:55:15 -04:00
tox.ini Align tox.ini and fix coverage jobs in jenkins. 2012-06-08 20:05:14 -04: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