Synnefo » ./kamaki

Kamaki features a clients API for building third-party client applications that

communicate with OpenStack and / or Synnefo cloud services. The package is

called kamaki.clients and servers as a lib.

A showcase of an application built on kamaki.clients is kamaki.cli, the command

line interface of kamaki.

Since synnefo services are build as OpenStack extensions, an inheritance

approach has been chosen for implementing clients for both. In specific,

the *compute*, *storage* and *image* modules are clients of the OS compute, OS

object-store, respectively. On the contrary, all the other modules are Synnefo

extensions (*cyclades* extents *compute*, *pithos* and *pithos_rest_api*

extent *storage*) or novel synnefo services (e.g. *astakos* for IM, *image*

for *plankton*).

.. note:: *cyclades* and *pithos* clients inherit all methods of *compute*

    and *storage* clients respectively. Separate compute or storage objects

    should be used only when implementing applications for strict OS Compute or

    OS Storage services.

Client methods can now be called. Developers are advised to

consult :ref:`the-client-api-ref` for details on the available methods and how

to use them.

In the following example, the *cyclades* and *pithos* clients of example 1.1

are used to extract some information, that is then printed to the standard

output.

The kamaki.clients standard error is ClientError. A ClientError is raised for

any kind of kamaki.clients errors (errors reported by servers, type errors in

arguments, etc.).