root / docs / index.rst @ d9667d93
History | View | Annotate | Download (5.5 kB)
1 |
Welcome to the Synnefo documentation |
---|---|
2 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
3 |
|
4 |
.. image:: /images/synnefo-logo.png |
5 |
|
6 |
Synnefo is a complete open source cloud stack written in Python that provides |
7 |
Compute, Network, Image, Volume and Storage services, similar to the ones |
8 |
offered by AWS. Synnefo manages multiple `Ganeti |
9 |
<http://code.google.com/p/ganeti>`_ clusters at the backend for handling of |
10 |
low-level VM operations and uses `Archipelago |
11 |
<http://www.synnefo.org/docs/archipelago/latest/>`_ to unify cloud storage. To |
12 |
boost 3rd-party compatibility, Synnefo exposes the OpenStack APIs to users. |
13 |
|
14 |
Synnefo powers GRNET's `~okeanos public cloud service |
15 |
<http://okeanos.grnet.gr>`_ and you can try it out live at `demo.synnefo.org |
16 |
<http://demo.synnefo.org>`_. |
17 |
|
18 |
Synnefo has three main components providing the corresponding services: |
19 |
|
20 |
.. toctree:: |
21 |
:maxdepth: 1 |
22 |
|
23 |
Astakos: Identity/Account services <astakos> |
24 |
Pithos: File/Object Storage service <pithos> |
25 |
Cyclades: Compute/Network/Image/Volume services <cyclades> |
26 |
|
27 |
This is an overview of the Synnefo services: |
28 |
|
29 |
.. image:: images/synnefo-overview.png |
30 |
:width: 70% |
31 |
:target: _images/synnefo-overview.png |
32 |
|
33 |
Synnefo is designed with simplicity, scalability and stability in mind. |
34 |
Although it can be deployed in small configurations, it was initially designed |
35 |
to address large-scale installation problems. |
36 |
|
37 |
All Synnefo components use an intuitive settings mechanism, that adds and |
38 |
removes settings dynamically as components are getting added or removed from a |
39 |
physical node. All settings are stored in a single location. |
40 |
|
41 |
|
42 |
.. _general-arch: |
43 |
|
44 |
Synnefo General Architecture |
45 |
============================ |
46 |
|
47 |
The following figure shows the whole Synnefo stack and how it interacts with |
48 |
multiple Ganeti clusters and the storage backends. Synnefo decouples the cloud |
49 |
from the cluster layer, enhancing robustness and easing administration and |
50 |
upgrades without impacting VM stability. As shown in the figure below, Synnefo |
51 |
sits on the cloud layer: |
52 |
|
53 |
.. image:: images/snf-architecture.png |
54 |
:width: 70% |
55 |
:target: _images/snf-architecture.png |
56 |
|
57 |
Synnefo manages multiple Ganeti clusters and different storage backends |
58 |
(e.g., Ceph/RADOS or NFS-based backends as shown in the figure). |
59 |
|
60 |
For an extensive view of all components, the interconnection and APIs between |
61 |
them, please take a look at the Admin Guide's :ref:`corresponding figure |
62 |
<syn+archip>`. |
63 |
|
64 |
|
65 |
Synnefo Guides |
66 |
============== |
67 |
|
68 |
There are 4 guides for Synnefo. |
69 |
|
70 |
The Quick Installation guide describes how to install Synnefo on a single node |
71 |
in less than 10 minutes using the `snf-deploy` tool. This kind of installation |
72 |
is targeted for testing and demo environments rather than production usage |
73 |
deployments. It is the perfect way, even for an inexperienced user to have the |
74 |
whole Synnefo stack up and running and allows for a quick preview of the basic |
75 |
Synnefo features. |
76 |
|
77 |
The Admin's Installation guide describes how to install the whole Synnefo stack |
78 |
in just two physical nodes. This guide is useful to those interested in |
79 |
deploying Synnefo in large scale, as a starting point that will help them get |
80 |
familiar with the Synnefo components and overall architecture, as well as the |
81 |
interconnection between different services. This guide explains the whole |
82 |
procedure step by step, without the use of the `snf-deploy` tool. Anyone |
83 |
familiar with this guide, will be able to easily install Synnefo in a larger |
84 |
number of nodes too, or even expand the two node installation dynamically. |
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 (single node) <quick-install-guide> |
105 |
Installation Guide (on two nodes) <quick-install-admin-guide> |
106 |
|
107 |
.. toctree:: |
108 |
:maxdepth: 1 |
109 |
|
110 |
Administrator's Guide <admin-guide> |
111 |
Developer's Guide <dev-guide> |
112 |
API Guide <api-guide> |
113 |
|
114 |
|
115 |
Synnefo tools |
116 |
============= |
117 |
|
118 |
There are also the following tools: |
119 |
|
120 |
.. toctree:: |
121 |
:maxdepth: 1 |
122 |
|
123 |
kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html> |
124 |
snf-deploy: Synnefo deployment tool <snf-deploy> |
125 |
snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html> |
126 |
snf-image: Secure image deployment tool <http://www.synnefo.org/docs/snf-image/latest/index.html> |
127 |
snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin> |
128 |
|
129 |
|
130 |
Design |
131 |
====== |
132 |
|
133 |
v0.15 |
134 |
----- |
135 |
|
136 |
.. toctree:: |
137 |
:maxdepth: 1 |
138 |
|
139 |
Pithos separate view domain <design/pithos-separate-view-domain> |
140 |
Cyclades networking <design/cyclades-networking> |
141 |
Astakos resource defaults <design/resource-defaults> |
142 |
|
143 |
Drafts |
144 |
------ |
145 |
|
146 |
.. toctree:: |
147 |
:maxdepth: 1 |
148 |
|
149 |
Resource-pool projects design <design/resource-pool-projects> |
150 |
|
151 |
|
152 |
Contact |
153 |
======= |
154 |
|
155 |
You can contact the Synnefo team at the following mailing lists: |
156 |
|
157 |
* Users list: synnefo@googlegroups.com |
158 |
* Developers list: synnefo-devel@googlegroups.com |
159 |
|
160 |
The official site is: |
161 |
|
162 |
`http://www.synnefo.org <http://www.synnefo.org>`_ |