Commit f09daefc authored by Stavros Sachtouris's avatar Stavros Sachtouris

Update documentation and version to 1.2

parent 14b6dbc9
snf-occi
========
Documentation for snf-occi is found at
snf-occi 0.2 implements the OCCI 1.1 procotol for Synnefo clouds. Since version
0.2, authentication is performed by an external keystone-compatible service,
like Astavoms.
Installation
-------------
First, you need to install the required dependencies which can be found here:
* `pyssf <https://code.grnet.gr/attachments/download/1182/pyssf-0.4.5.tar>`_
* `kamaki <https://code.grnet.gr/projects/kamaki>`_
Then you can install **snf-occi** API translation server by cloning our latest source code:
* `snf-occi <https://code.grnet.gr/projects/snf-occi>`_
**NOTE**: Before running setup.py you have to edit the **config.py** setting up:
* API Server port
* VM hostname naming pattern (FQDN providing the id of each compute resource)
* VM core architecture
Finally you can start the API translation server by running **snf-occi**
More
----
Read the docs for more documentation, or from here:
https://github.com/grnet/snf-occi/blob/master/docs/index.rst
......@@ -9,23 +9,23 @@ templates_path = ['_templates']
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'snf-occi'
copyright = u'2012, GRNET'
copyright = u'2012-2016, GRNET'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
version = '0.2'
# The full version, including alpha/beta/rc tags.
release = '0.1'
release = '0.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -159,7 +159,7 @@ latex_elements = {
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'snf-occi.tex', u'snf-occi Documentation',
u'John Giannelos', 'manual'),
u'GRNET dev tean', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
......@@ -189,7 +189,7 @@ latex_documents = [
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'snf-occi', u'snf-occi Documentation',
[u'John Giannelos'], 1)
[u'GRNET dev team'], 1)
]
# If true, show URL addresses after external links.
......@@ -203,7 +203,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
('index', 'snf-occi', u'snf-occi Documentation',
u'John Giannelos', 'snf-occi', 'One line description of project.',
u'GRNET dev team', 'snf-occi', 'One line description of project.',
'Miscellaneous'),
]
......
......@@ -3,18 +3,18 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
snf-occi's documentation!
====================================
About snf-occi
==============
**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.
**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.
**snf-occi** is based in modules provided by kamaki cli-tool when dealing with REST API calls to Openstack.
**snf-occi** is based in modules provided by kamaki library-tool when dealing with REST API calls to Openstack.
.. toctree::
:maxdepth: 2
About Open Cloud Computing Interface (OCCI)
----------
-------------------------------------------
The current OCCI specification consists of the following three documents:
* `OCCI Core <http://ogf.org/documents/GFD.183.pdf>`_
......@@ -25,7 +25,7 @@ The master document for the OCCI specification is at `OCCI Specification <http:/
OCCI and Cyclades
-----------------
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:
The OCCI implementation for Cyclades is going to be based in the OCCI 1.1 Infrastructure specification, in which common Cloud IaaS components are described. The correspondence between OCCI and Cyclades is as follows:
+-------------------------+-------------------------+
|OCCI |Cyclades |
......@@ -43,11 +43,11 @@ The OCCI implementation in Cyclades is going to be based in the OCCI Infrastruct
**Note:** Metadata info in synnefo's servers cannot be represented (clearly) using OCCI's components.
**Note:** Metadata info in Synnefo's servers cannot be represented (clearly) using OCCI's components.
OCCI requirements
------------------
-----------------
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.
OCCI operations
......@@ -100,11 +100,10 @@ Features:
Current progress
=================
By now we have considered implementing only the **Compute** backend of the OCCI to Cyclades/Openstack API bridge and we are planning to extend it for **networking** and **storage** capabilities.
By now we have considered implementing only the **Compute** backend of the OCCI to Cyclades/Openstack API bridge and we are planning to extend it for **networking** and **storage** capabilities. It is possible to implement the remaining capabilities directly for OCCI 1.2, though.
Installation
-------------
First, you need to install the required dependencies which can be found here:
* `pyssf <https://code.grnet.gr/attachments/download/1182/pyssf-0.4.5.tar>`_
......@@ -154,6 +153,19 @@ For the examples below we assume server is running on localhost (port 8888) and
curl -v -X DELETE localhost:8888/compute/$ID -H 'Auth-Token: $AUTH'
Testing
-------
A smart way to test the application is by using the `egifedcloud/fedcloud-userinterface`. Make sure you have valid and authorized proxy certificates in your ${HOME}/.globus directory, and then start a cointainer shell loaded with all necessary client tools. E.g., to perform a "list servers" operation:
::
$ docker run -v /home/saxtouri/.globus:/root/.globus -it egifedcloud/fedcloud-userinterface /bin/bash
# fetch-crl -p 20
# voms-proxy-init --voms fedcloud.egi.eu -rfc
Your proxy is stored at /tmp/x509up_u0
# occi --endpoint https://snf-occi.example.com --action list --resource compute -n x509 -x /tmp/x509up_u0 -X
Indices and tables
==================
......
......@@ -17,7 +17,7 @@ from setuptools import setup
setup(
name='snf-occi',
version='0.1',
version='0.2',
description='OCCI to Openstack/Cyclades API bridge',
url='http://code.grnet.gr/projects/snf-occi',
license='BSD',
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment