openstack/swift
Code Issues Proposed changes

update the getting started doc

Browse Source 
Change-Id: I0a96bcf692bb240f3ab5aab7fefd294a07735a83
This commit is contained in:
John Dickinson 2015-02-16 14:00:24 -08:00
parent bf0e01c488
commit 949804eda4
1 changed files with 29 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/source/getting_started.rst
View File

@ -7,38 +7,34 @@ System Requirements
-------------------
Swift development currently targets Ubuntu Server 14.04, but should work on
most Linux platforms with the following software:
most Linux platforms.
* Python 2.6 or 2.7
Swift is written in Python and has these dependencies:
* 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>`_
And the following python libraries:
* Eventlet 0.9.15
* Setuptools
* Simplejson
* Xattr
* Nose
* Sphinx
* Netifaces
* Dnspython
* Pastedeploy
Python 2.6 should work, but it's not actively tested. There is no current
support for Python 3.
-------------
Getting Swift
-------------
Swift's source code is hosted on github and managed with git. The current trunk can be checked out like this:
Swift's source code is hosted on github and managed with git. The current
trunk can be checked out like this:
``git clone https://github.com/openstack/swift.git``
A source tarball for the latest release of Swift is available on the `launchpad project page <https://launchpad.net/swift>`_.
A source tarball for the latest release of Swift is available on the
`launchpad project page <https://launchpad.net/swift>`_.
Prebuilt packages for Ubuntu are available starting with Natty, or from PPAs for earlier releases.
Prebuilt packages for Ubuntu and RHEL variants are available.
* `Swift Ubuntu Packages <https://launchpad.net/ubuntu/+source/swift>`_
* `Swift PPA Archive <https://launchpad.net/~swift-core/+archive/release>`_
* `Swift RDO Packages <https://openstack.redhat.com/Repositories>`_
-----------
Development
@ -47,13 +43,26 @@ Development
To get started with development with Swift, or to just play around, the
following docs will be useful:
* :doc:`Swift All in One <development_saio>` - Set up a VM with Swift installed
* :doc:`Swift All in One <development_saio>` - Set up a VM with Swift
installed
* :doc:`Development Guidelines <development_guidelines>`
* `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>`_
----------
Production
----------
If you want to set up and configure Swift for a production cluster, the following doc should be useful:
If you want to set up and configure Swift for a production cluster, the
following doc should be useful:
* :doc:`Multiple Server Swift Installation <howto_installmultinode>`