openstack/swift
Code Issues Proposed changes
OpenStack Storage (Swift)
5,449 Commits 20 Branches 29 Tags 185 MiB
Python 99.6%
JavaScript 0.3%
f581fccf71
Go to file
Tim Burke f581fccf71 By default, disallow inbound X-Timestamp headers 
With the X-Timestamp validation added in commit e619411, end users
could upload objects with

    X-Timestamp: 9999999999.99999_ffffffffffffffff

(the maximum value) and Swift would be unable to delete them.

Now, inbound X-Timestamp headers will be moved to
X-Backend-Inbound-X-Timestamp, effectively rendering them harmless.

The primary reason to allow X-Timestamp before was to prevent
Last-Modified changes for objects coming from either:

  * container_sync or
  * a migration from another storage system.

To enable the former use-case, the container_sync middleware will now
translate X-Backend-Inbound-X-Timestamp headers back to X-Timestamp
after verifying the request.

Additionally, a new option is added to the gatekeeper filter config:

    # shunt_inbound_x_timestamp = true

To enable the latter use-case (or any other use-case not mentioned), set
this to false.

Upgrade Consideration
=====================

If your cluster workload requires that clients be allowed to specify
objects' X-Timestamp values, disable the shunt_inbound_x_timestamp
option before upgrading.

UpgradeImpact
Change-Id: I8799d5eb2ae9d795ba358bb422f69c70ee8ebd2c
2016-03-09 09:14:46 +00:00
bin Merge "Keep the Usage of exit()/sys.exit() Consistent" 2016-02-18 14:26:49 +00:00
doc Merge "Fixed pep8 and flake8 errors in doc/source/conf.py and updated flake8 commands in tox.ini to test it." 2016-03-08 16:28:27 +00:00
etc By default, disallow inbound X-Timestamp headers 2016-03-09 09:14:46 +00:00
examples Add a user variable to templates 2013-09-17 11:46:04 +10:00
swift By default, disallow inbound X-Timestamp headers 2016-03-09 09:14:46 +00:00
test By default, disallow inbound X-Timestamp headers 2016-03-09 09:14:46 +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 Add .gitreview config file for gerrit. 2011-10-24 15:05:49 -04: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 Use uppercase 'S' in word "OpenStack" 2016-02-04 16:48:13 +05:30
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 Removed redundant file for flake8 check 2016-03-08 10:57:56 -06: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