openstack/swift
Code Issues Proposed changes
28c4b7310f
swift/doc/source/misc.rst

132 lines
1.7 KiB
ReStructuredText
Raw Normal View History

Initial commit of Swift code
2010-07-12 17:03:45 -05:00
.. _misc:
****
Misc
****
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _acls:
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
ACLs
====
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.middleware.acl
:members:
:show-inheritance:
.. _buffered_http:
Buffered HTTP
=============
.. automodule:: swift.common.bufferedhttp
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
:members:
:show-inheritance:
.. _constraints:
Constraints
===========
.. automodule:: swift.common.constraints
:members:
:undoc-members:
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Container Sync Realms
=====================
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.container_sync_realms
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
:members:
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _direct_client:
Add flag to stop swob from always using absolute location. This is needed for SOS (along with patch https://github.com/dpgoetz/sos/pull/37) to work with swift 1.12 . By spec you should always use the absolute location but this causes a problem with staticweb over a cdn using a cname. Basically you want to be able to forward the browser to a relative location instead of whatever full url the proxy server thinks you are using. Change-Id: I3fa1d415bf9b566be069458b838f7e65db0c4f39
2014-01-22 13:03:51 -08:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Direct Client
=============
Add flag to stop swob from always using absolute location. This is needed for SOS (along with patch https://github.com/dpgoetz/sos/pull/37) to work with swift 1.12 . By spec you should always use the absolute location but this causes a problem with staticweb over a cdn using a cname. Basically you want to be able to forward the browser to a relative location instead of whatever full url the proxy server thinks you are using. Change-Id: I3fa1d415bf9b566be069458b838f7e65db0c4f39
2014-01-22 13:03:51 -08:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.direct_client
Add flag to stop swob from always using absolute location. This is needed for SOS (along with patch https://github.com/dpgoetz/sos/pull/37) to work with swift 1.12 . By spec you should always use the absolute location but this causes a problem with staticweb over a cdn using a cname. Basically you want to be able to forward the browser to a relative location instead of whatever full url the proxy server thinks you are using. Change-Id: I3fa1d415bf9b566be069458b838f7e65db0c4f39
2014-01-22 13:03:51 -08:00
:members:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
:undoc-members:
Add flag to stop swob from always using absolute location. This is needed for SOS (along with patch https://github.com/dpgoetz/sos/pull/37) to work with swift 1.12 . By spec you should always use the absolute location but this causes a problem with staticweb over a cdn using a cname. Basically you want to be able to forward the browser to a relative location instead of whatever full url the proxy server thinks you are using. Change-Id: I3fa1d415bf9b566be069458b838f7e65db0c4f39
2014-01-22 13:03:51 -08:00
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _exceptions:
Incorporated Swauth into Swift as an optional DevAuth replacement.
2010-12-01 17:08:49 -08:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Exceptions
==========
Incorporated Swauth into Swift as an optional DevAuth replacement.
2010-12-01 17:08:49 -08:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.exceptions
Incorporated Swauth into Swift as an optional DevAuth replacement.
2010-12-01 17:08:49 -08:00
:members:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
:undoc-members:
Incorporated Swauth into Swift as an optional DevAuth replacement.
2010-12-01 17:08:49 -08:00
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _internal_client:
Documentation of the new auth and acls middleware modules and bugfixes
2010-09-03 22:33:41 -07:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Internal Client
===============
Add generated keystone documentation to misc.rst. - Change a bit the formatting of the documention as well. - Fix WARNING: Title underline too short. in misc.rst. Change-Id: I2f4e36bcb5e01e984f0af0152bc5b3b9f7e942ce
2013-01-25 14:27:08 +01:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.internal_client
Add generated keystone documentation to misc.rst. - Change a bit the formatting of the documention as well. - Fix WARNING: Title underline too short. in misc.rst. Change-Id: I2f4e36bcb5e01e984f0af0152bc5b3b9f7e942ce
2013-01-25 14:27:08 +01:00
:members:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
:undoc-members:
Add generated keystone documentation to misc.rst. - Change a bit the formatting of the documention as well. - Fix WARNING: Title underline too short. in misc.rst. Change-Id: I2f4e36bcb5e01e984f0af0152bc5b3b9f7e942ce
2013-01-25 14:27:08 +01:00
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Manager
=========
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.manager
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
:members:
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
MemCacheD
=========
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.memcached
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
:members:
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _request_helpers:
Added an internal client. Refactored object expirer to use this client. Change-Id: Ibeca6dba873f8b4a558ecf3ba6e8d23d36f545b0
2012-05-04 18:07:22 +00:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Request Helpers
Added an internal client. Refactored object expirer to use this client. Change-Id: Ibeca6dba873f8b4a558ecf3ba6e8d23d36f545b0
2012-05-04 18:07:22 +00:00
===============
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.request_helpers
Added an internal client. Refactored object expirer to use this client. Change-Id: Ibeca6dba873f8b4a558ecf3ba6e8d23d36f545b0
2012-05-04 18:07:22 +00:00
:members:
:undoc-members:
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _swob:
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Swob
====
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.swob
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
:members:
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
:special-members: __call__
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _utils:
adding source docs
2010-10-13 08:43:37 -07:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
Utils
=====
New container sync configuration option Summary of the new configuration option: The cluster operators add the container_sync middleware to their proxy pipeline and create a container-sync-realms.conf for their cluster and copy this out to all their proxy and container servers. This file specifies the available container sync "realms". A container sync realm is a group of clusters with a shared key that have agreed to provide container syncing to one another. The end user can then set the X-Container-Sync-To value on a container to //realm/cluster/account/container instead of the previously required URL. The allowed hosts list is not used with this configuration and instead every container sync request sent is signed using the realm key and user key. This offers better security as source hosts can be faked much more easily than faking per request signatures. Replaying signed requests, assuming it could easily be done, shouldn't be an issue as the X-Timestamp is part of the signature and so would just short-circuit as already current or as superceded. This also makes configuration easier for the end user, especially with difficult networking situations where a different host might need to be used for the container sync daemon since it's connecting from within a cluster. With this new configuration option, the end user just specifies the realm and cluster names and that is resolved to the proper endpoint configured by the operator. If the operator changes their configuration (key or endpoint), the end user does not need to change theirs. DocImpact Change-Id: Ie1704990b66d0434e4991e26ed1da8b08cb05a37
2013-12-08 09:13:59 +00:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. automodule:: swift.common.utils
New container sync configuration option Summary of the new configuration option: The cluster operators add the container_sync middleware to their proxy pipeline and create a container-sync-realms.conf for their cluster and copy this out to all their proxy and container servers. This file specifies the available container sync "realms". A container sync realm is a group of clusters with a shared key that have agreed to provide container syncing to one another. The end user can then set the X-Container-Sync-To value on a container to //realm/cluster/account/container instead of the previously required URL. The allowed hosts list is not used with this configuration and instead every container sync request sent is signed using the realm key and user key. This offers better security as source hosts can be faked much more easily than faking per request signatures. Replaying signed requests, assuming it could easily be done, shouldn't be an issue as the X-Timestamp is part of the signature and so would just short-circuit as already current or as superceded. This also makes configuration easier for the end user, especially with difficult networking situations where a different host might need to be used for the container sync daemon since it's connecting from within a cluster. With this new configuration option, the end user just specifies the realm and cluster names and that is resolved to the proper endpoint configured by the operator. If the operator changes their configuration (key or endpoint), the end user does not need to change theirs. DocImpact Change-Id: Ie1704990b66d0434e4991e26ed1da8b08cb05a37
2013-12-08 09:13:59 +00:00
:members:
:show-inheritance:
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
.. _wsgi:
New container sync configuration option Summary of the new configuration option: The cluster operators add the container_sync middleware to their proxy pipeline and create a container-sync-realms.conf for their cluster and copy this out to all their proxy and container servers. This file specifies the available container sync "realms". A container sync realm is a group of clusters with a shared key that have agreed to provide container syncing to one another. The end user can then set the X-Container-Sync-To value on a container to //realm/cluster/account/container instead of the previously required URL. The allowed hosts list is not used with this configuration and instead every container sync request sent is signed using the realm key and user key. This offers better security as source hosts can be faked much more easily than faking per request signatures. Replaying signed requests, assuming it could easily be done, shouldn't be an issue as the X-Timestamp is part of the signature and so would just short-circuit as already current or as superceded. This also makes configuration easier for the end user, especially with difficult networking situations where a different host might need to be used for the container sync daemon since it's connecting from within a cluster. With this new configuration option, the end user just specifies the realm and cluster names and that is resolved to the proper endpoint configured by the operator. If the operator changes their configuration (key or endpoint), the end user does not need to change theirs. DocImpact Change-Id: Ie1704990b66d0434e4991e26ed1da8b08cb05a37
2013-12-08 09:13:59 +00:00
Alphabetized items under "Misc" in source documentation I alphabetized the items under "Misc" in the source documentation to make them easier to locate. Change-Id: I1badca7a97e7d887fefac0be2e2208eec52cec60
2014-02-20 19:19:09 -07:00
WSGI
====
.. automodule:: swift.common.wsgi
New container sync configuration option Summary of the new configuration option: The cluster operators add the container_sync middleware to their proxy pipeline and create a container-sync-realms.conf for their cluster and copy this out to all their proxy and container servers. This file specifies the available container sync "realms". A container sync realm is a group of clusters with a shared key that have agreed to provide container syncing to one another. The end user can then set the X-Container-Sync-To value on a container to //realm/cluster/account/container instead of the previously required URL. The allowed hosts list is not used with this configuration and instead every container sync request sent is signed using the realm key and user key. This offers better security as source hosts can be faked much more easily than faking per request signatures. Replaying signed requests, assuming it could easily be done, shouldn't be an issue as the X-Timestamp is part of the signature and so would just short-circuit as already current or as superceded. This also makes configuration easier for the end user, especially with difficult networking situations where a different host might need to be used for the container sync daemon since it's connecting from within a cluster. With this new configuration option, the end user just specifies the realm and cluster names and that is resolved to the proper endpoint configured by the operator. If the operator changes their configuration (key or endpoint), the end user does not need to change theirs. DocImpact Change-Id: Ie1704990b66d0434e4991e26ed1da8b08cb05a37
2013-12-08 09:13:59 +00:00
:members:
:show-inheritance:
Add Storage Policy Documentation Add overview and example information for using Storage Policies. DocImpact Implements: blueprint storage-policies Change-Id: I6f11f7a1bdaa6f3defb3baa56a820050e5f727f1
2014-04-07 14:22:27 -07:00
.. _storage_policy:
Storage Policy
==============
.. automodule:: swift.common.storage_policy
:members:
:show-inheritance:
Copy Permalink