Statistics
| Branch: | Tag: | Revision:

root / docs / index.rst @ a96ec00f

History | View | Annotate | Download (3.4 kB)

1
Welcome to synnefo's documentation
2
==================================
3

    
4
.. image:: /images/synnefo-logo.png
5

    
6
synnefo is opensource software, used to create massively scalable IaaS clouds.
7

    
8
| You can see synnefo in action, powering GRNET's
9
  `~okeanos cloud service <https://okeanos.grnet.gr>`_.
10
| It is a collection of components (snf-*), most of them written in python, that
11
  are used as the building bricks to provide the following services:
12

    
13
.. toctree::
14
   :maxdepth: 1
15

    
16
   Compute Service (codename: cyclades) <cyclades>
17
   File Storage Service (codename: pithos+) <http://docs.dev.grnet.gr/pithos>
18
   Image Registry (codename: plankton) <http://docs.dev.grnet.gr/cyclades/plankton>
19
   Volume Storage Service (codename: archipelagos) <http://docs.dev.grnet.gr/archipelagos>
20
   Identity Management (codename: astakos) <http://docs.dev.grnet.gr/astakos>
21
   Billing Service (codename: aquarium) <http://docs.dev.grnet.gr/aquarium>
22

    
23
There are also components for:
24

    
25
.. toctree::
26
   :maxdepth: 1
27

    
28
   Secure image deployment (image tool) <snf-image>
29
   Command-line cloud management (kamaki tool) <http://docs.dev.grnet.gr/cyclades/kamaki>
30

    
31
synnefo is designed to be as simple, scalable and production ready as possible.
32
Furthermore, although it can be deployed in small configurations, its prime
33
target is large installations. If you are planning for the latter, you should
34
first be completely aware of what you want to provide, the architecture of your
35
cluster/s and synnefo's overall architecture before you start deploying.
36

    
37
All synnefo components use an intuitive settings mechanism, that gives you the
38
ability to either deploy the above services independently and standalone, or
39
interconnected with each other, in large configurations.
40

    
41
For complete documentation on each service's architecture, installation,
42
configuration, components needed, interfaces, APIs, and deployment follow the
43
above links. You can also browse all synnefo component in this list.
44

    
45
Quick Installation Guide
46
------------------------
47

    
48
The quick installation guide describes how to install the whole synnefo stack in
49
just two physical nodes, for testing and development purposes. This guide is
50
useful to those interested in deploying synnefo in large scale, as a starting
51
point that will help them get familiar with the synnefo components and overall
52
architecture, as well as the interconnection between different services. Such an
53
installation, also provides a quick preview of the basic synnefo features,
54
although we would like to think that synnefo unveils its real power while
55
scaling.
56

    
57
The quick installation guide comes in two versions:
58

    
59
| :ref:`Administrator's quick installation guide <quick-install-admin-guide>`
60
| This guide will walk you through a complete installation using debian packages.
61

    
62
| :ref:`Developer's quick installation guide <quick-install-dev-guide>`
63
| This guide will setup a development environment using pip install.
64

    
65
Standard Installation
66
---------------------
67

    
68
Also a complete standard installation guide will soon be available, that will
69
describe thoroughly how to deploy all services, interconnected with each other,
70
on multiple physical nodes. For now, if you installed successfully using the quick
71
installation guide and need more details, please refer to each service's own
72
documentation, following the links on top.
73

    
74
Contact
75
-------
76

    
77
You can contact the synnefo team at: synnefo@lists.grnet.gr
78

    
79
Indices and tables
80
------------------
81

    
82

    
83
* :ref:`genindex`
84
* :ref:`modindex`
85
* :ref:`search`