swift/doc/source/index.rst
Matthew Oliver 0217b12b6d PDF Documentation Build tox target
This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt
to convert our SVGs.

Story: 2006122
Task: 35515
Change-Id: I26cefda80d3234df68d7152b404e0a71da74ab90
2019-10-01 15:47:11 -07:00

3.9 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_acl overview_replication ratelimit overview_large_objects overview_global_cluster overview_container_sync overview_expiring_objects cors crossdomain overview_erasure_code overview_encryption overview_backing_store overview_container_sharding ring_background ring_partpower 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 ops_runbook/index admin/index install/index

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 api/pseudo-hierarchical-folders-directories.rst api/pagination.rst api/serialized-response-formats.rst api/static-website.rst api/object-expiration.rst api/bulk-delete.rst

S3 Compatibility Info

s3_compat

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