src/ceph/doc/radosgw/swift/tutorial.rst

   1 ==========
   2  Tutorial
   3 ==========
   4
   5 The Swift-compatible API tutorials follow a simple container-based object
   6 lifecycle. The first step requires you to setup a connection between your
   7 client and the RADOS Gateway server. Then, you may follow a natural
   8 container and object lifecycle, including adding and retrieving object
   9 metadata. See example code for the following languages:
  10
  11 - `Java`_
  12 - `Python`_
  13 - `Ruby`_
  14
  15
  16 .. ditaa:: +----------------------------+        +-----------------------------+
  17            |                            |        |                             |
  18            |    Create a Connection     |------->|      Create a Container     |
  19            |                            |        |                             |
  20            +----------------------------+        +-----------------------------+
  21                                                                 |
  22                          +--------------------------------------+
  23                          |
  24                          v
  25            +----------------------------+        +-----------------------------+
  26            |                            |        |                             |
  27            |     Create an Object       |------->| Add/Update Object Metadata  |
  28            |                            |        |                             |
  29            +----------------------------+        +-----------------------------+
  30                                                                 |
  31                          +--------------------------------------+
  32                          |
  33                          v
  34            +----------------------------+        +-----------------------------+
  35            |                            |        |                             |
  36            |   List Owned Containers    |------->| List a Container's Contents |
  37            |                            |        |                             |
  38            +----------------------------+        +-----------------------------+
  39                                                                 |
  40                          +--------------------------------------+
  41                          |
  42                          v
  43            +----------------------------+        +-----------------------------+
  44            |                            |        |                             |
  45            | Get an Object's Metadata   |------->|     Retrieve an Object      |
  46            |                            |        |                             |
  47            +----------------------------+        +-----------------------------+
  48                                                                 |
  49                          +--------------------------------------+
  50                          |
  51                          v
  52            +----------------------------+        +-----------------------------+
  53            |                            |        |                             |
  54            |      Delete an Object      |------->|      Delete a Container     |
  55            |                            |        |                             |
  56            +----------------------------+        +-----------------------------+
  57
  58 .. _Java: ../java
  59 .. _Python: ../python
  60 .. _Ruby: ../ruby