openstack/swift
Code Issues Proposed changes
8801b74090
swift/doc/source/misc.rst

206 lines
4.0 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:
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
CORS Headers
============
Cross Origin RequestS or CORS allows the browser to make requests against
Swift from another origin via the browser. This enables the use of HTML5
forms and javascript uploads to swift. The owner of a container can set
three headers:
+---------------------------------------------+-------------------------------+
|Metadata | Use |
+=============================================+===============================+
|X-Container-Meta-Access-Control-Allow-Origin | Origins to be allowed to |
| | make Cross Origin Requests, |
| | space separated |
+---------------------------------------------+-------------------------------+
|X-Container-Meta-Access-Control-Max-Age | Max age for the Origin to |
| | hold the preflight results. |
+---------------------------------------------+-------------------------------+
|X-Container-Meta-Access-Control-Allow-Headers| Headers to be allowed in |
| | actual request by browser. |
+---------------------------------------------+-------------------------------+
When the browser does a request it can issue a preflight request. The
preflight request is the OPTIONS call that verifies the Origin is allowed
to make the request.
* Browser makes OPTIONS request to Swift
* Swift returns 200/401 to browser based on allowed origins
* If 200, browser makes PUT, POST, DELETE, HEAD, GET request to Swift
CORS should be used in conjunction with TempURL and FormPost.
Copy Permalink