openstack/swift
Code Issues Proposed changes

Update docs for new ring serialization.

Browse Source 
The Admin Guide now contains information about the ring serialization
change (and importantly, how to downgrade, if necessary).

Also added container-server conf var, "allow_versions" to the Deployment
Guide.

Also changed description of proxy-server conf var,
"max_containers_whitelist" to say it contains "account names" not
"account hashes".

Change-Id: Ib23c6118cc5195cc04765afd28e442e4c735f0d4
This commit is contained in:
Darrell Bishop 2012-08-21 10:03:42 -07:00
parent 73b00ca9de
commit af2ff124eb
3 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/admin_guide.rst
View File

@ -6,11 +6,28 @@ Administrator's Guide
Managing the Rings Managing the Rings
------------------ ------------------
You need to build the storage rings on the proxy server node, and You may build the storage rings on any server with the appropriate
distribute them to all the servers in the cluster. Storage rings version of Swift installed. Once built or changed (rebalanced), you
contain information about all the Swift storage partitions and how must distribute the rings to all the servers in the cluster. Storage
they are distributed between the different nodes and disks. For more rings contain information about all the Swift storage partitions and
information see :doc:`overview_ring`. how they are distributed between the different nodes and disks.
Swift 1.6.0 is the last version to use a Python pickle format.
Subsequent versions use a different serialization format. **Rings
generated by Swift versions 1.6.0 and earlier may be read by any
version, but rings generated after 1.6.0 may only be read by Swift
versions greater than 1.6.0.** So when upgrading from version 1.6.0 or
earlier to a version greater than 1.6.0, either upgrade Swift on your
ring building server **last** after all Swift nodes have been successfully
upgraded, or refrain from generating rings until all Swift nodes have
been successfully upgraded.
If you need to downgrade from a version of swift greater than 1.6.0 to
a version less than or equal to 1.6.0, first downgrade your ring-building
server, generate new rings, push them out, then continue with the rest
of the downgrade.
For more information see :doc:`overview_ring`.
Removing a device from the ring:: Removing a device from the ring::

3
doc/source/deployment_guide.rst
View File

@ -351,6 +351,7 @@ set log_facility LOG_LOCAL0 Syslog log facility
set log_level INFO Logging level set log_level INFO Logging level
node_timeout 3 Request timeout to external services node_timeout 3 Request timeout to external services
conn_timeout 0.5 Connection timeout to external services conn_timeout 0.5 Connection timeout to external services
allow_versions false Enable/Disable object versioning feature
================== ================ ======================================== ================== ================ ========================================
[container-replicator] [container-replicator]
@ -592,7 +593,7 @@ max_containers_per_account 0 If set to a positive value,
recheck_account_existence before recheck_account_existence before
the 403s kick in. the 403s kick in.
max_containers_whitelist This is a comma separated list max_containers_whitelist This is a comma separated list
of account hashes that ignore of account names that ignore
the max_containers_per_account the max_containers_per_account
cap. cap.
rate_limit_after_segment 10 Rate limit the download of rate_limit_after_segment 10 Rate limit the download of

2
doc/source/overview_ring.rst
View File

@ -29,7 +29,7 @@ Ring Builder
The rings are built and managed manually by a utility called the ring-builder. The rings are built and managed manually by a utility called the ring-builder.
The ring-builder assigns partitions to devices and writes an optimized Python The ring-builder assigns partitions to devices and writes an optimized Python
structure to a gzipped, pickled file on disk for shipping out to the servers. structure to a gzipped, serialized file on disk for shipping out to the servers.
The server processes just check the modification time of the file occasionally The server processes just check the modification time of the file occasionally
and reload their in-memory copies of the ring structure as needed. Because of and reload their in-memory copies of the ring structure as needed. Because of
how the ring-builder manages changes to the ring, using a slightly older ring how the ring-builder manages changes to the ring, using a slightly older ring