Statistics
| Branch: | Tag: | Revision:

root / docs / index.rst @ 98ae2c12

History | View | Annotate | Download (6.1 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 (part of Cyclades) <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://www.synnefo.org/docs/kamaki/latest/index.html>
35
   snf-deploy: Synnefo deployment tool <snf-deploy>
36
   snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/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

    
50
.. _general-arch:
51

    
52
Synnefo General Architecture
53
============================
54

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

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

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

    
66

    
67
Synnefo Guides
68
==============
69

    
70
There are 4 guides for Synnefo.
71

    
72
The Quick Installation guide describes how to install Synnefo on a single node
73
in less than 10 minutes using the `snf-deploy` tool. This kind of installation
74
is targeted for testing and demo environments rather than production usage
75
deployments. It is the perfect way, even for an inexperienced user to have the
76
whole Synnefo stack up and running and allows for a quick preview of the basic
77
Synnefo features.
78

    
79
The Admin's installation guide describes how to install the whole Synnefo stack
80
in just two physical nodes. This guide is useful to those interested in
81
deploying Synnefo in large scale, as a starting point that will help them get
82
familiar with the Synnefo components and overall architecture, as well as the
83
interconnection between different services. This guide explains the whole
84
procedure step by step, without the use of the `snf-deploy` tool. Anyone
85
familiar with this guide, will be able to easily install Synnefo in a larger
86
number of nodes too, or even expand the two node installation dynamically.
87

    
88
The Administrator's Guide targets system administrators, who want to dive into
89
more details and common tasks regarding Synnefo. For the experienced Synnefo
90
administrator, there is also a section that describes how to do scale-out
91
Synnefo deployments with corresponding examples. This targets large scale
92
installations of Synnefo.
93

    
94
The Developer's Guide targets developers, who want to build on top of Synnefo
95
and so describes all the different types of interfaces Synnefo provides to the
96
external world. Also documents all Synnefo external REST APIs.
97

    
98
.. The Integrator's Guide targets developers, who want to actually
99
.. extend/modify/change Synnefo itself, so describes Synnefo's indepth
100
.. architecture and the internals of Synnefo components (currently out-of-date!).
101

    
102

    
103
.. toctree::
104
   :maxdepth: 1
105

    
106
   Quick Installation Guide (single node) <quick-install-guide>
107
   Installation Guide (on two nodes) <quick-install-admin-guide>
108

    
109
.. toctree::
110
   :maxdepth: 2
111

    
112
   Administrator's Guide <admin-guide>
113
   Developer's Guide <dev-guide>
114

    
115

    
116
List of all Synnefo components
117
==============================
118

    
119
They are also available from our apt repository: ``apt.dev.grnet.gr``
120

    
121
 * `snf-common <http://www.synnefo.org/docs/snf-common/latest/index.html>`_
122
 * `snf-webproject <http://www.synnefo.org/docs/snf-webproject/latest/index.html>`_
123
 * `snf-astakos-app <http://www.synnefo.org/docs/astakos/latest/index.html>`_
124
 * `snf-pithos-backend <http://www.synnefo.org/docs/pithos/latest/backends.html>`_
125
 * `snf-pithos-app <http://www.synnefo.org/docs/pithos/latest/index.html>`_
126
 * `snf-pithos-webclient <http://www.synnefo.org/docs/pithos-webclient/latest/index.html>`_
127
 * `snf-cyclades-app <http://www.synnefo.org/docs/snf-cyclades-app/latest/index.html>`_
128
 * `snf-cyclades-gtools <http://www.synnefo.org/docs/snf-cyclades-gtools/latest/index.html>`_
129
 * `astakosclient <http://www.synnefo.org/docs/astakosclient/latest/index.html>`_
130
 * `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_
131
 * `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ 
132
 * `snf-image-creator <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>`_
133
 * `snf-occi <http://www.synnefo.org/docs/snf-occi/latest/index.html>`_
134
 * `snf-cloudcms <http://www.synnefo.org/docs/snf-cloudcms/latest/index.html>`_
135
 * `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_
136

    
137

    
138
Design
139
======
140

    
141
Drafts
142
------
143

    
144
.. toctree::
145
   :maxdepth: 1
146

    
147
   Sample design <design/sample>
148

    
149

    
150
Contact
151
=======
152

    
153
You can contact the Synnefo team at the following mailing lists:
154

    
155
 * Users list: synnefo@googlegroups.com
156
 * Developers list: synnefo-devel@googlegroups.com
157

    
158
The official site is:
159

    
160
 `http://www.synnefo.org <http://www.synnefo.org>`_
161

    
162

    
163
Indices and tables
164
==================
165

    
166

    
167
* :ref:`genindex`
168
* :ref:`modindex`
169
* :ref:`search`