root / docs / index.rst @ 3fc0273f
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 Registry (codename: plankton) <plankton> |
24 |
Billing Service (codename: aquarium) <http://docs.dev.grnet.gr/aquarium/latest/index.html> |
25 |
Volume Storage Service (codename: archipelago) <archipelago> |
26 |
|
27 |
.. image:: images/synnefo-overview.png |
28 |
:target: _images/synnefo-overview.png |
29 |
|
30 |
There are also components for: |
31 |
|
32 |
.. toctree:: |
33 |
:maxdepth: 1 |
34 |
|
35 |
Secure image deployment (snf-image tool) <snf-image> |
36 |
Command-line cloud management (kamaki tool) <http://docs.dev.grnet.gr/kamaki/latest/index.html> |
37 |
Image bundling/uploading/registering (snf-image-creator tool) <http://docs.dev.grnet.gr/snf-image-creator/latest/index.html> |
38 |
|
39 |
Synnefo is designed to be as simple, scalable and production ready as possible. |
40 |
Furthermore, although it can be deployed in small configurations, its prime |
41 |
target is large installations. If you are planning for the latter, you should |
42 |
first be completely aware of what you want to provide, the architecture of your |
43 |
cluster/s and Synnefo's overall architecture before you start deploying. |
44 |
|
45 |
All Synnefo components use an intuitive settings mechanism, that gives you the |
46 |
ability to either deploy the above services independently and standalone, or |
47 |
interconnected with each other, in large configurations. |
48 |
|
49 |
|
50 |
Synnefo General Architecture |
51 |
============================ |
52 |
|
53 |
The following graph shows the whole Synnefo architecture and how it interacts |
54 |
with multiple Ganeti clusters. Right click on the image and select "Open image |
55 |
in new tab" to be able to zoom in. |
56 |
|
57 |
.. image:: images/synnefo-architecture1.png |
58 |
:width: 100% |
59 |
:target: _images/synnefo-architecture1.png |
60 |
|
61 |
|
62 |
Synnefo Guides |
63 |
============== |
64 |
|
65 |
There are 5 guides for Synnefo. |
66 |
|
67 |
The installation overview walks through the synnefo components and defines roles |
68 |
per node so that each role can be installed separately. Please note that |
69 |
different roles can still coexist in the same node and there is also a posibility |
70 |
to install everything on one node. For the sake of scalability this is not recommended. |
71 |
|
72 |
The quick installation guide describes how to install the whole synnefo stack |
73 |
in just two physical nodes, for testing purposes. This guide is useful to those |
74 |
interested in deploying synnefo in large scale, as a starting point that will |
75 |
help them get familiar with the synnefo components and overall architecture, as |
76 |
well as the interconnection between different services. Such an installation, |
77 |
also provides a quick preview of the basic synnefo features, although we would |
78 |
like to think that synnefo unveils its real power while scaling. |
79 |
|
80 |
The Administrator's Guide targets system administrators, who want to dive into |
81 |
more details and common tasks regarding Synnefo. The Developer's Guide targets |
82 |
developers, who want to build on top of Synnefo and so describes all the |
83 |
different types of interfaces Synnefo provides to the external world. The |
84 |
Integrator's Guide targets developers, who want to actually |
85 |
extend/modify/change Synnefo itself, so describes Synnefo's indepth |
86 |
architecture and the internals of Synnefo components. |
87 |
|
88 |
|
89 |
.. toctree:: |
90 |
:maxdepth: 1 |
91 |
|
92 |
Installation Guide/Overview <i-synnefo> |
93 |
|
94 |
.. toctree:: |
95 |
:maxdepth: 1 |
96 |
|
97 |
Quick Installation Guide (on two nodes) <quick-install-admin-guide> |
98 |
|
99 |
.. toctree:: |
100 |
:maxdepth: 2 |
101 |
|
102 |
Administrator's Guide <admin-guide> |
103 |
Developer's Guide <dev-guide> |
104 |
Integrator's Guide <intgrt-guide> |
105 |
|
106 |
|
107 |
List of all Synnefo components |
108 |
============================== |
109 |
|
110 |
Here are all Synnefo components. Combined in different ways, they provide all |
111 |
Synnefo services. All components are released as: |
112 |
|
113 |
.. toctree:: |
114 |
|
115 |
debian packages <http://docs.dev.grnet.gr/debs/> |
116 |
python packages <http://docs.dev.grnet.gr/pypi/> |
117 |
|
118 |
They are also available from our apt repository: ``apt.okeanos.grnet.gr`` |
119 |
|
120 |
* `snf-common <http://docs.dev.grnet.gr/snf-common/latest/index.html>`_ |
121 |
* `snf-webproject <http://docs.dev.grnet.gr/snf-webproject/latest/index.html>`_ |
122 |
* `snf-astakos-app <http://docs.dev.grnet.gr/astakos/latest/index.html>`_ |
123 |
* `snf-pithos-backend <http://docs.dev.grnet.gr/pithos/latest/backends.html>`_ |
124 |
* `snf-pithos-app <http://docs.dev.grnet.gr/pithos/latest/index.html>`_ |
125 |
* `snf-pithos-tools <http://docs.dev.grnet.gr/pithos/latest/index.html>`_ |
126 |
* `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_ |
127 |
* `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_ |
128 |
* `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_ |
129 |
* `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ |
130 |
* `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ |
131 |
* `snf-image-creator <http://docs.dev.grnet.gr/snf-image-creator/latest/index.html>`_ |
132 |
* `snf-occi <http://docs.dev.grnet.gr/snf-occi/latest/index.html>`_ |
133 |
* `snf-cloudcms <http://docs.dev.grnet.gr/snf-cloudcms/latest/index.html>`_ |
134 |
* `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_ |
135 |
|
136 |
|
137 |
Contact |
138 |
======= |
139 |
|
140 |
You can contact the Synnefo team at the following mailing lists: |
141 |
|
142 |
* Users list: synnefo@googlegroups.com |
143 |
* Developers list: synnefo-devel@googlegroups.com |
144 |
|
145 |
Indices and tables |
146 |
================== |
147 |
|
148 |
|
149 |
* :ref:`genindex` |
150 |
* :ref:`modindex` |
151 |
* :ref:`search` |