openstack/swift
Code Issues Proposed changes

Make versioned_writes docstring more precise

Browse Source 
Add a note to the docstring that it is required to add a config section
to the proxy-server.conf and an entry to the pipeline to support history
mode.

Closes-Bug: 1619261
Change-Id: I888485ab4ece6f47db081a4d58c1aab24ce72a8a
This commit is contained in:
Christian Schwede 2016-09-01 11:42:09 +00:00
parent ac81ccd948
commit c9488027cb
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/api/object_versioning.rst
View File

@ -170,7 +170,7 @@ Example Using ``stack`` Mode
versions of it, you must **DELETE** it five times. versions of it, you must **DELETE** it five times.
Example Using ``history`` Mode Example Using ``history`` Mode
---------------------------- ------------------------------
#. Create the ``current`` container: #. Create the ``current`` container:

13
swift/common/middleware/versioned_writes.py
View File

@ -81,15 +81,22 @@ so this functionality was already available in previous releases and every
attempt was made to maintain backwards compatibility. To allow operators to attempt was made to maintain backwards compatibility. To allow operators to
perform a seamless upgrade, it is not required to add the middleware to the perform a seamless upgrade, it is not required to add the middleware to the
proxy pipeline and the flag ``allow_versions`` in the container server proxy pipeline and the flag ``allow_versions`` in the container server
configuration files are still valid. In future releases, ``allow_versions`` configuration files are still valid, but only for ``stack`` mode. In future
will be deprecated in favor of adding this middleware to the pipeline to enable releases, ``allow_versions`` will be deprecated in favor of adding this
or disable the feature. middleware to the pipeline to enable or disable the feature.
In case the middleware is added to the proxy pipeline, you must also In case the middleware is added to the proxy pipeline, you must also
set ``allow_versioned_writes`` to ``True`` in the middleware options set ``allow_versioned_writes`` to ``True`` in the middleware options
to enable the information about this middleware to be returned in a /info to enable the information about this middleware to be returned in a /info
request. request.
.. note::
You need to add the middleware to the proxy pipeline and set
``allow_versioned_writes = True`` to use the ``history`` mode. Setting
``allow_versions = True`` in the container server is not sufficient to
enable ``history`` mode.
Upgrade considerations: Upgrade considerations:
+++++++++++++++++++++++ +++++++++++++++++++++++