swift/doc/source/index.rst
Donagh McCabe b8fa480808 Added links to API reference and usage guides
Added a link to the API reference (where headers and query
strings are documented; click the "detail" button to see).
Also added a reference to Swift section of the OpenStack end
user guide. This contains some additional details about the API.

No attempt was made to reconcile duplicate information. Instead
this patch links documents that might otherwise be overlooked.
However, I fixed text, originally in a table, that had become
garbled in a prior patch.

Change-Id: I0910cbeb0c8bffc00e510f35585603e7b7a67790
2016-02-17 18:39:22 +00:00

3.4 KiB

Welcome to Swift's documentation!

Swift is a highly available, distributed, eventually consistent object/blob store. Organizations can use Swift to store lots of data efficiently, safely, and cheaply.

This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Swift and other components of OpenStack can be found on the OpenStack wiki and at http://docs.openstack.org.

Note

If you're looking for associated projects that enhance or use Swift, please see the associated_projects page.

getting_started

Overview and Concepts

api/object_api_v1_overview overview_architecture overview_ring overview_policies overview_reaper overview_auth overview_replication ratelimit overview_large_objects overview_object_versioning overview_container_sync overview_expiring_objects cors crossdomain overview_erasure_code overview_backing_store associated_projects

Developer Documentation

development_guidelines development_saio first_contribution_swift policies_saio development_auth development_middleware development_ondisk_backends

Administrator Documentation

howto_installmultinode deployment_guide apache_deployment_guide admin_guide replication_network logs

Object Storage v1 REST API Documentation

See Complete Reference for the Object Storage REST API

The following provides supporting information for the REST API:

api/object_api_v1_overview.rst api/discoverability.rst api/authentication.rst api/container_quotas.rst api/object_versioning.rst api/large_objects.rst api/temporary_url_middleware.rst api/form_post_middleware.rst api/use_content-encoding_metadata.rst api/use_the_content-disposition_metadata.rst

OpenStack End User Guide

The OpenStack End User Guide has additional information on using Swift. See the Manage objects and containers section.

Source Documentation

ring proxy account container db object misc middleware

Indices and tables

  • genindex
  • modindex
  • search