openstack/swift
Code Issues Proposed changes
885e02102d
swift/doc/source/getting_started.rst
David Hadas 39fc4c37bf Doc changes for new pip-requirements 
dnspython was added recently to the list of requirments.

This patch completes the change:
1. The new requirement is documented
2. The need for tox --recreate is documented
(assuming there is no way to automate 2 above)

Change-Id: I49f0cb4b01b79dd7cf4329984a2f8416378ebe19
Fixes: Bug #1176627
2013-05-06 19:21:53 +03:00

1.4 KiB
Raw Blame History

Getting Started

System Requirements

Swift development currently targets Ubuntu Server 10.04, but should work on most Linux platforms with the following software:

  • Python 2.6
  • rsync 3.0

And the following python libraries:

  • Eventlet 0.9.8
  • Setuptools
  • Simplejson
  • Xattr
  • Nose
  • Sphinx
  • Netifaces
  • Dnspython
  • Pastedeploy

Getting Swift

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.

Prebuilt packages for Ubuntu are available starting with Natty, or from PPAs for earlier releases.

Development

To get started with development with Swift, or to just play around, the following docs will be useful:

  • Swift All in One <development_saio> - Set up a VM with Swift installed
  • Development Guidelines <development_guidelines>

Production

If you want to set up and configure Swift for a production cluster, the following doc should be useful:

  • Multiple Server Swift Installation <howto_installmultinode>