2010-07-20 11:05:10 -05:00
|
|
|
===============
|
|
|
|
|
Getting Started
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
-------------------
|
|
|
|
|
System Requirements
|
|
|
|
|
-------------------
|
|
|
|
|
|
2014-10-24 15:34:45 -07:00
|
|
|
Swift development currently targets Ubuntu Server 14.04, but should work on
|
2015-02-16 14:00:24 -08:00
|
|
|
most Linux platforms.
|
2010-07-20 11:05:10 -05:00
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
Swift is written in Python and has these dependencies:
|
2010-07-20 11:05:10 -05:00
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
* Python 2.7
|
|
|
|
|
* rsync 3.0
|
|
|
|
|
* The Python packages listed in `the requirements file <https://github.com/openstack/swift/blob/master/requirements.txt>`_
|
|
|
|
|
* Testing additionally requires `the test dependencies <https://github.com/openstack/swift/blob/master/test-requirements.txt>`_
|
2013-05-05 22:07:42 +03:00
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
Python 2.6 should work, but it's not actively tested. There is no current
|
|
|
|
|
support for Python 3.
|
2010-07-20 11:05:10 -05:00
|
|
|
|
2011-03-01 15:24:15 +00:00
|
|
|
-------------
|
|
|
|
|
Getting Swift
|
|
|
|
|
-------------
|
|
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
Swift's source code is hosted on github and managed with git. The current
|
|
|
|
|
trunk can be checked out like this:
|
2011-03-01 15:24:15 +00:00
|
|
|
|
2011-11-07 17:21:46 +01:00
|
|
|
``git clone https://github.com/openstack/swift.git``
|
2011-03-01 15:24:15 +00:00
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
A source tarball for the latest release of Swift is available on the
|
|
|
|
|
`launchpad project page <https://launchpad.net/swift>`_.
|
2011-03-01 15:24:15 +00:00
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
Prebuilt packages for Ubuntu and RHEL variants are available.
|
2011-03-01 15:24:15 +00:00
|
|
|
|
2012-11-09 18:01:34 -08:00
|
|
|
* `Swift Ubuntu Packages <https://launchpad.net/ubuntu/+source/swift>`_
|
2015-02-16 14:00:24 -08:00
|
|
|
* `Swift RDO Packages <https://openstack.redhat.com/Repositories>`_
|
2011-03-01 15:24:15 +00:00
|
|
|
|
2010-07-20 11:05:10 -05:00
|
|
|
-----------
|
|
|
|
|
Development
|
|
|
|
|
-----------
|
|
|
|
|
|
2010-09-21 10:56:41 -05:00
|
|
|
To get started with development with Swift, or to just play around, the
|
2010-07-20 11:05:10 -05:00
|
|
|
following docs will be useful:
|
|
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
* :doc:`Swift All in One <development_saio>` - Set up a VM with Swift
|
|
|
|
|
installed
|
2010-07-20 11:05:10 -05:00
|
|
|
* :doc:`Development Guidelines <development_guidelines>`
|
2015-02-16 14:00:24 -08:00
|
|
|
* `Associated Projects <http://docs.openstack.org/developer/swift/associated_projects.html>`
|
|
|
|
|
|
|
|
|
|
--------------------------
|
|
|
|
|
CLI client and SDK library
|
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
|
|
There are many clients in the `ecosystem <http://docs.openstack.org/developer/swift/associated_projects.html#application-bindings>`_. The official CLI
|
|
|
|
|
and SDK is python-swiftclient.
|
|
|
|
|
|
|
|
|
|
* `Source code <https://github.com/openstack/python-swiftclient>`_
|
|
|
|
|
* `Python Package Index <https://pypi.python.org/pypi/python-swiftclient>`_
|
2010-07-20 11:05:10 -05:00
|
|
|
|
|
|
|
|
----------
|
|
|
|
|
Production
|
|
|
|
|
----------
|
|
|
|
|
|
2015-02-16 14:00:24 -08:00
|
|
|
If you want to set up and configure Swift for a production cluster, the
|
|
|
|
|
following doc should be useful:
|
2010-11-04 14:25:23 -05:00
|
|
|
|
2011-01-14 13:49:05 -06:00
|
|
|
* :doc:`Multiple Server Swift Installation <howto_installmultinode>`
|
