openstack/swift
Code Issues Proposed changes
52a6595033
swift/doc/source/misc.rst

219 lines
3.2 KiB
ReStructuredText
Raw Normal View History

Initial commit of Swift code
2010-07-12 17:03:45 -05:00
.. _misc:
****
Misc
****
.. _exceptions:
Exceptions
==========
.. automodule:: swift.common.exceptions
:members:
:undoc-members:
:show-inheritance:
.. _constraints:
Constraints
===========
.. automodule:: swift.common.constraints
:members:
:undoc-members:
:show-inheritance:
.. _utils:
Utils
=====
.. automodule:: swift.common.utils
:members:
:show-inheritance:
Renaming TestAuth to TempAuth because nose hates anything with the word test in it.
2011-05-26 02:24:12 +00:00
.. _common_tempauth:
Incorporated Swauth into Swift as an optional DevAuth replacement.
2010-12-01 17:08:49 -08:00
Renaming TestAuth to TempAuth because nose hates anything with the word test in it.
2011-05-26 02:24:12 +00:00
TempAuth
Remove swauth; update references from swauth to testauth.
2011-05-26 02:17:42 +00:00
========
Incorporated Swauth into Swift as an optional DevAuth replacement.
2010-12-01 17:08:49 -08:00
Renaming TestAuth to TempAuth because nose hates anything with the word test in it.
2011-05-26 02:24:12 +00:00
.. automodule:: swift.common.middleware.tempauth
Incorporated Swauth into Swift as an optional DevAuth replacement.
2010-12-01 17:08:49 -08:00
:members:
:show-inheritance:
Documentation of the new auth and acls middleware modules and bugfixes
2010-09-03 22:33:41 -07:00
.. _acls:
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
KeystoneAuth
============
.. automodule:: swift.common.middleware.keystoneauth
:members:
:show-inheritance:
Documentation of the new auth and acls middleware modules and bugfixes
2010-09-03 22:33:41 -07:00
ACLs
====
.. automodule:: swift.common.middleware.acl
:members:
:show-inheritance:
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
.. _wsgi:
WSGI
====
.. automodule:: swift.common.wsgi
:members:
:show-inheritance:
.. _direct_client:
Direct Client
=============
.. automodule:: swift.common.direct_client
:members:
:undoc-members:
:show-inheritance:
Added an internal client. Refactored object expirer to use this client. Change-Id: Ibeca6dba873f8b4a558ecf3ba6e8d23d36f545b0
2012-05-04 18:07:22 +00:00
.. _internal_client:
Internal Client
===============
.. automodule:: swift.common.internal_client
:members:
:undoc-members:
:show-inheritance:
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
.. _buffered_http:
Buffered HTTP
=============
.. automodule:: swift.common.bufferedhttp
:members:
:show-inheritance:
.. _healthcheck:
Healthcheck
===========
Updated docs (including SAIO) to refelct the paste.deploy config changes
2010-08-20 02:19:50 +00:00
.. automodule:: swift.common.middleware.healthcheck
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
:members:
:show-inheritance:
Add documentation for Swift Recon. Change-Id: I37f4fb624bdc5b8bbf2e691d29aa6b15cd648aa8
2011-10-18 21:10:50 +00:00
.. _recon:
Recon
===========
.. automodule:: swift.common.middleware.recon
:members:
:show-inheritance:
Initial commit of Swift code
2010-07-12 17:03:45 -05:00
.. _memecached:
MemCacheD
=========
.. automodule:: swift.common.memcached
:members:
:show-inheritance:
adding source docs
2010-10-13 08:43:37 -07:00
review cleanup
2011-02-14 14:52:49 -06:00
Manager
=========
.. automodule:: swift.common.manager
:members:
:show-inheritance:
Reverted the pulling out of various middleware: RateLimit StaticWeb TempURL/FormPOST Change-Id: I988e93e6f4aacb817a2e354d43a04e47516fdf88
2012-05-16 21:08:34 +00:00
Ratelimit
=========
.. automodule:: swift.common.middleware.ratelimit
:members:
:show-inheritance:
StaticWeb
=========
.. automodule:: swift.common.middleware.staticweb
:members:
:show-inheritance:
TempURL
=======
.. automodule:: swift.common.middleware.tempurl
:members:
:show-inheritance:
FormPost
========
.. automodule:: swift.common.middleware.formpost
:members:
:show-inheritance:
Domain Remap
============
.. automodule:: swift.common.middleware.domain_remap
:members:
:show-inheritance:
CNAME Lookup
============
.. automodule:: swift.common.middleware.cname_lookup
:members:
:show-inheritance:
Move proxy server logging to middleware. Change-Id: I771c87207d4e1821e32c3424b341d182cc7ea7c0
2012-05-24 21:15:51 -07:00
Proxy Logging
=============
.. automodule:: swift.common.middleware.proxy_logging
:members:
:show-inheritance:
Adding CORS support Change-Id: I894473994cdfea0996ad16e7619aff421f604abc
2012-10-11 16:52:26 -05:00
Bulk Requests: auto extract archive and bulk delete middleware. Fix small problem in ratelimiting middleware. DocImpact Change-Id: Ide3e0b9f4887626c30cae0b97eb7e2237b1df3ed
2013-01-24 12:34:56 -08:00
Bulk Operations (Delete and Archive Auto Extraction)
====================================================
.. automodule:: swift.common.middleware.bulk
:members:
:show-inheritance:
Basic container quotas Add a new middleware implementing some basic container quotas. Quotas are subject to several limitations: eventual consistency, the timeliness of the cached container_info (60 second ttl by default), and it’s unable to reject chunked transfer uploads that exceed the quota (though once the quota is exceeded, new chunked transfers will be refused). However, they get most of the way to container quotas fairly inexpensively. Quotas are set by adding meta values to the container, and are validated when set: X-Container-Meta-Quota-Bytes: Maximum size of the container, in bytes. X-Container-Meta-Quota-Count: Maximum object count of the container. DocImpact Change-Id: I77cfbf6dc231a2e522bd67328e4c082424a93eee
2013-01-31 21:53:47 -08:00
Container Quotas
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
================
Basic container quotas Add a new middleware implementing some basic container quotas. Quotas are subject to several limitations: eventual consistency, the timeliness of the cached container_info (60 second ttl by default), and it’s unable to reject chunked transfer uploads that exceed the quota (though once the quota is exceeded, new chunked transfers will be refused). However, they get most of the way to container quotas fairly inexpensively. Quotas are set by adding meta values to the container, and are validated when set: X-Container-Meta-Quota-Bytes: Maximum size of the container, in bytes. X-Container-Meta-Quota-Count: Maximum object count of the container. DocImpact Change-Id: I77cfbf6dc231a2e522bd67328e4c082424a93eee
2013-01-31 21:53:47 -08:00
.. automodule:: swift.common.middleware.container_quotas
:members:
:show-inheritance:
Update documentation for account_quota middleware Change-Id: I3dc7930ee2a1eb26b1f60e83fce2bc1bea0a8b0f
2013-04-03 10:29:50 +02:00
Account Quotas
==============
.. automodule:: swift.common.middleware.account_quotas
:members:
:show-inheritance:
Static Large Object Support DocImpact Change-Id: I7edaa5e44208ab451f7f7566b64bb571b8eea1f9
2013-02-13 12:31:55 -08:00
.. _slo-doc:
Static Large Objects
====================
.. automodule:: swift.common.middleware.slo
:members:
:show-inheritance:
Support listing endpoints for an object. Implements blueprint list-endpoints. DocImpact: new middleware list_endpoints. Change-Id: I0c4911ff726abd4cb8ce2b6245c99786ad46b410
2013-02-01 22:50:21 +04:00
List Endpoints
==============
.. automodule:: swift.common.middleware.list_endpoints
:members:
:show-inheritance:
Copy Permalink