2010-11-12 12:54:07 -06:00
|
|
|
..
|
2012-04-23 10:48:24 -05:00
|
|
|
Copyright 2010-2012 OpenStack LLC
|
2010-11-12 12:54:07 -06:00
|
|
|
All Rights Reserved.
|
|
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
|
|
|
not use this file except in compliance with the License. You may obtain
|
|
|
|
|
a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
|
License for the specific language governing permissions and limitations
|
|
|
|
|
under the License.
|
|
|
|
|
|
2010-07-12 17:03:45 -05:00
|
|
|
Welcome to Swift's documentation!
|
|
|
|
|
=================================
|
|
|
|
|
|
2010-07-20 11:05:10 -05:00
|
|
|
Swift is a highly available, distributed, eventually consistent object/blob
|
2010-11-12 12:54:07 -06:00
|
|
|
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
|
2012-04-23 10:48:24 -05:00
|
|
|
be found on the `OpenStack wiki`_ and at http://docs.openstack.org.
|
2010-11-12 12:54:07 -06:00
|
|
|
|
|
|
|
|
.. _`OpenStack wiki`: http://wiki.openstack.org
|
2010-07-20 11:05:10 -05:00
|
|
|
|
Added associated_projects.rst
In the interest of keeping the core Swift code repository less
complex, but still offering a quick way to find associated projects
that enhance or use Swift, I've added this new Associated Projects
page prominently to the Swift documentation.
This will allow much less barrier to entry on enhancing Swift as
other projects can work independently and will only need to wait on
the core Swift project for approval of minimal tweaks to the core
Swift code base.
It will also allow an easy central place to find cool associated
projects that otherwise might go unnoticed or even duplicated.
The plan is to move non-essential projects that are currently
embedded in the Swift repository out into their own projects with
links to them on this new page. This would include items such as
(just what I can think of right now): bin/swift command line tool and
clients, swift-bench, swift-dispersion, TempURL, FormPost, StaticWeb,
Rate Limiting, Swift3, Domain Remap, and CNAME Lookup.
After all that is done, those projects will be able to move forward
much more quickly and new developers for Swift itself will have much
less to learn and get confused about.
Change-Id: Ib8447d8bd480f0a3d8f0413137ccdba73a11dd91
2012-05-04 03:25:36 +00:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
|
|
If you're looking for associated projects that enhance or use Swift, please see the :ref:`associated_projects` page.
|
|
|
|
|
|
|
|
|
|
|
2010-07-20 11:05:10 -05:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
getting_started
|
|
|
|
|
|
2010-11-12 12:54:07 -06:00
|
|
|
Overview and Concepts
|
|
|
|
|
=====================
|
2010-07-12 17:03:45 -05:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2013-01-22 15:24:06 -08:00
|
|
|
Swift's API docs <http://docs.openstack.org/api/openstack-object-storage/1.0/content/>
|
2010-07-20 11:05:10 -05:00
|
|
|
overview_architecture
|
2010-07-12 17:03:45 -05:00
|
|
|
overview_ring
|
|
|
|
|
overview_reaper
|
|
|
|
|
overview_auth
|
|
|
|
|
overview_replication
|
2012-05-16 21:08:34 +00:00
|
|
|
ratelimit
|
2010-11-23 14:26:48 -08:00
|
|
|
overview_large_objects
|
2011-12-29 11:29:19 -06:00
|
|
|
overview_object_versioning
|
2011-02-24 15:01:22 -08:00
|
|
|
overview_container_sync
|
2011-10-26 21:42:24 +00:00
|
|
|
overview_expiring_objects
|
2013-01-15 19:31:42 +00:00
|
|
|
cors
|
2013-03-25 18:48:25 +00:00
|
|
|
crossdomain
|
Added associated_projects.rst
In the interest of keeping the core Swift code repository less
complex, but still offering a quick way to find associated projects
that enhance or use Swift, I've added this new Associated Projects
page prominently to the Swift documentation.
This will allow much less barrier to entry on enhancing Swift as
other projects can work independently and will only need to wait on
the core Swift project for approval of minimal tweaks to the core
Swift code base.
It will also allow an easy central place to find cool associated
projects that otherwise might go unnoticed or even duplicated.
The plan is to move non-essential projects that are currently
embedded in the Swift repository out into their own projects with
links to them on this new page. This would include items such as
(just what I can think of right now): bin/swift command line tool and
clients, swift-bench, swift-dispersion, TempURL, FormPost, StaticWeb,
Rate Limiting, Swift3, Domain Remap, and CNAME Lookup.
After all that is done, those projects will be able to move forward
much more quickly and new developers for Swift itself will have much
less to learn and get confused about.
Change-Id: Ib8447d8bd480f0a3d8f0413137ccdba73a11dd91
2012-05-04 03:25:36 +00:00
|
|
|
associated_projects
|
2010-07-12 17:03:45 -05:00
|
|
|
|
2010-11-12 12:54:07 -06:00
|
|
|
Developer Documentation
|
|
|
|
|
=======================
|
2010-07-12 17:03:45 -05:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
development_guidelines
|
|
|
|
|
development_saio
|
2010-09-03 20:47:43 -07:00
|
|
|
development_auth
|
2010-07-12 17:03:45 -05:00
|
|
|
|
2010-11-12 12:54:07 -06:00
|
|
|
Administrator Documentation
|
|
|
|
|
===========================
|
2010-07-23 17:15:29 -05:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2010-10-28 17:01:50 -05:00
|
|
|
|
2010-11-04 14:25:23 -05:00
|
|
|
howto_installmultinode
|
2010-07-23 17:15:29 -05:00
|
|
|
deployment_guide
|
2013-05-11 14:31:42 -07:00
|
|
|
apache_deployment_guide
|
2010-07-30 14:57:20 -05:00
|
|
|
admin_guide
|
2012-12-17 06:39:25 -05:00
|
|
|
replication_network
|
2010-07-23 17:15:29 -05:00
|
|
|
|
2010-11-12 12:54:07 -06:00
|
|
|
Source Documentation
|
|
|
|
|
====================
|
2010-07-12 17:03:45 -05:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
ring
|
|
|
|
|
proxy
|
|
|
|
|
account
|
|
|
|
|
container
|
|
|
|
|
db
|
|
|
|
|
object
|
|
|
|
|
misc
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
|
|
|
|
|
2013-01-22 15:24:06 -08:00
|
|
|
|