Commit c5d9a291 authored by Vangelis Koukis's avatar Vangelis Koukis
Browse files

Merge branch 'doc-0.8'

parents cf064493 614fd2ad
.. _cyclades:
Asterias Service
----------------
Compute Service (cyclades)
--------------------------
Asterias is the the synnefo Compute Service and implements OpenStack Compute API v1.1.
Cyclades is the the synnefo Compute Service and implements OpenStack Compute API v1.1.
Cyclades need the following synnefo components:
.. todo:: list synnefo components needed by cyclades
Cyclades Architecture
=====================
.. todo:: document the overall cyclades architecture
Cyclades as a standalone Service
================================
.. todo:: document what does that mean, what are the limitations, how to install.
Cyclades interconnected with other synnefo Services
===================================================
.. todo:: document with which services it can connect, why and how.
Cyclades Guides
===============
.. todo:: document the Compute Service.
......
synnefo
=======
Welcome to synnefo's documentation
==================================
.. image:: /images/synnefo-logo.png
synnefo is software to create massively scalable IaaS clouds.
synnefo is opensource software used to create massively scalable IaaS clouds.
It powers GRNET's `~okeanos cloud service <https://okeanos.grnet.gr>`_.
| You can see synnefo in action, powering GRNET's
`~okeanos cloud service <https://okeanos.grnet.gr>`_.
| It is a collection of components (snf-*), most of them written in python, that
are used as the building bricks to provide the following services:
This is the main synnefo documentation page.
.. toctree::
:maxdepth: 1
synnefo comprises the following major components:
Compute Service (codename: cyclades) <cyclades>
File Storage Service (codename: pithos+) <http://docs.dev.grnet.gr/pithos>
Image Registry (codename: plankton) <http://docs.dev.grnet.gr/cyclades/plankton>
Volume Storage Service (codename: archipelagos) <http://docs.dev.grnet.gr/archipelagos>
Identity Management (codename: astakos) <http://docs.dev.grnet.gr/astakos>
Billing Service (codename: aquarium) <http://docs.dev.grnet.gr/aquarium>
There are also components for:
.. toctree::
:maxdepth: 1
cyclades (name TBD): Compute Service <cyclades>
pithos+: File storage service <http://docs.dev.grnet.gr/pithos>
plankton: Image registry <http://docs.dev.grnet.gr/cyclades/plankton>
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 <snf-image>
kamaki: Command-line cloud management tool <http://docs.dev.grnet.gr/cyclades/kamaki>
Secure image deployment (image tool) <snf-image>
Command-line cloud management (kamaki tool) <http://docs.dev.grnet.gr/cyclades/kamaki>
synnefo is designed to be as simple, scalable and production ready as possible.
Furthermore, although it can be deployed in small configurations, its prime
target is large installations. If you are planning for the latter, you should
first be completely aware of what you want to provide, the architecture of your
cluster/s and synnefo's overall architecture before you start deploying.
All synnefo components use an intuitive settings mechanism, that gives you the
ability to either deploy the above services independently and standalone, or
interconnected with each other, in large configurations.
For complete documentation on each service's architecture, installation,
configuration, components needed, interfaces, APIs, and deployment follow the
above links. You can also browse all synnefo component in this list.
Quick Installation Guide
------------------------
A quick installation guide is provided, that describes how to install synnefo in
just one physical node for testing and development purposes. This guide is also
useful to those interested in deploying synnefo in large scale, as a starting
point that will help them get familiar with the synnefo components and overall
architecture, as well as the interconnection between different services. Such an
installation, also provides a quick preview of the basic synnefo features,
although we would like to think that its real power will unveil while scaling.
The quick installation guide comes in two versions:
| :ref:`Administrator's quick installation guide <quick-install-admin-guide>`
| This guide will walk you through a complete installation using debian packages.
| :ref:`Developer's quick installation guide <quick-install-dev-guide>`
| This guide will setup a development environment using pip install.
Standard Installation
---------------------
Also a complete standard installation guide will soon be available, that will
describe thoroughly how to deploy all services, interconnected with each other,
on multiple physical nodes. For now, please refer to each services own
documentation.
Contact
-------
You can contact the synnefo team at: synnefo@lists.grnet.gr
Indices and tables
------------------
......
.. _quick-install-admin-guide:
Administrator's Quick Installation Guide
========================================
This the Administrator's quick installation guide.
It describes how to install Synnefo on a single physical node,
with minimum configuration. It installs Synnefo from Debian packages, and
assumes the node runs Debian Squeeze.
Prerequisites
-------------
Please make sure you already have the following:
* A working installation of Ganeti on this node
* A working installation of snf-image, with installed images. See
https://code.grnet.gr/projects/snf-image/wiki for detailed info.
* A DB server running PostgreSQL
* A working deployment of RabbitMQ
Installation
------------
Install the following components from Debian packages.
Grab them from http://docs.dev.grnet.gr/debs/.
.. todo::
Setup a source file for APT.
The commands below install the needed dependencies manually,
APT would take care of that.
.. todo::
Document networking installation and configuration using
``grnet-vnode-tools``, ``nfdhcpd``
.. code-block:: console
# apt-get install python python-setuptools
# dpkg -i snf-common_0.7.4-1_all.deb
# apt-get install python-django python-django-south
# dpkg -i snf-webproject_0.7.4-1_all.deb
# dpkg -i snf-pithos-lib_0.8.2-1_all.deb
# dpkg -i snf-pithos-tools_0.8.2-1_all.deb
# apt-get install python-sqlalchemy
# dpkg -i snf-pithos-backend_0.8.2-1_all.deb
# apt-get install python-daemon python-gevent
# dpkg -i snf-vncauthproxy_1.1-1_all.deb
# apt-get install python-simplejson python-pycurl python-dateutil
# python-ipy python-crypto python-amqplib
# dpkg -i snf-cyclades-app_0.7.4-1_all.deb
# apt-get install python-pyinotify python-prctl nfdhcpd arptables
# dpkg -i snf-cyclades-gtools_7.4-1_all.deb
# dpkg -i snf-okeanos-site_7.4-1_all.deb
Configuration
--------------
Edit files under :file:`/etc/synnefo`, based on the location
of your Ganeti master, Postgres DB and RabbitMQ deployment.
At the very least you need to set sensible values for
* ``BYPASS_AUTHENTICATION`` (set to True, for a test install)
* ``GANETI_LINK_PREFIX``
* ``GANETI_MASTER_IP``
* ``GANETI_CLUSTER_INFO``
* ``RABBIT_HOST``
* ``RABBIT_USERNAME``
* ``RABBIT_PASSWORD``
* ``BYPASS_AUTHENTICATION_SECRET_TOKEN``
* ``BACKEND_DB_MODULE``
* ``BACKEND_DB_CONNECTION``
* ``BACKEND_BLOCK_MODULE``
* ``BACKEND_BLOCK_PATH``
.. todo::
Document quick installation of Pithos, upload of Images.
.. _quick-install-dev-guide:
Developer's Quick Installation Guide
========================================
This the Developer's quick installation guide.
.. todo:: document how to setup a synnefo devel environment in one physical node using pip install
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment