OpenStack Storage (Swift)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 13c3d835ba Merge "fix documentation of default" into stable/queens 7 months ago
api-ref/source Merge "Replace Chinese punctuation with English punctuation" 2 years ago
bin Let recon-cron work with conf.d 2 years ago
doc Merge "fix documentation of default" into stable/queens 7 months ago
etc Deprecate auth_uri option 2 years ago
examples Add a user variable to templates 6 years ago
releasenotes changelog for queens backports 1 year ago
swift bufferedhttp: ensure query params are properly quoted 8 months ago
test bufferedhttp: ensure query params are properly quoted 8 months ago
tools Move legacy-swift-dsvm-functional job in-tree 1 year ago
.alltests Apply bash error handling consistently in all bash scripts 3 years ago
.coveragerc Show missing branches in coverage report. 2 years ago
.functests Merge "Apply bash error handling consistently in all bash scripts" 3 years ago
.gitignore Ignore directory .stestr 2 years ago
.gitreview OpenDev Migration Patch 1 year ago
.mailmap authors/changelog updates for 2.17.0 release 2 years ago
.manpages Script for checking sanity of manpages 4 years ago
.probetests Allow specify arguments to .probetests script 6 years ago
.testr.conf Fix func test --until-failure and --no-discover options 4 years ago
.unittests Fix coverage report for newer versions of coverage 6 years ago
.zuul.yaml Remove openSUSE 42.3 job 9 months ago
AUTHORS authors/changelog updates for 2.17.0 release 2 years ago
CHANGELOG changelog for queens backports 1 year ago
CONTRIBUTING.rst doc migration: update the doc link address[2/3] 2 years ago
LICENSE Convert LICENSE to use unix style line endings. 7 years ago
MANIFEST.in Fix locale directory in MANIFEST.in 4 years ago
README.rst Remove redundant blank space in README.rst 2 years ago
REVIEW_GUIDELINES.rst added a quote 3 years ago
babel.cfg add pybabel setup.py commands and initial .pot 9 years ago
bandit.yaml import zuul job settings from project-config 1 year ago
bindep.txt Install liberasurecode-devel for CentOS 7 2 years ago
requirements.txt Retrieve encryption root secret from Barbican 2 years ago
setup.cfg fix barbican integration 2 years ago
setup.py taking the global reqs that we can 6 years ago
test-requirements.txt Switch from oslosphinx to openstackdocstheme 2 years ago
tox.ini Update UPPER_CONSTRAINTS_FILE for stable/queens 2 years ago

README.rst

Team and repository tags

image

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 https://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 https://docs.openstack.org/swift/latest/.

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.

To fully run the tests, the target environment must use a filesystem that supports large xattrs. XFS is strongly recommended. For unit tests and in-process functional tests, either mount /tmp with XFS or provide another XFS filesystem via the TMPDIR environment variable. Without this setting, tests should still pass, but a very large number will be skipped.

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 https://docs.openstack.org/swift/latest/. A good starting point is at https://docs.openstack.org/swift/latest/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 https://github.com/openstack/python-swiftclient.

Complete API documentation at https://developer.openstack.org/api-ref/object-store/

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