Statistics
| Branch: | Tag: | Revision:

root / docs / index.rst @ 4f7d5233

History | View | Annotate | Download (5.8 kB)

1
Welcome to Synnefo's documentation
2
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3

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

    
6
| Synnefo is open source cloud software, used to create massively scalable IaaS
7
  clouds.
8
| Synnefo uses `Google Ganeti <http://code.google.com/p/ganeti/>`_ for the low
9
  level VM management part.
10

    
11
| You can see Synnefo in action, powering GRNET's
12
  `~okeanos public cloud service <http://okeanos.io>`_.
13
| It is a collection of components (snf-*), most of them written in python, that
14
  are used as the building bricks to provide the following services:
15

    
16
.. toctree::
17
   :maxdepth: 1
18

    
19
   Identity Management (codename: astakos) <astakos>
20
   Object Storage Service (codename: pithos) <pithos>
21
   Compute Service (codename: cyclades) <cyclades>
22
   Network Service (part of Cyclades) <networks>
23
   Image Service (codename: plankton) <plankton>
24
   Volume Storage Service (codename: archipelago) <archipelago>
25

    
26
.. image:: images/synnefo-overview.png
27
   :target: _images/synnefo-overview.png
28

    
29
There are also the following tools:
30

    
31
.. toctree::
32
   :maxdepth: 1
33

    
34
   kamaki: Command-line client <http://docs.dev.grnet.gr/kamaki/latest/index.html>
35
   snf-deploy: Synnefo deployment tool <snf-deploy>
36
   snf-image-creator: Image bundling/uploading/registering tool <http://docs.dev.grnet.gr/snf-image-creator/latest/index.html>
37
   snf-image: Secure image deployment tool <snf-image>
38
   snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin>
39

    
40

    
41
Synnefo is designed to be as simple, scalable and production ready as possible.
42
Furthermore, although it can be deployed in small configurations, its prime
43
target is large installations.
44

    
45
All Synnefo components use an intuitive settings mechanism, that adds and removes
46
settings dynamically as components are getting added or removed from a physical
47
node. All settings are stored in a single location.
48

    
49
.. _general-arch:
50

    
51
Synnefo General Architecture
52
============================
53

    
54
The following graph shows the whole Synnefo architecture and how it interacts
55
with multiple Ganeti clusters.
56

    
57
.. image:: images/synnefo-arch2.png
58
   :width: 100%
59
   :target: _images/synnefo-arch2.png
60

    
61
Synnefo also supports RADOS as an alternative storage backend for
62
Files/Images/VM disks. :ref:`Here <syn+archip+rados>` is a graph that shows
63
Synnefo running with two different storage backends.
64

    
65
Synnefo Guides
66
==============
67

    
68
There are 4 guides for Synnefo.
69

    
70
.. For the really impatient snf-deploy tool allows you to install all software
71
.. components from scratch (creating locally kvm based Virtual Machines) or to an
72
.. existing cluster (in the same network subnet and domain, same network
73
.. configuration, vanilla debian squeeze and installed ssh keys). Please note that
74
.. this should be used only for testing or demo installations because most of the
75
.. times the prerequisites cannot be satisfied due to the underlying
76
.. infrastructure complexity (especially as far as networks is conserned).
77

    
78
The quick installation guide describes how to install the whole Synnefo stack
79
in just two physical nodes, for testing purposes. This guide is useful to those
80
interested in deploying Synnefo in large scale, as a starting point that will
81
help them get familiar with the Synnefo components and overall architecture, as
82
well as the interconnection between different services. Such an installation,
83
also provides a quick preview of the basic Synnefo features, although we would
84
like to think that Synnefo's real power unveils while scaling.
85

    
86
The Administrator's Guide targets system administrators, who want to dive into
87
more details and common tasks regarding Synnefo. For the experienced Synnefo
88
administrator, there is also a section that describes how to deploy Synnefo in
89
large scale with a corresponding guide.
90

    
91
The Developer's Guide targets developers, who want to build on top of Synnefo
92
and so describes all the different types of interfaces Synnefo provides to the
93
external world. The Integrator's Guide targets developers, who want to actually
94
extend/modify/change Synnefo itself, so describes Synnefo's indepth
95
architecture and the internals of Synnefo components (currently out-of-date!).
96

    
97

    
98
.. toctree::
99
   :maxdepth: 1
100

    
101
   Quick Installation Guide (on two nodes) <quick-install-admin-guide>
102

    
103
.. toctree::
104
   :maxdepth: 2
105

    
106
   Administrator's Guide <admin-guide>
107
   Developer's Guide <dev-guide>
108
   Integrator's Guide <intgrt-guide>
109

    
110

    
111
List of all Synnefo components
112
==============================
113

    
114
They are also available from our apt repository: ``apt.okeanos.grnet.gr``
115

    
116
 * `snf-common <http://docs.dev.grnet.gr/snf-common/latest/index.html>`_
117
 * `snf-webproject <http://docs.dev.grnet.gr/snf-webproject/latest/index.html>`_
118
 * `snf-astakos-app <http://docs.dev.grnet.gr/astakos/latest/index.html>`_
119
 * `snf-pithos-backend <http://docs.dev.grnet.gr/pithos/latest/backends.html>`_
120
 * `snf-pithos-app <http://docs.dev.grnet.gr/pithos/latest/index.html>`_
121
 * `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_
122
 * `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_
123
 * `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_
124
 * `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_
125
 * `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ 
126
 * `snf-image-creator <http://docs.dev.grnet.gr/snf-image-creator/latest/index.html>`_
127
 * `snf-occi <http://docs.dev.grnet.gr/snf-occi/latest/index.html>`_
128
 * `snf-cloudcms <http://docs.dev.grnet.gr/snf-cloudcms/latest/index.html>`_
129
 * `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_
130

    
131

    
132
Contact
133
=======
134

    
135
You can contact the Synnefo team at the following mailing lists:
136

    
137
 * Users list: synnefo@googlegroups.com
138
 * Developers list: synnefo-devel@googlegroups.com
139

    
140
The official site is:
141

    
142
 `http://www.synnefo.org <http://www.synnefo.org>`_
143

    
144
Indices and tables
145
==================
146

    
147

    
148
* :ref:`genindex`
149
* :ref:`modindex`
150
* :ref:`search`