Synnefo

/dist

Changelog

=========

2011-10-21, v0.7.3

------------------

FIXES:

	UI:

		* Fix two UI glitches with Firefox 3.6 (#1545, #1546)

2011-10-19, v0.7.2

------------------

FIXES:

    UI:

	    * Fix regressions with flavor sorting and image size checking

		  (#1429, #1507)

2011-10-17, v0.7.1

------------------

FIXES:

    UI:

        * Fix Enter/Esc on machine rename not working in the UI (#1501)

	    * Fix UI barfs if a VM is based on an Image with state=DELETED (#1494)

        * Fix UI user logout action does not work (#1497)

    Images:	

		* Fix erroneous reference to $(HELPER_DIR) in /etc/default /snf-image (#1498)

		* Fix typo in snf-image-helper ChangePassword task (#1500)

		* Show timestamps on execution of helper tasks in snf-image helper VM (#1499)

    Deployment:

		* Improve check for Ganeti master in snf-ganeti-eventd init script (#1323)

		* Fix snf-ganeti-eventd init script ignored defaults file (#1505)

2011-10-13, v0.7

----------------

NEW FEATURES:

    UI:

        * From the ground-up rebuilt, refactored MVC-based UI (#1443)

        * Document all settings introduced due to UI refactoring (#1447)

        * UI asset files versioning (#1460)

        * Improve feedback on completed steps during machine creation (#1461)

    Images:

        * Completely re-engineered image deployment mechanism based on

          snf-image Ganeti OS provider, in isolated helper VM

        * Support public and private images (#555)

        * Support handling of VM filesystem, injection of arbitrary files

          on VM creation (#491)

        * Implement file injection as a task in snf-image (#1095)

        * Remove all-host based processing of (potentially user-provided)

          Images (#969)

    API:

        * Implement <personality> tag in OpenStack Compute API

          for file injection (#985, #1093)

        * Update API implementation for server/image metadata based on latest

          draft version of spec (#1403)

        * Support deletion of Flavors, support servers referring to

          inexistent (deleted) Flavors (#1157)

    Admin:

        * Addition of --meta option to snf-admin image for easy setting

          of image metadata values on image creation (#1107)

    Deployment:

        * Initial iteration of a system test suite, snf-burnin,

          for end-to-end testing of Synnefo deployments (#1155)

        * Re-engineered logging mechanism, for finer-grained control (#1033)

        * Add init script for snf-ganeti-eventd, fix Debian packaging (#1323)

        * Document removal of Flavors from circulation (#1472)

        * Add generic service unavailable template (#1359)

FIXES:

    UI:

        * Fix problems when reusing the Create machine wizard with IE8 (#997)

        * Fix problematic update of the networks tab and minor fixes (#861)

        * Fix "Connecting" and "progress" gif in networks tab (#863)

        * Fix inconsistencies on machine transitions between views (#917)

        * Fix IE rendering mode (#975)

        * Fix UI machine/network creation overlays style clutter (#979)

        * Have UI should reset action confirmations after state change (#981)

        * UI barfs due to exception on "New Machine" wizard (#1473)

        * UI throws exception on single-server view (#1483)

    API:

        * Fix incomplete constraints in ImageMetadata Model (#1255)

    Deployment:

        * Split initial_data.json to work around South "feature" (#1263)

        * Fix missing snf-ganeti-instance-image package dependency (#1319)

    Kamaki:

        * The kamaki client lib uses the root logger (#1337)

        * The kamaki client lib fails to set server metadata (#1399)

    Invitations:

        * FIx bug causing HTTP 500 error on /invitations/login (#1407)

        * Fix sort order of flavors, sort by actual characteristicts (#1429)

        * Fix display of error modal boxes, do notrefresh or display another

          error (#1433)

        * Fix positioning of machines in "Destroying" (#1437)

        * Fix Metadata button shown as clickable while it's not (#1441)

    Images:

        * Missing dependency on 'qemu-img' in snf-image-helper (#1484)

    Logic:

        * Fix messages left in the queue due to unknown Ganeti opcodes (#1492)

2011-09-15, v0.6.2

------------------

FIXES:

    UI:

        * Fix handling of Images in state=DELETED,

          allow sorting and categorization of Images in the UI (#823)

        * Fix the "Create New wizard" does not honor selection of

          "small/medium/large" images (#1129)

    Admin:

        * Fix the admin interface throws exception on the

          Invitations tab (1105)

    API:

        * Make API responses uncacheable (#1091)

    Logic:

        * Fix The dispatcher leaving messages unprocessed for

          unknown Ganeti opcodes(#1111)

NEW FEATURES:

    Admin:

        * Support filtering based on state, support image registration

          with mandatory type argument, make all deletion operations

          set state to DELETED (#849)

    API:

        * Allow marking flavors as removed, honor deleted flag (#1055)

2011-09-13, v0.6.1

------------------

FIXES:

    UI:

        * Make all AJAX requests to the API uncache-able

2011-09-12, v0.6

----------------

NEW FEATURES:

    Admin:

        * Initial version of new Web-based admininstration panel, allows

          management of Synnefo entities directly on the DB (#849)

        * Allow setting https apiurl and token in cloud tool (#853)

    Deployment:

        * Overhauled reconciliation mechanism, unit tests (#1021, #811)

    UI:

        * Overhaul CPU/RAM/disk sliders in UI to be more intuitive (#843)

        * Support setting of small, medium large flavors in UI (#815)

        * Have the UI filter flavors, depending on image size (#817)

        * Better, error-specific handling of error codes in UI (#971)

        * Implement retrieval of authentication token from the UI (#977)

        * Re-worked invitation UI is more vocal on errors, supports pagination

          (#1039)

        * Support a list of UI-specific metadata keys to be copied from Image

          to newly-created Server (#847)

    Images:

        * Support dd-based deployment of Windows and Linux images, using only

          dd-based sequential I/O, get rid of ntfsclone (#965, #1007)

FIXES:

    UI:

        * Fix Opera failing with "too old changes-since value" when idle (#521)

        * Fix UI problems with Firefox 3.5.x (#781)

        * Fix server statistics not refreshing properly in the UI (#881)

        * Machine rename icon not visible on IE (#909)

        * Fix list view fail not updating machine state properly (#915)

        * Fix colors in "Error" state (#953)

        * Fix the confirmation bar disappearing at times (#955)

        * Hide all actions when in state "Destroying..." (#957)

        * Disable connect action when machine has no ip set (#983)

        * Update image details on last vm creation step overlay on IE (#1011)

        * Fix list view displays UI error when servers are updated on IE

          (#1013)

        * Make "Add invitation", remove invitation button appear clickable

          (#1019)

    Logic:

        * Fix Logic layer complaining about certain Ganeti opcodes (#1031)

2011-08-29, v0.5.5

FIXES:

    Logic:

        * Bugfixes, reconnect to AMQP properly when connection drops,

          added more DEBUG- and INFO-level logging messages.

2011-07-27, v0.5.4

FIXES:

    UI:

        * Numerous bugfixes, most in response to user feedback from

          the Alpha deployment

        * #813 (Minor UI issues), #857 (long machine names),

          #865 (problem when user has zero invitations),

          #873 (generic 404 template), #895 (default username in RDP file),

          #897 (show spinner for the public network), 899 (allow Connect

          from the network UI), #901 (cannot select password for copying

          with Chrome), #893 (firewall profile selection behaves as a single

          list for all servers), #903 (cannot copy paste IPv4 in icon view),

          #905 (Javascript throws exception when left idle), #907 (similar

          issue with #907), #913 (list view alert message)

    Images:

        * ntfsclone does not use all of the available space on the target (#879)

    Deployment:

        * Move fix_amqp_settings to queue system init code (#809)

    Admin:

        * snf-admin user invite is not non-ascii friendly (#943)

        * snf-user should show email addresses, even without any arguments (#871)

FEATURES:

    UI:

        * Show completion percentage when a machine is being built (#887)

    API:

        * Report percentage completion for machines in BUILD (#891)

    Images:

        * The image deployment layer should report completion to the API layer

          (#889)

    Deployment:

        * Drop ganeti-eventd & snf-ganeti-hook synnefo dependency (#691)

        * Split Synnefo Ganeti tools to separate project under snf-ganeti-tools/

        * Import code for building Debian packages, refactor repository (#691)

2011-07-19, v0.5.3.1

FIXES:

    API:

        * Fix bug with firewall code using inexistent, removed setting

    GUI:

        * Fix bug with invitations UI (#859)

        * Fix bug with feedback form submission raising HTTP 500

    Deployment:

        * Fix bug with error reporting by the invitations app

2011-07-19, v0.5.3

FIXES:

    GUI:

        * Add separate LOGOUT_URL setting

          fixes bug with URL in invitations mail

    Deployment:

        * Recode invitations email in UTF-8

        * Use DEFAULT_FROM_EMAIL Django setting as From: header

          for all emails

2011-07-18, v0.5.2

FIXES:

    GUI:

        * Improve IPv6 support in UI (#839, #841)

        * Improve Connect messages, propose username (#801)

        * Add "tag"/"value" headers in Modify tags popup (#845)

    API:

        * Support arbitrary arguments to RAPI CreateInstanceCall() (#835)

    Admin tool:

        * Support creation and modification of users, flavors, images (#827)

        * Support sending invitations from the command line

2011-07-14, v0.5.1

FIXES:

    GUI:

        * non-standard dpi settings (#343)

        * many minor bugs (#717)

        * remove "Login again" button from Java VNC viewer (#731)

        * Fix no firewall settings shown for newly built machines (#753)

        * Fix handling of transitional "Destroying" state (#771)

        * Use well-formed, client- and server-specific messages

          for the Connect operation (#801)

        * Fix misaligned action labels in IE (#821)

          generic cross-browser compatibility fixes (#341)

    Logic:

        * fix dispatcher flushing AMQP queues (#719)

        * Support asynchronous VM deletion (#721)

        * Add backend prefix to all AMQP queues (#723)

        * Document workarounds for dispatcher daemonization problems

          when logging to stdout (#779)

    Images:

        * Fix ntfsclone causing excess I/O load due to verbose output (#729)

    API:

        * Have API use the flavor-defined disk sizes (#759)

        * Make backend disk templates (plain, drbd) configurable (#77&)

        * Work around Ganeti bug with getting VNC console info (#783)

        * Set serial_console=False explicitly on Ganeti backend (#785)

        * Allow exception info to propagate when VNC console allocation fails

          (#789)

        * Handle deletion of machines in ERROR when no Ganeti instance exists

          (#799)

    Backend:

        * Synchronize contrib/kvm-vif-bridge to agree with the API on the tags

          to use for firewall profiles (#789)

NEW FEATURES

    GUI:

        * Add themed form for invitations, integrate with UI (#439)

        * Add themed feedback form, integrate with API error window

          (~okeanos #7)

    Admin tool:

        * Add initial version of snf-admin tool for user, VM and image

          management (#727)

2011-07-01, v0.5

NEW FEATURES

    GUI:

        * Overhauled icon and single-server view, updated color set

          (#651, #653, #667, #669, #673, #675, #677, #443, #631)

        * Added statistics, retrieves pre-processed PNGs from backend (#527)

        * Added buttons for modifier keys, custom theming to Java VNC client

          (#545)

        * Support single-click RDP-based connection to Windows VMs (#673)

        * Allow setting network firewall profiles on public interfaces (#661)

    Images:

        * Complete set of Linux distribution Images (Debian, Fedora, Ubuntu)

          (#493, #509)

        * Complete support for Windows machines (create, customize, boot)

          (#495)

    Logic:

        * Support centralized logging, logging.conf-based setup (#547)

    AAI:

        * Allow per-user setting of number of outgoing invitations (#439, #705)

        * Support "switch-user"-type functionality for helpdesk users (#665)

        * Support user logout in the UI, delete relevant tokens (#663)

    API:

        * Supports retrieval of statistics (#527)

        * Support maximum number of VMs per user (quota) (#703)

        * Extend API to support distinct firewall profiles, update backend (#659)

    Deployment:

        * BSD 2-clause Licensing (#581)

        * Initial translation of UI to Greek (#689)

        * Drop Django dependency in snf-ganeti-eventd and snf-ganeti-hook (#691)

          Synnefo dependency remains, already patched by ops, to be committed

        * Split settings.py to distinct files under settings.d/ (#693)

        * Use the Django email framework (#697)

        * Implemented statistics-gathering mechanism at the backend (#527)

FIXES:

    GUI:

        * Too many bug fixes to mention (#403, #429, #465, #473, #557, #589,

          #599, #605, #607, #609, #611, #613, #619, #621, #623, #625, #627,

          #629, #633, #635, #637, #639, #641, #643, #645, #647, #649, #655,

          #657, #681, #687, #699, #701, #707, #709)

        * Better cross-browser compatibility (#341)

        * Should work with relative URLs (#421)

    Images:

        * Set hostname in Linux VMs appropriately (#603)

    Logic:

        * Include EUI-64-derived IPv6 address in ganeti-net-status notifications

          (#615)

    Deployment:

        * Do not set nodes explicitly, use iallocator at Ganeti backend (#617)

2011-06-06, v0.4

NEW FEATURES:

    GUI:

        * Support displaying info on and handling of public and private networks,

          with differential updates (#407, #469)

        * Support create new private network (#541), add machine to

          private network (#543)

        * Design and implement a completely revamped blue and orange

          color theme (#529, #531)

        * Implement improved add/edit metadata dialog with suggested values for

          keys (#535, #537)

        * Implement list of suggested keys in add server metadata dialog (#537)

        * Add full-screen Console window, themed as the rest of the UI (#497)

        * Implement single-machine view in the UI (#573)

        * Add user notification (spinner) on button clicks performing

          API actions (#471)

        * Full IE support, differential updates (#461)

    AAI:

        * Each token has its own expiration date, fix expiration of

          development test token (#483)

        * Support adding new users to the DB by invitation (#439)

    API:

        * Extend networks API, support differential updates for private nets (#569)

        * Support XML replies for the /networks API namespace (#553)

        * Implement mechanism for reconciliation of DB state with Ganeti backend

          state in case of AMQP failure (#505)

        * Support Ganeti link pooling for management of private networks (#513)

        * Support reception and processing of NIC configuration notifications

          from Ganeti over AMQP (#513)

    IMAGES:

        * Implement generic API<->Ganeti mechanism for passing custom VM parameters (#487)

        * Support selection and handling of OS images for VM customization (#489)

        * Support random selection and enforcement of root password on Linux VMs (#485)

    GANETI BACKEND:

        * Design and implement mechanism for handling network connection requests,

          based on link ids of virtual NICs (#411)

        * Support handling of public and private networks,

          based on NFDHCPD and custom KVM ifup scripts (#407, #411)

FIXES:

    GUI:

        * Remove extraneous GET /server/id/meta requests (#463)

        * Fix location of the "Create New" wizard in IE (#467)

        * Make numerous hardcoded strings translatable (#473)

        * Fix alignment of step names in "Create New" wizard (#475)

        * Fix OS icons not appearing in Opera (#477)

        * Fix correspondence of OS icons to icon URIs (#481)

        * Fix console action inoperable in list view (#497)

        * Fix HTTP errors from backend not reported correctly (#523)

        * Fix handling of API "UKNNOWN" status for servers (#571)

        * Add SVG-derived icons for Fedora in multiple resolutions (#587)

        * Various minor UI glitches (#583, #585, #591)

    API:

        * Fix entering Greek characters in fields failed (was due to

          problem with db creation parameters in MySQL) (#499)

        * Fix return erroneous 304 NOT MOTIFIED for GET /servers if only

          server metadata modified (#525)

        * Fix return erroneous "UNKNOWN" status under specific circumstances (#573)

        * Remove private network connections when a server is deleted (#579)

KNOWN DEFECTS:

    GUI:

        * Does not work with relative URLs (cannot deploy under subdir) (#421)

        * UI breaks if "Create New" called twice in quick succession (#609)

        * Esc/Enter keys do not work in edit metadata window (#605)

        * No spinner icon on outstanding requests for updates to private networks (#607)

        * Error window overflows in case of longer-than-usual traceback in

          "Details" field (#611)

        * Single-server view does not update properly (#613)

    IMAGES:

        * Image deployment mechanism does not set Linux hostname properly (#603)

    GANETI BACKEND:

        * No IPv6 reported from the Synnefo Ganeti hook to the API

          (backend, API and UI can all handle IPv6 though) (#615)

        * All VMs currently allocated to the first Ganeti node, since no

          allocator has been installed in the development Ganeti yet (#617)

    Deployment:

        * No rigorous testing of data migration, migrations in real-world

          conditions will probably fail (#503)

2011-05-10, v0.3

FIXES/NEW FEATURES:

    GUI:

        * Report connection failures correctly, instead of a bogus 503 error (#427)

        * Support rename Virtual Machines using a nifty pencil icon (#429)

        * Fix complete failure of site with IE (starts, has known defects) (#431)

        * Support expanding box in icon view, containing metadata info (#375, #435, #441)

        * Support providing X-Auth-Token headers for authentication (#455)

        * Support Java applet-based popup for VNC console access (#391)

        * Initial implementation of "networks" tab interface mockup, no actual functionality (#415)

    AAI:

        * End-to-end Shibboleth support (#345)

    API:

        * Support creation, management and removal of private L2 networks (#409, #457)

        * Fix API implementation does not return unAuthorized cloud faults (#459)

        * Merge support for X-Auth-Token based authentication (#423)

    Logic:

        * Re-engineer messaging layer, migrate from 0mq to an AMQP-based infrastructure (#393)

        * Extended dispatcher, provides the context for executing business layer functions (#393)

        * Extended Ganeti event daemon, publish notifications over AMQP (#393)

        * Support a generic Synnefo hook in Ganeti, publish notifications over AMQP (#393, #397)

        * Extend logic layer, process NIC configuration notifications, update VM info in DB (#397)

    Deployment:

        * Add improved version of README.deploy, detailing node types in a Synnefo deployment

KNOWN DEFECTS:

    GUI:

        * Inoperative console action in list view (#497)

        * Various UI glitches under Chrome/Safari (wizard)

        * Serious functionality glitches with IE (no auto-refresh, no machine rename)

        * Serious UI glitches with non-standard dpi settings (#343)

        * Does not work with relative URLs (cannot deploy under subdir) (#421)

    API:

        * No Greek characters allowed in server names with the MySQL backend (#499)

    Deployment:

        * No rigorous testing of data migration, migrations in real-world conditions will probably fail (#503)

2011-04-19, v0.2.2

Bug fix release:

    GUI:

        * Fix start operation breakage due to extra argument in API call (#433)

2011-04-19, v0.2.1

Bug fix release:

    GUI:

        * Fix shutdown operation breakage due to extra argument in API call (#433)

2011-04-19, v0.2

FIXES/NEW FEATURES:

    GUI:

        * Show transitional state when command is in progress ("Starting", etc) (#401)

        * Allow only "destroy" for machines being built (#399)

        * Show nice icons for the icon, list and single view (#389)

        * Show the VM configuration (flavor) in list view (#387)

        * Add Destroy action in icon view (#381)

        * Show spinner when action is in progress (#379)

        * Handle OS icons properly for Images and machines, user-controlled (#257)

        * Support modification of VM metadata (currently: only addition, removal) (#375)

        * Support machine rename (#307)

        * Show welcome screen when no VMs defined (#279)

        * Revamped "Create New" wizard (#83)

    API:

        * Return buildInProgress properly (#351)

        * Loads of new unit tests (#417)

        * Support OOB console access over VNC using vncauthproxy

            - Run as daemon, support automatic port selection (#419)

        * Refactor ganeti-0mqd

            - Run as daemon, receive messages from Ganeti hooks, publish over 0mq

    Deployment:

        * Add initial version of README.deploy, detailing service dependencies

        * Add support for database migrations, using Django South (#371)

        * Install continuous integration platform (Jenkins), run tests automatically (#383)

KNOWN DEFECTS:

    GUI:

        * Minor visual problems with Firefox 3.5 (#403)

        * Major cross-browser compatibility problems (no IE support) (#431, #341)

        * Requires installation under /, does not work with relative URLs (#421)

        * Incorrect 503 return code when server is unreachable (#427)

recursive-include docs *.rst

recursive-include synnefo *.html *.js *.txt *.css *.jpg *.png *.gif *.json *.xml *.json

include distribute_setup.py Changelog README

README

=======

This is the top-level documentation file for the

Synnefo cloud management software.

Consult:

  * docs/src/develop.rst: for information on how to setup a development environment

  * docs/src/install.rst: for information on how to install the application

  * docs/src/deploy.rst:  for information on how to deploy the application

  * docs/src/ci.rst:      for information on how to setup a Jenkins-based

                          continuous integration system

  * docs/src/i18n.rst:    for information on application internationalization

Synnefo may be distributed under the terms of the following license:

Copyright 2011 GRNET S.A. All rights reserved.

Redistribution and use in source and binary forms, with or

without modification, are permitted provided that the following

conditions are met:

  1. Redistributions of source code must retain the above

     copyright notice, this list of conditions and the following

     disclaimer.

  2. Redistributions in binary form must reproduce the above

     copyright notice, this list of conditions and the following

     disclaimer in the documentation and/or other materials

     provided with the distribution.

THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and

documentation are those of the authors and should not be

interpreted as representing official policies, either expressed

or implied, of GRNET S.A.

#!python

"""Bootstrap distribute installation

If you want to use setuptools in your package's setup.py, just include this

file in the same directory with it, and add this to the top of your setup.py::

    from distribute_setup import use_setuptools

    use_setuptools()

If you want to require a specific version of setuptools, set a download

mirror, or use an alternate download directory, you can do so by supplying

the appropriate options to ``use_setuptools()``.

This file can also be run as a script to install or upgrade setuptools.

"""

import os

import sys

import time

import fnmatch

import tempfile

import tarfile

from distutils import log

try:

    from site import USER_SITE

except ImportError:

    USER_SITE = None

try:

    import subprocess

    def _python_cmd(*args):

        args = (sys.executable,) + args

        return subprocess.call(args) == 0

except ImportError:

    # will be used for python 2.3

    def _python_cmd(*args):

        args = (sys.executable,) + args

        # quoting arguments if windows

        if sys.platform == 'win32':

            def quote(arg):

                if ' ' in arg:

                    return '"%s"' % arg

                return arg

            args = [quote(arg) for arg in args]

        return os.spawnl(os.P_WAIT, sys.executable, *args) == 0

DEFAULT_VERSION = "0.6.10"

DEFAULT_URL = "http://pypi.python.org/packages/source/d/distribute/"

SETUPTOOLS_FAKED_VERSION = "0.6c11"

SETUPTOOLS_PKG_INFO = """\

Metadata-Version: 1.0

Name: setuptools

Version: %s

Summary: xxxx

Home-page: xxx

Author: xxx

Author-email: xxx

License: xxx

Description: xxx

""" % SETUPTOOLS_FAKED_VERSION

def _install(tarball):

    # extracting the tarball

    tmpdir = tempfile.mkdtemp()

    log.warn('Extracting in %s', tmpdir)

    old_wd = os.getcwd()

    try:

        os.chdir(tmpdir)

        tar = tarfile.open(tarball)

        _extractall(tar)

        tar.close()

        # going in the directory

        subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0])

        os.chdir(subdir)

        log.warn('Now working in %s', subdir)

        # installing

        log.warn('Installing Distribute')

        if not _python_cmd('setup.py', 'install'):

            log.warn('Something went wrong during the installation.')

            log.warn('See the error message above.')

    finally:

        os.chdir(old_wd)

def _build_egg(egg, tarball, to_dir):

    # extracting the tarball

    tmpdir = tempfile.mkdtemp()

    log.warn('Extracting in %s', tmpdir)

    old_wd = os.getcwd()

    try:

        os.chdir(tmpdir)

        tar = tarfile.open(tarball)

        _extractall(tar)

        tar.close()

        # going in the directory

        subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0])

        os.chdir(subdir)

        log.warn('Now working in %s', subdir)

        # building an egg

        log.warn('Building a Distribute egg in %s', to_dir)

        _python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir)

    finally:

        os.chdir(old_wd)

    # returning the result

    log.warn(egg)

    if not os.path.exists(egg):

        raise IOError('Could not build the egg.')

def _do_download(version, download_base, to_dir, download_delay):

    egg = os.path.join(to_dir, 'distribute-%s-py%d.%d.egg'

                       % (version, sys.version_info[0], sys.version_info[1]))

    if not os.path.exists(egg):

        tarball = download_setuptools(version, download_base,

                                      to_dir, download_delay)

        _build_egg(egg, tarball, to_dir)

    sys.path.insert(0, egg)

    import setuptools

    setuptools.bootstrap_install_from = egg

def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,

                   to_dir=os.curdir, download_delay=15, no_fake=True):

    # making sure we use the absolute path

    to_dir = os.path.abspath(to_dir)

    was_imported = 'pkg_resources' in sys.modules or \

        'setuptools' in sys.modules

    try:

        try:

            import pkg_resources

            if not hasattr(pkg_resources, '_distribute'):

                if not no_fake:

                    _fake_setuptools()

                raise ImportError

        except ImportError:

            return _do_download(version, download_base, to_dir, download_delay)

        try:

            pkg_resources.require("distribute>="+version)

            return

        except pkg_resources.VersionConflict:

            e = sys.exc_info()[1]

            if was_imported:

                sys.stderr.write(

                "The required version of distribute (>=%s) is not available,\n"

                "and can't be installed while this script is running. Please\n"

                "install a more recent version first, using\n"

                "'easy_install -U distribute'."

                "\n\n(Currently using %r)\n" % (version, e.args[0]))

                sys.exit(2)

            else:

                del pkg_resources, sys.modules['pkg_resources']    # reload ok

                return _do_download(version, download_base, to_dir,

                                    download_delay)

        except pkg_resources.DistributionNotFound:

            return _do_download(version, download_base, to_dir,

                                download_delay)

    finally:

        if not no_fake:

            _create_fake_setuptools_pkg_info(to_dir)

def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,

                        to_dir=os.curdir, delay=15):

    """Download distribute from a specified location and return its filename

    `version` should be a valid distribute version number that is available

    as an egg for download under the `download_base` URL (which should end

    with a '/'). `to_dir` is the directory where the egg will be downloaded.

    `delay` is the number of seconds to pause before an actual download

    attempt.

    """

    # making sure we use the absolute path

    to_dir = os.path.abspath(to_dir)

    try:

        from urllib.request import urlopen

    except ImportError:

        from urllib2 import urlopen

    tgz_name = "distribute-%s.tar.gz" % version

    url = download_base + tgz_name

    saveto = os.path.join(to_dir, tgz_name)

    src = dst = None

    if not os.path.exists(saveto):  # Avoid repeated downloads

        try:

            log.warn("Downloading %s", url)

            src = urlopen(url)

            # Read/write all in one block, so we don't create a corrupt file

            # if the download is interrupted.

            data = src.read()

            dst = open(saveto, "wb")

            dst.write(data)

        finally:

            if src:

                src.close()

            if dst:

                dst.close()

    return os.path.realpath(saveto)

def _no_sandbox(function):

    def __no_sandbox(*args, **kw):

        try:

            from setuptools.sandbox import DirectorySandbox

            if not hasattr(DirectorySandbox, '_old'):

                def violation(*args):

                    pass

                DirectorySandbox._old = DirectorySandbox._violation

                DirectorySandbox._violation = violation

                patched = True

            else:

                patched = False

        except ImportError:

            patched = False

        try:

            return function(*args, **kw)

        finally:

            if patched:

                DirectorySandbox._violation = DirectorySandbox._old

                del DirectorySandbox._old

    return __no_sandbox

def _patch_file(path, content):

    """Will backup the file then patch it"""

    existing_content = open(path).read()

    if existing_content == content:

        # already patched

        log.warn('Already patched.')

        return False

    log.warn('Patching...')

    _rename_path(path)

    f = open(path, 'w')

    try:

        f.write(content)

    finally:

        f.close()

    return True

_patch_file = _no_sandbox(_patch_file)

def _same_content(path, content):

    return open(path).read() == content

def _rename_path(path):

    new_name = path + '.OLD.%s' % time.time()

    log.warn('Renaming %s into %s', path, new_name)

    os.rename(path, new_name)

    return new_name

def _remove_flat_installation(placeholder):

    if not os.path.isdir(placeholder):

        log.warn('Unkown installation at %s', placeholder)

        return False

    found = False

    for file in os.listdir(placeholder):

        if fnmatch.fnmatch(file, 'setuptools*.egg-info'):

            found = True

            break

    if not found:

        log.warn('Could not locate setuptools*.egg-info')

        return

    log.warn('Removing elements out of the way...')

    pkg_info = os.path.join(placeholder, file)

    if os.path.isdir(pkg_info):

        patched = _patch_egg_dir(pkg_info)

    else:

        patched = _patch_file(pkg_info, SETUPTOOLS_PKG_INFO)

    if not patched:

        log.warn('%s already patched.', pkg_info)

        return False

    # now let's move the files out of the way

    for element in ('setuptools', 'pkg_resources.py', 'site.py'):

        element = os.path.join(placeholder, element)

        if os.path.exists(element):

            _rename_path(element)

        else:

            log.warn('Could not find the %s element of the '

                     'Setuptools distribution', element)

    return True

_remove_flat_installation = _no_sandbox(_remove_flat_installation)

def _after_install(dist):

    log.warn('After install bootstrap.')

    placeholder = dist.get_command_obj('install').install_purelib

    _create_fake_setuptools_pkg_info(placeholder)

def _create_fake_setuptools_pkg_info(placeholder):

    if not placeholder or not os.path.exists(placeholder):

        log.warn('Could not find the install location')

        return

    pyver = '%s.%s' % (sys.version_info[0], sys.version_info[1])

    setuptools_file = 'setuptools-%s-py%s.egg-info' % \

            (SETUPTOOLS_FAKED_VERSION, pyver)

    pkg_info = os.path.join(placeholder, setuptools_file)

    if os.path.exists(pkg_info):

        log.warn('%s already exists', pkg_info)

        return

    log.warn('Creating %s', pkg_info)

    f = open(pkg_info, 'w')

    try:

        f.write(SETUPTOOLS_PKG_INFO)

    finally:

        f.close()

    pth_file = os.path.join(placeholder, 'setuptools.pth')

    log.warn('Creating %s', pth_file)

    f = open(pth_file, 'w')

    try:

        f.write(os.path.join(os.curdir, setuptools_file))

    finally:

        f.close()

_create_fake_setuptools_pkg_info = _no_sandbox(_create_fake_setuptools_pkg_info)

def _patch_egg_dir(path):

    # let's check if it's already patched

    pkg_info = os.path.join(path, 'EGG-INFO', 'PKG-INFO')

    if os.path.exists(pkg_info):

        if _same_content(pkg_info, SETUPTOOLS_PKG_INFO):

            log.warn('%s already patched.', pkg_info)

            return False

    _rename_path(path)

    os.mkdir(path)

    os.mkdir(os.path.join(path, 'EGG-INFO'))

    pkg_info = os.path.join(path, 'EGG-INFO', 'PKG-INFO')

    f = open(pkg_info, 'w')

    try:

        f.write(SETUPTOOLS_PKG_INFO)

    finally:

        f.close()

    return True

_patch_egg_dir = _no_sandbox(_patch_egg_dir)

def _before_install():

    log.warn('Before install bootstrap.')

    _fake_setuptools()

def _under_prefix(location):

    if 'install' not in sys.argv:

        return True

    args = sys.argv[sys.argv.index('install')+1:]

    for index, arg in enumerate(args):

        for option in ('--root', '--prefix'):

            if arg.startswith('%s=' % option):

                top_dir = arg.split('root=')[-1]

                return location.startswith(top_dir)

            elif arg == option:

                if len(args) > index:

                    top_dir = args[index+1]

                    return location.startswith(top_dir)

        if arg == '--user' and USER_SITE is not None:

            return location.startswith(USER_SITE)

    return True

def _fake_setuptools():

    log.warn('Scanning installed packages')

    try:

        import pkg_resources

    except ImportError:

        # we're cool

        log.warn('Setuptools or Distribute does not seem to be installed.')

        return

    ws = pkg_resources.working_set

    try:

        setuptools_dist = ws.find(pkg_resources.Requirement.parse('setuptools',

                                  replacement=False))

    except TypeError:

        # old distribute API

        setuptools_dist = ws.find(pkg_resources.Requirement.parse('setuptools'))

    if setuptools_dist is None:

        log.warn('No setuptools distribution found')

        return

    # detecting if it was already faked

    setuptools_location = setuptools_dist.location

    log.warn('Setuptools installation detected at %s', setuptools_location)

    # if --root or --preix was provided, and if

    # setuptools is not located in them, we don't patch it

    if not _under_prefix(setuptools_location):

        log.warn('Not patching, --root or --prefix is installing Distribute'

                 ' in another location')

        return

    # let's see if its an egg

    if not setuptools_location.endswith('.egg'):

        log.warn('Non-egg installation')

        res = _remove_flat_installation(setuptools_location)

        if not res:

            return

    else:

        log.warn('Egg installation')

        pkg_info = os.path.join(setuptools_location, 'EGG-INFO', 'PKG-INFO')

        if (os.path.exists(pkg_info) and

            _same_content(pkg_info, SETUPTOOLS_PKG_INFO)):

            log.warn('Already patched.')

            return

        log.warn('Patching...')

        # let's create a fake egg replacing setuptools one

        res = _patch_egg_dir(setuptools_location)

        if not res:

            return

    log.warn('Patched done.')

    _relaunch()

def _relaunch():

    log.warn('Relaunching...')

    # we have to relaunch the process

    # pip marker to avoid a relaunch bug

    if sys.argv[:3] == ['-c', 'install', '--single-version-externally-managed']:

        sys.argv[0] = 'setup.py'

    args = [sys.executable] + sys.argv

    sys.exit(subprocess.call(args))

def _extractall(self, path=".", members=None):

    """Extract all members from the archive to the current working

       directory and set owner, modification time and permissions on

       directories afterwards. `path' specifies a different directory

       to extract to. `members' is optional and must be a subset of the

       list returned by getmembers().

    """

    import copy

    import operator

    from tarfile import ExtractError

    directories = []

    if members is None:

        members = self

    for tarinfo in members:

        if tarinfo.isdir():

            # Extract directories with a safe mode.

            directories.append(tarinfo)

            tarinfo = copy.copy(tarinfo)

            tarinfo.mode = 448 # decimal for oct 0700

        self.extract(tarinfo, path)

    # Reverse sort directories.

    if sys.version_info < (2, 4):

        def sorter(dir1, dir2):

            return cmp(dir1.name, dir2.name)

        directories.sort(sorter)

        directories.reverse()

    else:

        directories.sort(key=operator.attrgetter('name'), reverse=True)

    # Set correct owner, mtime and filemode on directories.

    for tarinfo in directories:

        dirpath = os.path.join(path, tarinfo.name)

        try:

            self.chown(tarinfo, dirpath)

            self.utime(tarinfo, dirpath)

            self.chmod(tarinfo, dirpath)

        except ExtractError:

            e = sys.exc_info()[1]

            if self.errorlevel > 1:

                raise

            else:

                self._dbg(1, "tarfile: %s" % e)

def main(argv, version=DEFAULT_VERSION):

    """Install or upgrade setuptools and EasyInstall"""

    tarball = download_setuptools()

    _install(tarball)

if __name__ == '__main__':

    main(sys.argv[1:])

# 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/Synnefo.qhcp"

	@echo "To view the help file:"

	@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 "# 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."

# database configuration

DATABASES = {

    'default': {

        'ENGINE': 'django.db.backends.', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.

        'NAME': '',                      # Or path to database file if using sqlite3.

        'USER': '',                      # Not used with sqlite3.

        'PASSWORD': '',                  # Not used with sqlite3.

        'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.

        'PORT': '',                      # Set to empty string for default. Not used with sqlite3.

    }

}

# where synnefo static files exist

MEDIA_ROOT = '/var/lib/synnefo/static/'

# rabitmq configuration

RABBIT_HOST = ""

RABBIT_USERNAME = ""

RABBIT_PASSWORD = ""

RABBIT_VHOST = "/"

GANETI_MASTER_IP = ""

GANETI_CLUSTER_INFO = (GANETI_MASTER_IP, 5080, "<username>", "<password>")

# This prefix gets used when determining the instance names

# of Synnefo VMs at the Ganeti backend.

# The dash must always appear in the name!

BACKEND_PREFIX_ID = "<prefix>-"

server {

    listen 80;

    server_name synnefo.local;

    root /var/lib/synnefo/;

    # serving static files 

    location /static  {

        autoindex on;

        root /var/lib/synnefo/;

    }

    location / {

        # host and port to fastcgi server

        fastcgi_pass 127.0.0.1:8015;

        fastcgi_param PATH_INFO          $fastcgi_script_name;

        fastcgi_param REQUEST_METHOD     $request_method;

        fastcgi_param QUERY_STRING       $query_string;

        fastcgi_param CONTENT_TYPE       $content_type;

        fastcgi_param CONTENT_LENGTH     $content_length;

        fastcgi_param SERVER_ADDR        $server_addr;

        fastcgi_param SERVER_PORT        $server_port;

        fastcgi_param SERVER_NAME        $server_name;

        fastcgi_param  SERVER_PROTOCOL  $server_protocol;

        fastcgi_pass_header Authorization;

        fastcgi_intercept_errors off;

    }

}

[

    {

        "model": "db.SynnefoUser",

        "pk": 1,

        "fields": {

            "name": "testdbuser",

            "realname" :"test db user",

            "uniq" :"test@synnefo.gr",

            "credit": 10,

            "auth_token": "46e427d657b20defe352804f0eb6f8a2",

            "auth_token_created": "2011-05-10",

            "auth_token_expires": "2015-05-10",

            "type": "ADMIN",

            "created": "2011-05-10",

            "max_invitations" : 1000

   	    }

    },

    {

        "model": "db.SynnefoUser",

        "pk": 2,

        "fields": {

            "name": "helpdesk",

            "realname" :"HelpDesk user",

            "uniq" :"helpdesk@synnefo.grnet.gr",

            "credit": 10,

            "auth_token": "839636858b1feafd37010f05dc4582e2",

            "auth_token_created": "2011-05-10",

            "auth_token_expires": "2015-05-10",

            "type": "HELPDESK",

            "created": "2011-05-10",

            "max_invitations" : 10

   	    }

    },

    {

        "model" : "db.Invitations",

        "pk" : 1,

        "fields": {

            "source": 1,

            "target": 1,

            "accepted": "True",

            "level" : -1,

            "created": "2011-06-01",

            "updated": "2011-06-01"

        }

    }

] 

# -*- 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('..'))

# -- 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']

# 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.gr'

# 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'