2010-07-20 11:05:10 -05:00
|
|
|
===============
|
|
|
|
|
Getting Started
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
-------------------
|
|
|
|
|
System Requirements
|
|
|
|
|
-------------------
|
|
|
|
|
|
2023-05-16 15:36:00 -07:00
|
|
|
Swift development currently targets Ubuntu Server 22.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
|
|
|
|
2023-05-16 15:36:00 -07:00
|
|
|
* Python (2.7 or 3.6-3.10)
|
2022-08-01 17:13:25 -07:00
|
|
|
* rsync 3.x
|
|
|
|
|
* `liberasurecode <https://opendev.org/openstack/liberasurecode/>`__
|
|
|
|
|
* 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>`__
|
|
|
|
|
* Testing requires `these distribution packages <https://github.com/openstack/swift/blob/master/bindep.txt>`__
|
2013-05-05 22:07:42 +03: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-07-28 19:15:25 -04: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-07-28 19:15:25 -04:00
|
|
|
* :doc:`First Contribution to Swift <first_contribution_swift>`
|
2015-07-21 09:56:13 -07:00
|
|
|
* :doc:`Associated Projects <associated_projects>`
|
2015-02-16 14:00:24 -08:00
|
|
|
|
|
|
|
|
--------------------------
|
|
|
|
|
CLI client and SDK library
|
|
|
|
|
--------------------------
|
|
|
|
|
|
2017-07-12 12:14:45 -07:00
|
|
|
There are many clients in the :ref:`ecosystem <application-bindings>`. The official CLI
|
2015-02-16 14:00:24 -08:00
|
|
|
and SDK is python-swiftclient.
|
|
|
|
|
|
2023-03-24 14:11:44 +08:00
|
|
|
* `Source code <https://opendev.org/openstack/python-swiftclient>`__
|
2022-08-01 17:13:25 -07:00
|
|
|
* `Python Package Index <https://pypi.org/project/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
|
|
|
|
2023-05-16 15:31:13 -07:00
|
|
|
* :doc:`install/index`
|
