openstack/swift
Code Issues Proposed changes
OpenStack Storage (Swift)
3,784 Commits 20 Branches 29 Tags 192 MiB
Python 99.6%
JavaScript 0.3%
2d00f7b7ba
Go to file
gholt 2d00f7b7ba New log_max_line_length option. 
Log lines can get quite large, as we previously noticed with rsync error
log lines. We added a setting to cap those, but it really looks like we
should have just done this overall limit. We noticed the issue when we
switched to UDP syslogging and it would occasionally blow past the 16436
lo MTU! This causes Python's logging code to get an error and hilarity
ensues.

Change-Id: I44bdbe68babd58da58c14360379e8fef8a6b75f7
2014-05-22 20:30:34 +00:00
bin Add targeted config loading to swift-init 2014-05-19 14:43:50 +00:00
doc New log_max_line_length option. 2014-05-22 20:30:34 +00:00
etc New log_max_line_length option. 2014-05-22 20:30:34 +00:00
examples Add a user variable to templates 2013-09-17 11:46:04 +10:00
locale Reverted the pulling out of various middleware: 2012-05-16 21:25:10 +00:00
swift New log_max_line_length option. 2014-05-22 20:30:34 +00:00
test New log_max_line_length option. 2014-05-22 20:30:34 +00:00
.coveragerc Align tox.ini and fix coverage jobs in jenkins. 2012-06-08 20:05:14 -04:00
.functests Move the tests from functionalnosetests 2014-01-07 15:58:11 +08:00
.gitignore fix(gitignore) : ignore *.egg and *.egg-info 2013-07-30 15:11:00 -04:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:05:49 -04:00
.mailmap Update mailmap for Morgan Fainberg 2014-05-08 22:31:01 -07:00
.probetests Allow specify arguments to .probetests script 2013-12-24 01:18:19 -08:00
.unittests Fix coverage report for newer versions of coverage 2014-04-24 16:50:03 +00:00
AUTHORS Update mailmap for Morgan Fainberg 2014-05-08 22:31:01 -07:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
CHANGELOG updates for 1.13.1 release 2014-04-03 09:11:47 -07:00
CONTRIBUTING.md HEAD on account returns 410 if account was deleted and not yet reaped 2013-10-29 13:49:38 -07: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 Correct URL in readme 2013-10-07 22:27:34 -07:00
requirements.txt taking the global reqs that we can 2014-05-21 09:37:22 -07:00
setup.cfg Add profiling middleware in Swift 2014-05-08 18:31:07 +08:00
setup.py taking the global reqs that we can 2014-05-21 09:37:22 -07:00
test-requirements.txt Fix test-requirements.txt 2014-04-17 16:55:14 +00:00
tox.ini Added a tox job for running flake8 under Python 3 2014-05-17 08:18:27 -07: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.

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