openstack/swift
Code Issues Proposed changes
b51dfcb45c
swift/doc/source/ring.rst

36 lines
575 B
ReStructuredText
Raw Normal View History

Initial commit of Swift code
2010-07-12 17:03:45 -05:00
.. _consistent_hashing_ring:
********************************
Partitioned Consistent Hash Ring
********************************
.. _ring:
Ring
====
.. automodule:: swift.common.ring.ring
:members:
:undoc-members:
:show-inheritance:
.. _ring-builder:
Ring Builder
============
.. automodule:: swift.common.ring.builder
:members:
:undoc-members:
:show-inheritance:
Add Composite Ring Functionality * Adds a composite_builder module which provides the functionality to build a composite ring from a number of component ring builders. * Add id to RingBuilder to differentiate rings in composite. A RingBuilder now gets a UUID when it is saved to file if it does not already have one. A RingBuilder loaded from file does NOT get a UUID assigned unless it was previously persisted in the file. This forces users to explicitly assign an id to existing ring builders by saving the state back to file. The UUID is included in first line of the output from: swift-ring-builder <builder-file> Background: This is another implementation for Composite Ring [1] to enable better dispersion for global erasure coded cluster. The most significant difference from the related-change [1] is that this solution attempts to solve the problem as an offline tool rather than dynamic compositing on the running servers. Due to the change, we gain advantages such as: - Less code and being simple - No complex state validation on the running server - Easy deployments with an offline tool This patch does not provide a command line utility for managing composite rings. The interface for such a tool is still under discussion; this patch provides the enabling functionality first. Co-Authored-By: Clay Gerrard <clay.gerrard@gmail.com> Co-Authored-By: Alistair Coles <alistairncoles@gmail.com> [1] Related-Change: I80ef36d3ac4d4b7c97a1d034b7fc8e0dc2214d16 Change-Id: I0d8928b55020592f8e75321d1f7678688301d797
2017-03-15 23:22:12 -07:00
Fix a few Sphinx warnings This precludes us from landing anything in the gate, because we treat Sphinx warnings as errors in OpenStack. Specifically, 3 warnings are fixed: /home/zuul/src/opendev.org/openstack/swift/swift/common/middleware\ /s3api/etree.py:docstring of\ swift.common.middleware.s3api.etree.Element:1:\ Inline strong start-string without end-string. duplicate object description of\ swift.common.middleware.versioned_writes, other instance in\ middleware, use :noindex: for one of them duplicate object description of\ swift.common.ring.composite_builder, other instance in\ overview_ring, use :noindex: for one of them Change-Id: I5e0bd61a301d46b2674b4605882462575b635220
2019-06-03 22:00:41 -05:00
.. _composite_builder:
Add Composite Ring Functionality * Adds a composite_builder module which provides the functionality to build a composite ring from a number of component ring builders. * Add id to RingBuilder to differentiate rings in composite. A RingBuilder now gets a UUID when it is saved to file if it does not already have one. A RingBuilder loaded from file does NOT get a UUID assigned unless it was previously persisted in the file. This forces users to explicitly assign an id to existing ring builders by saving the state back to file. The UUID is included in first line of the output from: swift-ring-builder <builder-file> Background: This is another implementation for Composite Ring [1] to enable better dispersion for global erasure coded cluster. The most significant difference from the related-change [1] is that this solution attempts to solve the problem as an offline tool rather than dynamic compositing on the running servers. Due to the change, we gain advantages such as: - Less code and being simple - No complex state validation on the running server - Easy deployments with an offline tool This patch does not provide a command line utility for managing composite rings. The interface for such a tool is still under discussion; this patch provides the enabling functionality first. Co-Authored-By: Clay Gerrard <clay.gerrard@gmail.com> Co-Authored-By: Alistair Coles <alistairncoles@gmail.com> [1] Related-Change: I80ef36d3ac4d4b7c97a1d034b7fc8e0dc2214d16 Change-Id: I0d8928b55020592f8e75321d1f7678688301d797
2017-03-15 23:22:12 -07:00
Composite Ring Builder
======================
.. automodule:: swift.common.ring.composite_builder
:members:
:undoc-members:
:show-inheritance:
Copy Permalink