ceph/doc/radosgw/swift/tutorial.rst
Kefu Chai 0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00

63 lines
3.2 KiB
ReStructuredText

==========
Tutorial
==========
The Swift-compatible API tutorials follow a simple container-based object
lifecycle. The first step requires you to setup a connection between your
client and the RADOS Gateway server. Then, you may follow a natural
container and object lifecycle, including adding and retrieving object
metadata. See example code for the following languages:
- `Java`_
- `Python`_
- `Ruby`_
.. ditaa::
+----------------------------+ +-----------------------------+
| | | |
| Create a Connection |------->| Create a Container |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| Create an Object |------->| Add/Update Object Metadata |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| List Owned Containers |------->| List a Container's Contents |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| Get an Object's Metadata |------->| Retrieve an Object |
| | | |
+----------------------------+ +-----------------------------+
|
+--------------------------------------+
|
v
+----------------------------+ +-----------------------------+
| | | |
| Delete an Object |------->| Delete a Container |
| | | |
+----------------------------+ +-----------------------------+
.. _Java: ../java
.. _Python: ../python
.. _Ruby: ../ruby