openstack/swift
Code Issues Proposed changes
OpenStack Storage (Swift)
6,182 Commits 20 Branches 27 Tags 185 MiB
Python 99.6%
JavaScript 0.3%
e6dea4d699
Go to file
John Dickinson e6dea4d699 adding reno sphinx tree 
This should give the necessary tooling to set up the right
links in the right places so Swift has release notes listed
alongside other projects.

Change-Id: I4e5f1ce1fcfbb2943036c821a24a0b4a3a2d9fc8
2016-11-10 21:34:14 +00:00
api-ref/source [api-ref] Remove temporary block in conf.py 2016-10-06 16:50:17 +07:00
bin Turn on F812 check 2016-09-16 14:44:37 -07:00
doc EC - eliminate .durable files 2016-10-10 18:11:02 +01:00
etc Add a configurable URL base to staticweb 2016-10-03 21:08:15 -06:00
examples Add a user variable to templates 2013-09-17 11:46:04 +10:00
install-guide/source updated output for swift stat 2016-09-17 21:05:17 +05:30
releasenotes adding reno sphinx tree 2016-11-10 21:34:14 +00:00
swift Merge "Throttle update_auditor_status calls" 2016-10-13 04:11:05 +00:00
test Merge "Throttle update_auditor_status calls" 2016-10-13 04:11:05 +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 add reminder how to run debug func tests 2016-08-09 15:42:20 -04:00
.gitignore Add .eggs/* to .gitignore 2016-03-22 11:53:49 +00:00
.gitreview update .gitreview 2016-06-09 11:22:37 -07:00
.mailmap authors/changelog updates for 2.10.0 2016-09-23 13:43:01 -07: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 authors/changelog updates for 2.10.0 2016-09-23 13:43:01 -07:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
bandit.yaml Updating Bandit config file 2016-09-16 09:20:34 -07:00
bindep.txt Move other-requirements.txt to bindep.txt 2016-08-12 21:18:07 +02:00
CHANGELOG authors/changelog updates for 2.10.0 2016-09-23 13:43:01 -07:00
CONTRIBUTING.rst Rework the contributor docs 2016-05-05 22:02:47 -07:00
LICENSE Convert LICENSE to use unix style line endings. 2012-12-19 12:48:27 -05:00
MANIFEST.in Fix locale directory in MANIFEST.in 2016-05-19 15:56:15 +02:00
README.rst made link in README.rst more clear 2016-08-01 15:43:25 +00:00
requirements.txt Update pyeclib dependency to 1.3.1 2016-10-06 11:22:26 -07:00
REVIEW_GUIDELINES.rst Fix typo: remove redundant 'that' 2016-10-03 13:29:25 +07:00
setup.cfg modify the home-page info with the developer documentation 2016-07-29 11:43:32 +08:00
setup.py taking the global reqs that we can 2014-05-21 09:37:22 -07:00
test-requirements.txt adding reno sphinx tree 2016-11-10 21:34:14 +00:00
tox.ini adding reno sphinx tree 2016-11-10 21:34:14 +00:00

README.rst

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

Getting Started

Swift is part of OpenStack and follows the code contribution, review, and testing processes common to all OpenStack projects.

If you would like to start contributing, check out these notes to help you get started.

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.

Tests

There are three types of tests included in Swift's source tree.

  1. Unit tests
  2. Functional tests
  3. Probe tests

Unit tests check that small sections of the code behave properly. For example, a unit test may test a single function to ensure that various input gives the expected output. This validates that the code is correct and regressions are not introduced.

Functional tests check that the client API is working as expected. These can be run against any endpoint claiming to support the Swift API (although some tests require multiple accounts with different privilege levels). These are "black box" tests that ensure that client apps written against Swift will continue to work.

Probe tests are "white box" tests that validate the internal workings of a Swift cluster. They are written to work against the "SAIO - Swift All In One" dev environment. For example, a probe test may create an object, delete one replica, and ensure that the background consistency processes find and correct the error.

You can run unit tests with .unittests, functional tests with .functests, and probe tests with .probetests. There is an additional .alltests script that wraps the other three.

Code Organization

  • bin/: Executable scripts that are the processes run by the deployer
  • doc/: Documentation
  • etc/: Sample config files
  • examples/: Config snippets used in the docs
  • swift/: Core code
    • account/: account server
    • cli/: code that backs some of the CLI tools in bin/
    • common/: code shared by different modules
      • middleware/: "standard", officially-supported middleware
      • ring/: code implementing Swift's ring
    • container/: container server
    • locale/: internationalization (translation) data
    • obj/: object server
    • proxy/: proxy server
  • test/: Unit, functional, and probe 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

There is an ops runbook that gives information about how to diagnose and troubleshoot common issues when running a Swift cluster.

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/

There is a large ecosystem of applications and libraries that support and work with OpenStack Swift. Several are listed on the associated projects page.

For more information come hang out in #openstack-swift on freenode.

Thanks,

The Swift Development Team