root / docs / index.rst @ fde2c1f7
History | View | Annotate | Download (6.5 kB)
1 |
Welcome to Synnefo's 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. To boost 3rd-party compatibility, Synnefo exposes the |
11 |
OpenStack APIs to users. |
12 |
|
13 |
You can see Synnefo in action, powering GRNET's |
14 |
`~okeanos public cloud service <http://okeanos.grnet.gr>`_. |
15 |
|
16 |
Synnefo has three main components providing the corresponding services: |
17 |
|
18 |
.. toctree:: |
19 |
:maxdepth: 1 |
20 |
|
21 |
Astakos: Identity/Account services <astakos> |
22 |
Pithos: File/Object Storage service <pithos> |
23 |
Cyclades: Compute/Network/Image/Volume services <cyclades> |
24 |
|
25 |
There are also the following tools: |
26 |
|
27 |
.. toctree:: |
28 |
:maxdepth: 1 |
29 |
|
30 |
kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html> |
31 |
snf-deploy: Synnefo deployment tool <snf-deploy> |
32 |
snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html> |
33 |
snf-image: Secure image deployment tool <http://www.synnefo.org/docs/snf-image/latest/index.html> |
34 |
snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin> |
35 |
|
36 |
This is an overview of the Synnefo services: |
37 |
|
38 |
.. image:: images/synnefo-overview.png |
39 |
:target: _images/synnefo-overview.png |
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 stack and how it interacts with |
56 |
multiple Ganeti clusters and the storage backends. Synnefo decouples the cloud |
57 |
from the cluster layer enhancing robustness, stability and ease of |
58 |
administration. As shown in the figure below, Synnefo sits on the cloud layer: |
59 |
|
60 |
.. image:: images/snf-architecture.png |
61 |
:width: 100% |
62 |
:target: _images/snf-architecture.png |
63 |
|
64 |
Synnefo manages multiple Ganeti clusters and different kind of storage backends |
65 |
such as a Ceph/RADOS cluster or an NFS-based backend. |
66 |
|
67 |
For an extensive view of all components and APIs between them, please take a |
68 |
look at the Admin Guide's :ref:`corresponding figure <syn+archip>`. |
69 |
|
70 |
|
71 |
Synnefo Guides |
72 |
============== |
73 |
|
74 |
There are 4 guides for Synnefo. |
75 |
|
76 |
The Quick Installation guide describes how to install Synnefo on a single node |
77 |
in less than 10 minutes using the `snf-deploy` tool. This kind of installation |
78 |
is targeted for testing and demo environments rather than production usage |
79 |
deployments. It is the perfect way, even for an inexperienced user to have the |
80 |
whole Synnefo stack up and running and allows for a quick preview of the basic |
81 |
Synnefo features. |
82 |
|
83 |
The Admin's installation guide describes how to install the whole Synnefo stack |
84 |
in just two physical nodes. This guide is useful to those interested in |
85 |
deploying Synnefo in large scale, as a starting point that will help them get |
86 |
familiar with the Synnefo components and overall architecture, as well as the |
87 |
interconnection between different services. This guide explains the whole |
88 |
procedure step by step, without the use of the `snf-deploy` tool. Anyone |
89 |
familiar with this guide, will be able to easily install Synnefo in a larger |
90 |
number of nodes too, or even expand the two node installation dynamically. |
91 |
|
92 |
The Administrator's Guide targets system administrators, who want to dive into |
93 |
more details and common tasks regarding Synnefo. For the experienced Synnefo |
94 |
administrator, there is also a section that describes how to do scale-out |
95 |
Synnefo deployments with corresponding examples. This targets large scale |
96 |
installations of Synnefo. |
97 |
|
98 |
The Developer's Guide targets developers, who want to build on top of Synnefo |
99 |
and so describes all the different types of interfaces Synnefo provides to the |
100 |
external world. Also documents all Synnefo external REST APIs. |
101 |
|
102 |
.. The Integrator's Guide targets developers, who want to actually |
103 |
.. extend/modify/change Synnefo itself, so describes Synnefo's indepth |
104 |
.. architecture and the internals of Synnefo components (currently out-of-date!). |
105 |
|
106 |
|
107 |
.. toctree:: |
108 |
:maxdepth: 1 |
109 |
|
110 |
Quick Installation Guide (single node) <quick-install-guide> |
111 |
Installation Guide (on two nodes) <quick-install-admin-guide> |
112 |
|
113 |
.. toctree:: |
114 |
:maxdepth: 2 |
115 |
|
116 |
Administrator's Guide <admin-guide> |
117 |
Developer's Guide <dev-guide> |
118 |
|
119 |
|
120 |
List of all Synnefo components |
121 |
============================== |
122 |
|
123 |
They are also available from our apt repository: ``apt.dev.grnet.gr`` |
124 |
|
125 |
* `snf-common <http://www.synnefo.org/docs/snf-common/latest/index.html>`_ |
126 |
* `snf-webproject <http://www.synnefo.org/docs/snf-webproject/latest/index.html>`_ |
127 |
* `snf-astakos-app <http://www.synnefo.org/docs/astakos/latest/index.html>`_ |
128 |
* `snf-pithos-backend <http://www.synnefo.org/docs/pithos/latest/backends.html>`_ |
129 |
* `snf-pithos-app <http://www.synnefo.org/docs/pithos/latest/index.html>`_ |
130 |
* `snf-pithos-webclient <http://www.synnefo.org/docs/pithos-webclient/latest/index.html>`_ |
131 |
* `snf-cyclades-app <http://www.synnefo.org/docs/snf-cyclades-app/latest/index.html>`_ |
132 |
* `snf-cyclades-gtools <http://www.synnefo.org/docs/snf-cyclades-gtools/latest/index.html>`_ |
133 |
* `astakosclient <http://www.synnefo.org/docs/astakosclient/latest/index.html>`_ |
134 |
* `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ |
135 |
* `snf-image <http://www.synnefo.org/docs/snf-image/latest/index.html/>`_ |
136 |
* `snf-image-creator <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>`_ |
137 |
* `snf-occi <http://www.synnefo.org/docs/snf-occi/latest/index.html>`_ |
138 |
* `snf-cloudcms <http://www.synnefo.org/docs/snf-cloudcms/latest/index.html>`_ |
139 |
* `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_ |
140 |
|
141 |
|
142 |
Design |
143 |
====== |
144 |
|
145 |
Drafts |
146 |
------ |
147 |
|
148 |
.. toctree:: |
149 |
:maxdepth: 1 |
150 |
|
151 |
Sample design <design/sample> |
152 |
Resource-pool projects design <design/resource-pool-projects> |
153 |
|
154 |
|
155 |
Contact |
156 |
======= |
157 |
|
158 |
You can contact the Synnefo team at the following mailing lists: |
159 |
|
160 |
* Users list: synnefo@googlegroups.com |
161 |
* Developers list: synnefo-devel@googlegroups.com |
162 |
|
163 |
The official site is: |
164 |
|
165 |
`http://www.synnefo.org <http://www.synnefo.org>`_ |
166 |
|
167 |
Indices and tables |
168 |
================== |
169 |
|
170 |
|
171 |
* :ref:`genindex` |
172 |
* :ref:`modindex` |
173 |
* :ref:`search` |