swift/doc/source/getting_started.rst
Samuel Merritt bf90ba2de1 Remove outdated Debian packaging guide.
There are 3 sections in there, all useless.

Section 1 tells you how to install Swift packages from the swift-core
PPA. However, the latest version there is ancient.

Section 2 tells you how to build your own Swift packages. However, it
talks about getting the source code from the "debian" branch in bzr,
which is obviously really old.

Section 3 tells you how to take the packages from section 2 and
install them. This isn't too out-of-date, but since section 2 doesn't
work any more, section 3 is useless.

Since stale docs are worse than no docs, there's no current
information in this document, and bringing it up-to-date requires a
whole pile of work, I've chosen to delete it entirely.

Also pulled out a couple references to the PPA elsewhere.

Fixes bug 917385.
Fixes bug 1026145.

Change-Id: I510bd8619531fe110419e5488bd20d3602868d66
2012-11-13 13:06:48 -08:00

1.4 KiB

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

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>