root / docs / index.rst @ 73ebcd68
History | View | Annotate | Download (6 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 |
.. _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 3 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 concerned). |
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 like to |
84 |
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 do scale-out |
89 |
Synnefo deployments with corresponding examples. This targets large scale |
90 |
installations of Synnefo. |
91 |
|
92 |
The Developer's Guide targets developers, who want to build on top of Synnefo |
93 |
and so describes all the different types of interfaces Synnefo provides to the |
94 |
external world. Also documents all Synnefo external REST APIs. |
95 |
|
96 |
.. The Integrator's Guide targets developers, who want to actually |
97 |
.. extend/modify/change Synnefo itself, so describes Synnefo's indepth |
98 |
.. architecture and the internals of Synnefo components (currently out-of-date!). |
99 |
|
100 |
|
101 |
.. toctree:: |
102 |
:maxdepth: 1 |
103 |
|
104 |
Quick Installation Guide (on two nodes) <quick-install-admin-guide> |
105 |
|
106 |
.. toctree:: |
107 |
:maxdepth: 2 |
108 |
|
109 |
Administrator's Guide <admin-guide> |
110 |
Developer's Guide <dev-guide> |
111 |
|
112 |
|
113 |
List of all Synnefo components |
114 |
============================== |
115 |
|
116 |
They are also available from our apt repository: ``apt.okeanos.grnet.gr`` |
117 |
|
118 |
* `snf-common <http://www.synnefo.org/docs/snf-common/latest/index.html>`_ |
119 |
* `snf-webproject <http://www.synnefo.org/docs/snf-webproject/latest/index.html>`_ |
120 |
* `snf-astakos-app <http://www.synnefo.org/docs/astakos/latest/index.html>`_ |
121 |
* `snf-pithos-backend <http://www.synnefo.org/docs/pithos/latest/backends.html>`_ |
122 |
* `snf-pithos-app <http://www.synnefo.org/docs/pithos/latest/index.html>`_ |
123 |
* `snf-pithos-webclient <http://www.synnefo.org/docs/pithos-webclient/latest/index.html>`_ |
124 |
* `snf-cyclades-app <http://www.synnefo.org/docs/snf-cyclades-app/latest/index.html>`_ |
125 |
* `snf-cyclades-gtools <http://www.synnefo.org/docs/snf-cyclades-gtools/latest/index.html>`_ |
126 |
* `astakosclient <http://www.synnefo.org/docs/astakosclient/latest/index.html>`_ |
127 |
* `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ |
128 |
* `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ |
129 |
* `snf-image-creator <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>`_ |
130 |
* `snf-occi <http://www.synnefo.org/docs/snf-occi/latest/index.html>`_ |
131 |
* `snf-cloudcms <http://www.synnefo.org/docs/snf-cloudcms/latest/index.html>`_ |
132 |
* `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_ |
133 |
|
134 |
|
135 |
Contact |
136 |
======= |
137 |
|
138 |
You can contact the Synnefo team at the following mailing lists: |
139 |
|
140 |
* Users list: synnefo@googlegroups.com |
141 |
* Developers list: synnefo-devel@googlegroups.com |
142 |
|
143 |
The official site is: |
144 |
|
145 |
`http://www.synnefo.org <http://www.synnefo.org>`_ |
146 |
|
147 |
Indices and tables |
148 |
================== |
149 |
|
150 |
|
151 |
* :ref:`genindex` |
152 |
* :ref:`modindex` |
153 |
* :ref:`search` |