OpenStack Storage (Swift)
Go to file
Christian Schwede e1140666d6 Add support to increase object ring partition power
This patch adds methods to increase the partition power of an existing
object ring without downtime for the users using a 3-step process. Data
won't be moved to other nodes; objects using the new increased partition
power will be located on the same device and are hardlinked to avoid
data movement.

1. A new setting "next_part_power" will be added to the rings, and once
the proxy server reloaded the rings it will send this value to the
object servers on any write operation. Object servers will now create a
hard-link in the new location to the original DiskFile object. Already
existing data will be relinked using a new tool in the new locations
using hardlinks.

2. The actual partition power itself will be increased. Servers will now
use the new partition power to read from and write to. No longer
required hard links in the old object location have to be removed now by
the relinker tool; the relinker tool reads the next_part_power setting
to find object locations that need to be cleaned up.

3. The "next_part_power" flag will be removed.

This mostly implements the spec in [1]; however it's not using an
"epoch" as described there. The idea of the epoch was to store data
using different partition powers in their own namespace to avoid
conflicts with auditors and replicators as well as being able to abort
such an operation and just remove the new tree.  This would require some
heavy change of the on-disk data layout, and other object-server
implementations would be required to adopt this scheme too.

Instead the object-replicator is now aware that there is a partition
power increase in progress and will skip replication of data in that
storage policy; the relinker tool should be simply run and afterwards
the partition power will be increased. This shouldn't take that much
time (it's only walking the filesystem and hardlinking); impact should
be low therefore. The relinker should be run on all storage nodes at the
same time in parallel to decrease the required time (though this is not
mandatory). Failures during relinking should not affect cluster
operations - relinking can be even aborted manually and restarted later.

Auditors are not quarantining objects written to a path with a different
partition power and therefore working as before (though they are reading
each object twice in the worst case before the no longer needed hard
links are removed).

Co-Authored-By: Alistair Coles <alistair.coles@hpe.com>
Co-Authored-By: Matthew Oliver <matt@oliver.net.au>
Co-Authored-By: Tim Burke <tim.burke@gmail.com>

[1] https://specs.openstack.org/openstack/swift-specs/specs/in_progress/
increasing_partition_power.html

Change-Id: I7d6371a04f5c1c4adbb8733a71f3c177ee5448bb
2017-06-15 15:08:48 -07:00
api-ref/source add name_check to /info 2017-03-21 10:58:41 +00:00
bin Add support to increase object ring partition power 2017-06-15 15:08:48 -07:00
doc Add support to increase object ring partition power 2017-06-15 15:08:48 -07:00
etc Enable per policy proxy config options 2017-05-23 20:22:30 +01:00
examples Add a user variable to templates 2013-09-17 11:46:04 +10:00
install-guide/source Merge "Fix install guide filter:authtoken config example" 2017-05-01 10:17:58 +00:00
releasenotes authors/changelog for 2.14.0 2017-04-26 11:46:18 -07:00
swift Add support to increase object ring partition power 2017-06-15 15:08:48 -07:00
test Add support to increase object ring partition power 2017-06-15 15:08:48 -07:00
.alltests Apply bash error handling consistently in all bash scripts 2016-10-11 22:13:06 +02:00
.coveragerc Fix .coveragrc to prevent nose tests error 2015-09-21 10:06:29 +01:00
.functests Merge "Apply bash error handling consistently in all bash scripts" 2016-10-14 18:03:04 +00:00
.gitignore Add .eggs/* to .gitignore 2016-03-22 11:53:49 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:05:49 -04:00
.mailmap authors/changelog for 2.14.0 2017-04-26 11:46:18 -07: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 authors/changelog for 2.14.0 2017-04-26 11:46:18 -07:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
bandit.yaml Updating Bandit config file 2016-09-16 09:20:34 -07:00
bindep.txt fix bindep file to enable func test in centos 2017-02-28 15:54:53 -05:00
CHANGELOG authors/changelog for 2.14.0 2017-04-26 11:46:18 -07:00
CONTRIBUTING.rst Rework the contributor docs 2016-05-05 22:02:47 -07:00
LICENSE Convert LICENSE to use unix style line endings. 2012-12-19 12:48:27 -05:00
MANIFEST.in Fix locale directory in MANIFEST.in 2016-05-19 15:56:15 +02:00
README.rst Optimize the link address 2017-04-10 15:23:05 +05:30
requirements.txt Update pyeclib dependency to 1.3.1 2016-10-06 11:22:26 -07:00
REVIEW_GUIDELINES.rst added a quote 2017-01-05 10:24:09 -08:00
setup.cfg Add support to increase object ring partition power 2017-06-15 15:08:48 -07:00
setup.py taking the global reqs that we can 2014-05-21 09:37:22 -07:00
test-requirements.txt Make Sphinx treat warnings as errors 2017-03-06 23:55:40 +00:00
tox.ini Support EC policy for in process functional tests 2017-03-09 10:42:34 +00:00

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

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.

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

Complete API documentation at http://docs.openstack.org/api/openstack-object-storage/1.0/content/

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