OpenStack Storage (Swift)
Go to file
indianwhocodes dab7192e1e tests: fix FakeSwift HEAD with query param
The existing FakeSwift implementation already supports using registered
GET responses for GET requests with a query param.  It also supports
using registered GET responses for HEAD requests (if they either both
had the exact SAME matching query params, or both did not have ANY query
params).  But it did not support using registered GET responses w/o
query params for HEAD requests with a query param, even though a GET
with the same query param would work.

This change makes it a little more consistent: any client or test that
makes a GET request, should be able to make a similar HEAD request and
expect consistent response headers and status.

This test infra improvement is needed as we're going to be extending
test_slo with a bunch of tests that assert consistent response headers
for both GET and HEAD requests w/ new query params.

Change-Id: Idb4020fdeee87a9164312dc9647ab0820b098ff8
2023-08-18 14:28:25 +01:00
api-ref/source api-ref: Document reverse param 2022-04-07 12:45:07 -07:00
bin Change getting major:minor of blkdev 2023-06-28 10:35:13 +02:00
doc docs: Clean up proxy logging docs 2023-08-04 11:30:42 -07:00
docker Fix docker image building 2022-08-16 12:17:01 -07:00
etc docs: Clean up proxy logging docs 2023-08-04 11:30:42 -07:00
examples Update SAIO & docker image to use 62xx ports 2020-07-20 15:17:12 -07:00
releasenotes Imported Translations from Zanata 2023-07-28 04:11:58 +00:00
roles Merge "dsvm: Use devstack's s3api "service"" 2020-06-07 18:58:39 +00:00
swift fix swob HEAD handling for leak tracking 2023-08-16 23:49:35 +00:00
test tests: fix FakeSwift HEAD with query param 2023-08-18 14:28:25 +01:00
tools CI: Fix our usage of tox 2022-12-29 13:36:06 -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 Give functional tests another chance to pass 2021-03-26 10:13:19 -07:00
.gitignore Give unit tests a second chance to pass 2020-12-04 22:21:58 -08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:28:47 +00:00
.mailmap Add new Kota's email entry to mailmap 2023-02-06 09:57:06 +09:00
.manpages Script for checking sanity of manpages 2016-02-10 14:16:56 -08:00
.probetests Switch to pytest 2022-12-09 11:38:02 -08:00
.stestr.conf Give functional tests another chance to pass 2021-03-26 10:13:19 -07:00
.unittests Switch to pytest 2022-12-09 11:38:02 -08:00
.zuul.yaml CI: test under py311 2023-06-22 17:28:12 -07:00
AUTHORS Authors/ChangeLog for 2.31.1 2023-03-09 12:36:12 -08:00
bandit.yaml Drop bandit check B309 2023-03-10 12:33:33 -08:00
bindep.txt Move base CI job to jammy 2022-11-03 15:39:05 -07:00
CHANGELOG Forward-port stable-release CHANGELOG entries 2023-03-23 11:07:37 -07:00
CONTRIBUTING.rst Switch to pytest 2022-12-09 11:38:02 -08:00
Dockerfile Fix docker image building 2022-08-16 12:17:01 -07:00
Dockerfile-py3 Fix docker image building 2022-08-16 12:17:01 -07:00
LICENSE Convert LICENSE to use unix style line endings. 2012-12-19 12:48:27 -05:00
lower-constraints.txt Add attrs to lower-constraints 2023-01-09 09:00:27 -08:00
MANIFEST.in Include s3api schemas in sdists 2018-07-11 16:56:28 -07:00
py2-constraints.txt CI: Fix our usage of tox 2022-12-29 13:36:06 -08:00
py36-constraints.txt Switch to pytest 2022-12-09 11:38:02 -08:00
README.rst Update url 2023-03-24 14:44:18 +08:00
requirements.txt Remove hard dependency on netifaces 2023-05-23 14:35:48 -07:00
REVIEW_GUIDELINES.rst Ussuri contrib docs community goal 2020-05-26 15:06:02 -07:00
setup.cfg Clean up some cruft 2023-01-19 12:56:08 -08:00
setup.py taking the global reqs that we can 2014-05-21 09:37:22 -07:00
test-requirements.txt Switch to pytest 2022-12-09 11:38:02 -08:00
tox.ini disable requests_mock pytest plugin 2023-05-10 14:45:33 -07:00

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://opendev.org/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 OFTC.

Thanks,

The Swift Development Team