Revision efa0d1ef docs/index.rst

b/docs/index.rst
6 6
snf-occi's documentation!
7 7
====================================
8 8

  
9
**snf-occi** implements OCCI specifications to synnefo's API in order to achieve greater interoperability in common tasks refering cyclades management. This module is a translation bridge between OCCI and Openstack API and is designed to be as independent as possible from the rest IaaS, providing an OCCI compatibility layer to other services using Openstack API. 
9
**snf-occi** snf-occi implements the OCCI specification on top of synnefo’s API in order to achieve greater interoperability in common tasks referring cyclades management. This module is a translation bridge between OCCI and the Openstack API and is designed to be as independent as possible from the rest IaaS, providing an OCCI compatibility layer to other services using Openstack API. 
10 10

  
11 11
**snf-occi** is based in modules provided by kamaki cli-tool when dealing with REST API calls to Openstack.
12 12

  
......
15 15

  
16 16
About OCCI
17 17
----------
18
Current OCCI specification consists of the following three documents:
18
The current OCCI specification consists of the following three documents:
19 19

  
20 20
* `OCCI Core <http://ogf.org/documents/GFD.183.pdf>`_
21 21
* `OCCI Infrastructure <http://ogf.org/documents/GFD.184.pdf>`_
......
23 23

  
24 24
OCCI and Cyclades
25 25
-----------------
26
OCCI implementation in Cyclades is going to be based in the **OCCI Infrastructure** specifications, in which common Cloud IaaS components are described. Below you can see the matching components between OCCI and Cyclades:
26
The OCCI implementation in Cyclades is going to be based in the OCCI Infrastructure specification, in which common Cloud IaaS components are described. The correspondence between OCCI and Cyclades is as follows:
27 27

  
28 28
+-------------------------+-------------------------+
29 29
|OCCI                     |Cyclades                 |
......
48 48
------------------
49 49
Due to OCCI's structure there cannot be straightforward mapping to Cyclades/OpenStack API. The missing elements are networking and storage capabilities using current Cyclades API.
50 50

  
51
**Note:** Quantum API support is being planned.
52

  
53 51
OCCI operations
54 52
****************
55 53

  
......
114 112

  
115 113
* `snf-occi <https://code.grnet.gr/projects/snf-occi>`_ 
116 114

  
117
**NOTE** :Before running setup.py you have to edit the **config.py** setting up:
115
**NOTE**: Before running setup.py you have to edit the **config.py** setting up:
118 116

  
119 117
* API Server port
120 118
* VM hostname naming pattern (FQDN providing the id of each compute resource)

Also available in: Unified diff