Commit 9b341c2f authored by Kostas Papadimitriou's avatar Kostas Papadimitriou
Browse files

Initial split of documentation

- Moved synnefo documentation in docs dir
- Added documentation files for each synnefo package seperately
- Moved dispatcher, admin logging settings in snf-app
parent ed3b3131
......@@ -77,17 +77,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Synnefo.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/synnefo.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Synnefo.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/synnefo.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/Synnefo"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Synnefo"
@echo "# mkdir -p $$HOME/.local/share/devhelp/synnefo"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/synnefo"
@echo "# devhelp"
epub:
......
# -*- coding: utf-8 -*-
#
# Synnefo documentation build configuration file, created by
# sphinx-quickstart on Mon Nov 21 10:56:41 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..'))
from synnefo import settings
from django.core.management import setup_environ
setup_environ(settings)
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
project = u'snf-asterias-app'
copyright = u'2012, GRNET'
version = '0.8'
release = '0.8'
html_title = 'synnefo ' + version
# 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'Synnefo'
copyright = u'2011, 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.8'
# The full version, including alpha/beta/rc tags.
release = '0.8rc1'
# 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']
htmlhelp_basename = 'synnefodoc'
# 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 = 'Synnefodoc'
# -- 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': '',
intersphinx_mapping = {
'pithon': ('http://docs.python.org/', None),
'django': ('https://docs.djangoproject.com/en/dev/',
'https://docs.djangoproject.com/en/dev/_objects/')
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Synnefo.tex', u'Synnefo Documentation',
u'Authors name', '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', 'synnefo', u'Synnefo Documentation',
[u'Authors name'], 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', 'Synnefo', u'Synnefo Documentation', u'Authors name',
'Synnefo', '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'
SYNNEFO_DOCS_BASE_URL = 'http://docs.dev.grnet.gr/'
SYNNEFO_PROJECTS = {
'synnefo': 'dev',
'pithos': 'dev',
'snf-webproject': 'dev',
'snf-common': 'dev',
'snf-image': 'dev',
'snf-asterias-app': 'dev'
}
# todo extension configuration
todo_include_todos = True
for name, ver in SYNNEFO_PROJECTS.iteritems():
intersphinx_mapping[name.replace("-","")] = (SYNNEFO_DOCS_BASE_URL +
'%s/%s/' % (name, ver),
None)
# autodoc config
autodoc_default_flags = ['members']
extensions = ['sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.viewcode']
synnefo
=======
.. _snf-asterias-app:
.. image:: /images/synnefo-logo.png
Component snf-asterias-app
==========================
synnefo is software to create massively scalable IaaS clouds.
synnefo component :ref:`snf-asterias-app <snf-asterias-app>` defines
the web application for asterias. It includes the following:
It powers GRNET's `~okeanos cloud service <https://okeanos.grnet.gr>`_.
* A set of Django applications that define among others:
* web UI
* API implementation
* business logic layer
* admin web UI
* :ref:`snf-dispatcher <snf-dispatcher>`, the logic dispatcher
This is the main synnefo documentation page.
.. todo:: make this section more complete.
synnefo comprises the following major components:
.. _snf-dispatcher:
.. todo:: turn all of the following to links to the documentation, with
intersphinx links.
snf-dispatcher
--------------
.. toctree::
:maxdepth: 1
The logic dispatcher provides the context to run the business logic layer of
:ref:`asterias <snf-asterias>`. It must run on :ref:`LOGIC <LOGIC_NODE>` nodes.
asterias (name TBD): Compute Service <src/asterias.rst>
pithos+: File storage service <http://docs.dev.grnet.gr/pithos>
plankton: Image registry <src/plankton.rst>
archipelagos: Volume storage service <http://docs.dev.grnet.gr/archipelagos>
astakos: Identity management module <http://docs.dev.grnet.gr/astakos>
aquarium: Billing module <http://docs.dev.grnet.gr/aquarium>
image: Secure image deployment tool <http://docs.dev.grnet.gr/snf-image>
kamaki: Command-line cloud management tool <http://docs.dev.grnet.gr/kamaki>
The dispatcher retrieves messages from the queue, over AMQP, and calls the
appropriate handler function, based on the type of the message.
You may also see the detailed configuration for all
:ref:`synnefo software components <components>`.
.. _snf-admin:
Indices and tables
------------------
snf-admin
---------
command :command:`snf-admin` provides the command-line admin interface
for :ref:`asterias <snf-asterias>`.
Package installation
--------------------
.. todo:: kpap: verify instructions for installation from source.
Use ``pip`` to install the latest version of the package from source,
or request a specific version as ``snf-asterias-app==x.y.z``.
.. code-block:: console
$ pip install snf-asterias-app -f https://code.grnet.gr/projects/synnefo/files
On Debian Squeeze, install the ``snf-asterias-app`` Debian package.
Package configuration
---------------------
Web application
***************
Please see the configuration section of :ref:`snf-webproject <snf-webproject>`
on how to serve :ref:`snf-asterias-app <snf-asterias-app>` as part of a
Django project.
snf-dispatcher
**************
.. note:: The Debian package configures the init script for
:command:`snf-dispatcher` automatically, see ``/etc/default/snf-dispatcher``.
.. todo:: package an initscript for :command:`snf-dispatcher`
Make sure the logic dispatcher starts automatically on system boot of
:ref:`LOGIC <LOGIC_NODE>` nodes. Initscript ``conf/init.d/snf-dispatcher``
is provided for your convenience.
You may also start the dispatcher by hand:
.. code-block:: console
$ snf-dispatcher
The dispatcher should run in at least 2 instances to ensure high
(actually, increased) availability.
Package settings
----------------
Component :ref:`snf-asterias-app <snf-asterias-app>` requires the following
settings, as managed by :ref:`snf-common <snf-common>`:
.. literalinclude:: ../synnefo/app_settings/default/api.py
:lines: 4-
.. literalinclude:: ../synnefo/app_settings/default/logging.py
:lines: 4-
.. literalinclude:: ../synnefo/app_settings/default/backend.py
:lines: 4-
.. literalinclude:: ../synnefo/app_settings/default/plankton.py
:lines: 4-
.. literalinclude:: ../synnefo/app_settings/default/queues.py
:lines: 4-
.. literalinclude:: ../synnefo/app_settings/default/reconsiliation.py
:lines: 4-
.. literalinclude:: ../synnefo/app_settings/default/ui.py
:lines: 4-
.. literalinclude:: ../synnefo/app_settings/default/userdata.py
:lines: 4-
.. todo:: make sure the file headers are included properly in documentation.
If not change the :lines setting accordingly.
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _components:
===========================
Synnefo software components
===========================
Synnefo comprises a number of software components.
.. toctree::
:maxdepth: 1
snf-common
snf-webproject
snf-asterias-app
snf-asterias-ganeti-tools
snf-pithos-app
snf-pithos-backends
snf-astakos-app
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _settings-app:
Admins
******
.. literalinclude:: ../../synnefo/settings/common/admins.py
:lines: 5-
Apps
****
.. literalinclude:: ../../synnefo/settings/common/apps.py
:lines: 5-
.. _deploy-settings:
Deploy
******
.. literalinclude:: ../../synnefo/settings/common/deploy.py
:lines: 5-
.. _logging-settings:
Logging
*******
.. literalinclude:: ../../synnefo/settings/common/logging.py
:lines: 5-
.. _site-settings:
Site
****
.. literalinclude:: ../../synnefo/settings/common/site.py
:lines: 5-
.. _backend-settings:
Backend
*******
.. literalinclude:: ../../synnefo/settings/common/backend.py
:lines: 5-
.. _database-settings:
Database
********
.. literalinclude:: ../../synnefo/settings/common/database.py
:lines: 5-
.. _queues-settings:
Queues
******
.. literalinclude:: ../../synnefo/settings/common/queues.py
:lines: 5-
.. _api-settings:
Api
***
.. literalinclude:: ../../synnefo/settings/common/api.py
:lines: 5-
.. _ui-settings:
Ui
**
.. literalinclude:: ../../synnefo/settings/common/ui.py
:lines: 5-
.. _userdata-settings:
Userdata
********
.. literalinclude:: ../../synnefo/settings/common/userdata.py
:lines: 5-
.. _aai-settings:
Aai
***
.. literalinclude:: ../../synnefo/settings/common/aai.py
:lines: 5-
.. _invitations-settings:
Invitations
***********
.. literalinclude:: ../../synnefo/settings/common/invitations.py
:lines: 5-
.. _reconciliation-settings:
Reconciliation
**************
.. literalinclude:: ../../synnefo/settings/common/reconciliation.py
:lines: 5-
.. _helpdesk-settings:
Helpdesk
********
.. literalinclude:: ../../synnefo/settings/common/helpdesk.py
:lines: 5-
.. _snf-asterias-app:
Component snf-asterias-app
==========================
synnefo component :ref:`snf-asterias-app <snf-asterias-app>` defines
the web application for asterias. It includes the following:
* A set of Django applications that define among others:
* web UI
* API implementation
* business logic layer
* admin web UI
* :ref:`snf-dispatcher <snf-dispatcher>`, the logic dispatcher
.. todo:: make this section more complete.
.. _snf-dispatcher:
snf-dispatcher
--------------
The logic dispatcher provides the context to run the business logic layer of
:ref:`asterias <snf-asterias>`. It must run on :ref:`LOGIC <LOGIC_NODE>` nodes.
The dispatcher retrieves messages from the queue, over AMQP, and calls the
appropriate handler function, based on the type of the message.
.. _snf-admin:
snf-admin
---------
command :command:`snf-admin` provides the command-line admin interface
for :ref:`asterias <snf-asterias>`.
Package installation
--------------------
.. todo:: kpap: verify instructions for installation from source.
Use ``pip`` to install the latest version of the package from source,
or request a specific version as ``snf-asterias-app==x.y.z``.
.. code-block:: console
$ pip install snf-asterias-app -f https://code.grnet.gr/projects/synnefo/files
On Debian Squeeze, install the ``snf-asterias-app`` Debian package.
Package configuration
---------------------
Web application
***************
Please see the configuration section of :ref:`snf-webproject <snf-webproject>`
on how to serve :ref:`snf-asterias-app <snf-asterias-app>` as part of a
Django project.
snf-dispatcher
**************