OpenStack Storage (Swift)
Go to file
Sean McGinnis baaa5c57e1
Remove reno from test-requirements
Reno is only needed for building release notes. Reno has now dropped py2
support, so attempts to install all requirements for py27 jobs fail with
the latest reno release.

Reno is already correctly listed in doc/requirements.txt, so this just
removes the unnecessary entry in test-requirements.txt.

Need-by: https://review.opendev.org/705994

Change-Id: Id1c54915ebe43f2b46f611a95109d2ab0d02d34d
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2020-02-05 16:20:53 -06:00
api-ref/source Use SOURCE_DATE_EPOCH in docs to make build reproducible 2019-08-24 21:04:22 +02:00
bin Merge "swift-account-audit: work with encryption" 2020-01-22 16:59:19 +00:00
doc Merge "proxy-logging: add fields ttfb and pid" 2020-01-31 19:01:09 +00:00
docker Merge "Add new versioning flag to docker image" 2020-01-31 20:41:25 +00:00
etc added value and notes to a sample config file for s3token 2020-01-31 10:47:58 -08:00
examples display swift services in apache2 2017-03-07 19:23:15 +00:00
releasenotes Authors/changelog for swift 2.24.0 2020-01-30 16:17:05 -08:00
swift Merge "enforce account quotas on empty accounts" 2020-02-01 02:21:52 +00:00
test Merge "enforce account quotas on empty accounts" 2020-02-01 02:21:52 +00:00
tools Update known-failures and config for up-rev'ed ceph/s3tests 2019-11-16 14:24:08 -08:00
.alltests tests: Stop invoking python just to get the real source directory 2019-10-15 15:08:42 -07:00
.coveragerc Show missing branches in coverage report. 2017-12-14 14:57:48 -08:00
.dockerignore Add Dockerfile to build a SAIO container image 2019-05-07 15:44:00 -04:00
.functests tests: Stop invoking python just to get the real source directory 2019-10-15 15:08:42 -07:00
.gitignore Make ceph tests more portable 2019-09-13 15:32:58 -07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:28:47 +00:00
.mailmap Authors/changelog for 2.22.0 2019-07-15 18:12:57 +00:00
.manpages Script for checking sanity of manpages 2016-02-10 14:16:56 -08:00
.probetests tests: Stop invoking python just to get the real source directory 2019-10-15 15:08:42 -07:00
.testr.conf Fix func test --until-failure and --no-discover options 2015-12-16 15:28:25 +00:00
.unittests tests: Stop invoking python just to get the real source directory 2019-10-15 15:08:42 -07:00
.zuul.yaml Merge "Add py38 unit test job" 2020-01-30 20:32:51 +00:00
AUTHORS Authors/changelog for swift 2.24.0 2020-01-30 16:17:05 -08:00
CHANGELOG Authors/changelog for swift 2.24.0 2020-01-30 16:17:05 -08:00
CONTRIBUTING.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-24 09:56:54 +08:00
Dockerfile Add Dockerfile to build a py3 swift docker image 2019-08-19 22:31:41 +02:00
Dockerfile-py3 Add Dockerfile to build a py3 swift docker image 2019-08-19 22:31:41 +02:00
LICENSE Convert LICENSE to use unix style line endings. 2012-12-19 12:48:27 -05:00
MANIFEST.in Include s3api schemas in sdists 2018-07-11 16:56:28 -07:00
README.rst Start README.rst with a better title 2019-11-19 17:32:50 +01:00
REVIEW_GUIDELINES.rst Fix the duplicated words issue like "the the " 2020-01-06 10:34:42 +08:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
bandit.yaml Update the bandit.yaml available tests list 2019-07-30 13:46:01 +08:00
bindep.txt Require gettext for all non-SUSE distros 2018-10-22 18:06:00 +00:00
lower-constraints.txt Add unittest2 back to lower-constraints.txt 2020-01-27 08:47:28 -08:00
requirements.txt Give ECAppIter greenthreads a chance to wrap up 2019-07-29 12:11:34 -07:00
setup.cfg Middleware that allows a user to have quoted Etags 2020-01-27 12:53:35 -08:00
setup.py taking the global reqs that we can 2014-05-21 09:37:22 -07:00
test-requirements.txt Remove reno from test-requirements 2020-02-05 16:20:53 -06:00
tox.ini Merge "Seamlessly reload servers with SIGUSR1" 2019-11-14 20:34:48 +00:00

README.rst

OpenStack Swift

image

OpenStack Swift is 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/latest/.

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 run:

pip install -r requirements.txt -r doc/requirements.txt
sphinx-build -W -b html doc/source doc/build/html

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://docs.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