--- /dev/null
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/snf-occi.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/snf-occi.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/snf-occi"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/snf-occi"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
--- /dev/null
+import sys, os
+
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#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'
+
+# 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'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'snf-occidoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'snf-occi.tex', u'snf-occi Documentation',
+ u'John Giannelos', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'snf-occi', u'snf-occi Documentation',
+ [u'John Giannelos'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'snf-occi', u'snf-occi Documentation',
+ u'John Giannelos', 'snf-occi', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+intersphinx_mapping = {
+ 'python': ('http://docs.python.org/', None),
+ 'django': ('https://docs.djangoproject.com/en/dev/',
+ 'https://docs.djangoproject.com/en/dev/_objects/')
+}
--- /dev/null
+.. snf-occi documentation master file, created by
+ sphinx-quickstart on Mon Mar 26 13:45:54 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to snf-occi's documentation!
+====================================
+
+snf-occi implements OCCI specifications to synnefo's API in order to achieve greater interoperability in common tasks refering cyclades management.
+
+.. toctree::
+ :maxdepth: 2
+
+About OCCI
+----------
+Current OCCI specification consists of the following three documents:
+
+* `OCCI Core <http://ogf.org/documents/GFD.183.pdf>`_
+* `OCCI Infrastructure <http://ogf.org/documents/GFD.184.pdf>`_
+* `OCCI HTTP rendering <http://ogf.org/documents/GFD.185.pdf>`_
+
+OCCI and Cyclades
+-----------------
+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:
+
++----------------+------------------+
+|OCCI |Cyclades |
++================+==================+
+|Compute linked |Synnefo servers |
+|to Storage | |
++----------------+------------------+
+|Mixin |Synnefo images |
+| | |
++----------------+------------------+
+|Mixin |Synnefo flavors |
++----------------+------------------+
+|Network |Network and |
+| |NetworkInterfaces |
+| |from |
+| |synnefo.db.models |
++----------------+------------------+
+|NetworkInterface|NetworkLink in |
+| |synnefo.db.models |
++----------------+------------------+
+
+**Note:** Metadata info in synnefo's servers cannot be represented (clearly) using OCCI's components.
+
+
+Call mapping from OCCI to Cyclades API
+---------------------------------------
+Due to OCCI's structure there cannot be straightforward mapping to Cyclades/OpenStack API. The missing elements are:
+
+* Networking capabilities using current Cyclades API (networking is supported, but not in OCCI's format)
+* OCCI seperates the compute resource from the storage or image/flavor. As a result synnefo's servers cannot be represented only with OCCI's Compute.
+
+OCCI operations-Mapping
+***********************
+
+Below you can see the required procedures/operations for OCCI compatibility, and their mappings to Cyclades API (if possible).
+
+* Handling the query interface
+ * Query interface must be found under path /-/
+ * Retrieve all registered Kinds, Actions and Mixins
+ * Add a mixin definition
+ * Remove a mixin definition
+
+* Operation on paths in the name-space
+ * Retrieving the state of the name-space hierarchy
+ * Retrieving all Resource instances below a path
+ * Deletion of all Resource instances below a path
+
+* Operations on Mixins and Kinds
+ * Retrieving all Resource instances belonging to Mixin or Kind
+ * Triggering actions to all instances of a Mixin or a Kind
+ * Associate resource instances with a Mixin or a Kind
+ * Full update of a Mixin collection
+ * Dissociate resource instances from a Mixin
+
+* Operations on Resource instances
+ * Creating a resource instance
+ * Compute: api.server.create_server()
+ * Network: -
+ * Storage: -
+ * Retrieving a resource instance
+ * Compute: api.server.get_server_details()
+ * Network: -
+ * Storage: -
+ * Partial update of a resource instance
+ * Compute: api.actions.resize()
+ * Network: -
+ * Storage: -
+ * Full update of a resource instance
+ * Compute: -
+ * Network: -
+ * Storage: -
+ * Delete a resource instance
+ * Compute: api.server.delete_server()
+ * Network: -
+ * Storage: -
+ * Triggering an action on a resource instance
+ * Compute: api.actions.start(), api.actions.shutdown(), api.actions.reboot()
+ * Network: -
+ * Storage: -
+
+* Handling Link instances **(not well-defined in Cyclades API)**
+ * Inline creation of a Link instance
+ * Retrieving Resource instances with defined Links
+ * Creating of Link Resource instance
+
+
+OCCI client/server library
+==========================
+
+occi-py is a generic library implementation of the Open Cloud Computing Interface (OCCI). It aims to provide a high-level interface for the integration of OCCI to other new or existing applications.
+
+Features:
+---------
+
+* It includes a REST API service with the OCCI specifications already implemented
+* It only requires a custom backend to interact with Cyclades
+* Being a python wsgi application, occi-py is easily deployed with Django or with its default web-server (tornado).
+
+Package on pypi: `OCCI 0.6 <http://pypi.python.org/pypi/occi/0.6>`_
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+
--- /dev/null
+#!/usr/bin/env python
+
+from kamaki.clients.compute import ComputeClient
+from kamaki.config import Config
+
+from occi.core_model import Mixin
+from occi.backend import ActionBackend, KindBackend, MixinBackend
+from occi.extensions.infrastructure import COMPUTE, START, STOP, SUSPEND, RESTART, RESOURCE_TEMPLATE, OS_TEMPLATE
+
+from occi.wsgi import Application
+
+from wsgiref.simple_server import make_server
+from wsgiref.validate import validator
+
+
+class MyBackend(KindBackend, ActionBackend):
+ '''
+ An very simple abstract backend which handles update and replace for
+ attributes. Support for links and mixins would need to added.
+ '''
+
+ def update(self, old, new, extras):
+ # here you can check what information from new_entity you wanna bring
+ # into old_entity
+
+ # trigger your hypervisor and push most recent information
+ print('Updating a resource with id: ' + old.identifier)
+ for item in new.attributes.keys():
+ old.attributes[item] = new.attributes[item]
+
+ def replace(self, old, new, extras):
+ print('Replacing a resource with id: ' + old.identifier)
+ old.attributes = {}
+ for item in new.attributes.keys():
+ old.attributes[item] = new.attributes[item]
+ old.attributes['occi.compute.state'] = 'inactive'
+
+
+class ComputeBackend(MyBackend):
+ '''
+ A Backend for compute instances.
+ '''
+
+ def create(self, entity, extras):
+ entity.attributes['occi.compute.state'] = 'active'
+ entity.actions = [STOP, SUSPEND, RESTART]
+
+ for mixin in entity.mixins:
+ print mixin.term
+ print mixin.attributes
+
+ print('Creating the virtual machine with id: ' + entity.identifier)
+
+
+ def retrieve(self, entity, extras):
+ # triggering cyclades to retrieve up to date information
+
+ if entity.attributes['occi.compute.state'] == 'inactive':
+ entity.actions = [START]
+ if entity.attributes['occi.compute.state'] == 'active':
+ entity.actions = [STOP, SUSPEND, RESTART]
+ if entity.attributes['occi.compute.state'] == 'suspended':
+ entity.actions = [START]
+
+ def delete(self, entity, extras):
+ # call the management framework to delete this compute instance...
+ print('Removing representation of virtual machine with id: '
+ + entity.identifier)
+
+ def action(self, entity, action, extras):
+ if action not in entity.actions:
+ raise AttributeError("This action is currently no applicable.")
+ elif action == START:
+ entity.attributes['occi.compute.state'] = 'active'
+ # read attributes from action and do something with it :-)
+ print('Starting virtual machine with id' + entity.identifier)
+ elif action == STOP:
+ entity.attributes['occi.compute.state'] = 'inactive'
+ # read attributes from action and do something with it :-)
+ print('Stopping virtual machine with id' + entity.identifier)
+ elif action == RESTART:
+ entity.attributes['occi.compute.state'] = 'active'
+ # read attributes from action and do something with it :-)
+ print('Restarting virtual machine with id' + entity.identifier)
+ elif action == SUSPEND:
+ entity.attributes['occi.compute.state'] = 'suspended'
+ # read attributes from action and do something with it :-)
+ print('Suspending virtual machine with id' + entity.identifier)
+
+
+class MyAPP(Application):
+ '''
+ An OCCI WSGI application.
+ '''
+
+ def __call__(self, environ, response):
+ sec_obj = {'username': 'password'}
+ return self._call_occi(environ, response, security=sec_obj, foo=None)
+
+if __name__ == '__main__':
+
+ APP = MyAPP()
+
+ COMPUTE_BACKEND = ComputeBackend()
+
+ APP.register_backend(COMPUTE, COMPUTE_BACKEND)
+ APP.register_backend(START, COMPUTE_BACKEND)
+ APP.register_backend(STOP, COMPUTE_BACKEND)
+ APP.register_backend(RESTART, COMPUTE_BACKEND)
+ APP.register_backend(SUSPEND, COMPUTE_BACKEND)
+ APP.register_backend(RESOURCE_TEMPLATE, MixinBackend())
+ APP.register_backend(OS_TEMPLATE, MixinBackend())
+
+
+ snf = ComputeClient(Config())
+ images = snf.list_images()
+ for image in images:
+ IMAGE = Mixin("http://schemas.ogf.org/occi/infrastructure#", str(image['name']), [OS_TEMPLATE])
+ APP.register_backend(IMAGE, MixinBackend())
+
+ flavors = snf.list_flavors()
+ for flavor in flavors:
+ FLAVOR_ATTRIBUTES = {'occi.compute.cores': snf.get_flavor_details(flavor['id'])['cpu'],
+ 'occi.compute.memory': snf.get_flavor_details(flavor['id'])['ram'],
+ 'occi.storage.size': snf.get_flavor_details(flavor['id'])['disk'],
+ }
+ FLAVOR =Mixin("http://schemas.ogf.org/occi/infrastructure#", str(flavor['name']), [RESOURCE_TEMPLATE], attributes = FLAVOR_ATTRIBUTES)
+ APP.register_backend(FLAVOR, MixinBackend())
+
+ VALIDATOR_APP = validator(APP)
+
+ HTTPD = make_server('', 8888, VALIDATOR_APP)
+ HTTPD.serve_forever()
+
projects / snf-occi / commitdiff