Revision 1c366ac9 docs/developers/clients-api.rst

b/docs/developers/clients-api.rst
11 11 
Since Synnefo services are build as OpenStack extensions, an inheritance
12 12 
approach has been chosen for implementing clients for both. In specific,
13 13 
the *compute*, *storage* and *image* modules are client implementations for the
14 
OpenStack compute and OpenStack object-store APIs, respectively. The rest of the
15 
modules implement the Synnefo extensions (i.e., *cyclades* and
14 
OpenStack compute, OpenStack object-store and Image APIs respectively. The rest
15 
of the modules implement the Synnefo extensions (i.e., *cyclades* and
16 16 
*cyclades_rest_api* extents *compute*, *pithos* and *pithos_rest_api* extent
17 
*storage*) or novel Synnefo services (*image* for *plankton*).
17 
*storage*).
18 18 

  		





  19
  19
  
    
Setup a client instance


  		





  20
  20
  
    
-----------------------


  		





  ......




  45
  45
  
    
-----------------------------------


  		





  46
  46
  
    

  		





  47
  47
  
    
In OpenStack, each service (e.g., `compute`, `object-store`, etc.) has a number


  		





  48
  
  
    
of `endpoints`. These `endpoints` are actually URIs that are used by kamaki as


  		





  
  48
  
    
of `endpoints`. These `endpoints` are URIs that are used by kamaki as


  		





  49
  49
  
    
prefixes to form the corresponding API calls. Client applications need just


  		





  50
  50
  
    
one of these these `endpoints`, namely the `publicURL`, which is also referred


  		





  51
  51
  
    
to as `base_url` in kamaki client libraries.


  		





  ......




  56
  56
  
    
        (Example 1.2)


  		





  57
  57
  
    
    2. Use them to instantiate an AstakosClient


  		





  58
  58
  
    
        (Example 1.2)


  		





  59
  
  
    
    3. Use AstakosClient instance to get the endpoints of the service of interest


  		





  
  59
  
    
    3. Use AstakosClient instance to get endpoints for the service of interest


  		





  60
  60
  
    
        (Example 1.3)


  		





  61
  61
  
    
    4. The 'publicURL' endpoint is the base_url we are looking for


  		





  62
  62
  
    
        (Example 1.3)


  		





  ......




  99
  99
  
    
The ``get_service_endpoints`` method is called with the service name as an


  		





  100
  100
  
    
argument. Here are the service names for the kamaki clients::


  		





  101
  101
  
    

  		





  102
  
  
    
    storage.StorageClient, pithos.PithosClient      -->     object-store


  		





  103
  
  
    
    compute.ComputeClient, cyclades.CycladesClient  -->     compute


  		





  104
  
  
    
    image.ImageClient                               -->     image


  		





  105
  
  
    
    astakos.AstakosClient                           -->     identity, account


  		





  
  102
  
    
    storage.StorageClient, pithos.PithosClient            --> object-store


  		





  
  103
  
    
    compute.ComputeClient, cyclades.CycladesClient        --> compute


  		





  
  104
  
    
    network.NetworkClient, cyclades.CycladesNetworkClient --> network


  		





  
  105
  
    
    image.ImageClient                                     --> image


  		





  
  106
  
    
    astakos.AstakosClient                                 --> identity, account


  		





  106
  107
  
    

  		





  107
  108
  
    
Use client methods


  		





  108
  109
  
    
------------------


  		












Also available in:
  Unified diff