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.
 
 
 
Walter Doekes 24c086c8d0 tempurl: Fix PUT upload to temp url on py3 2 months ago
api-ref/source Switch to newer openstackdocstheme and reno versions 1 year ago
bin relinker: Pull arg parsing into module 6 months ago
doc Merge "s3api: Allow CORS preflight requests" 4 months ago
docker s3api: Allow CORS preflight requests 4 months ago
etc Merge "s3api: Allow CORS preflight requests" 4 months ago
examples Update SAIO & docker image to use 62xx ports 1 year ago
releasenotes AUTHORS/CHANGELOG for 2.27.0 4 months ago
roles Merge "dsvm: Use devstack's s3api "service"" 1 year ago
swift tempurl: Fix PUT upload to temp url on py3 2 months ago
test tempurl: Fix PUT upload to temp url on py3 2 months ago
tools Merge "s3api: Pass through CORS headers" 5 months ago
.alltests tests: Stop invoking python just to get the real source directory 2 years ago
.coveragerc Show missing branches in coverage report. 4 years ago
.dockerignore Add Dockerfile to build a SAIO container image 2 years ago
.functests tests: Stop invoking python just to get the real source directory 2 years ago
.gitignore Give unit tests a second chance to pass 8 months ago
.gitreview Update .gitreview for stable/wallaby 4 months ago
.mailmap Authors/ChangeLog for 2.25.0 1 year ago
.manpages Script for checking sanity of manpages 6 years ago
.probetests tests: Stop invoking python just to get the real source directory 2 years ago
.testr.conf Fix func test --until-failure and --no-discover options 6 years ago
.unittests tests: Stop invoking python just to get the real source directory 2 years ago
.zuul.yaml gate: Make swift-multinode-rolling-upgrade voting again 4 months ago
AUTHORS AUTHORS/CHANGELOG for 2.27.0 4 months ago
CHANGELOG AUTHORS/CHANGELOG for 2.27.0 4 months ago
CONTRIBUTING.rst Ussuri contrib docs community goal 1 year ago
Dockerfile Add Dockerfile to build a py3 swift docker image 2 years ago
Dockerfile-py3 Add Dockerfile to build a py3 swift docker image 2 years ago
LICENSE Convert LICENSE to use unix style line endings. 9 years ago
MANIFEST.in Include s3api schemas in sdists 3 years ago
README.rst Start README.rst with a better title 2 years ago
REVIEW_GUIDELINES.rst Ussuri contrib docs community goal 1 year ago
babel.cfg add pybabel setup.py commands and initial .pot 11 years ago
bandit.yaml replace md5 with swift utils version 7 months ago
bindep.txt Add py3 probe tests on CentOS 8 7 months ago
lower-constraints.txt Clean up requirements a bit 8 months ago
py2-constraints.txt Pin Bandit on py2 8 months ago
requirements.txt Remove <py3.5 dependencies from requirements.txt 1 year ago
setup.cfg Test under py39 6 months ago
setup.py Sync netifaces with global-requirements 7 years ago
test-requirements.txt Clean up requirements a bit 8 months ago
tox.ini Update TOX_CONSTRAINTS_FILE for stable/wallaby 4 months ago

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