Revision f936cac5 docs/index.rst

b/docs/index.rst
1
Welcome to Synnefo's documentation
2
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1
Welcome to the Synnefo documentation
2
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3 3

  
4 4
.. image:: /images/synnefo-logo.png
5 5

  
......
7 7
Compute, Network, Image, Volume and Storage services, similar to the ones
8 8
offered by AWS. Synnefo manages multiple `Ganeti
9 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.
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.
12 13

  
13
You can see Synnefo in action, powering GRNET's
14
`~okeanos public cloud service <http://okeanos.grnet.gr>`_.
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>`_.
15 17

  
16 18
Synnefo has three main components providing the corresponding services:
17 19

  
......
22 24
   Pithos: File/Object Storage service <pithos>
23 25
   Cyclades: Compute/Network/Image/Volume services <cyclades>
24 26

  
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 27
This is an overview of the Synnefo services:
37 28

  
38 29
.. image:: images/synnefo-overview.png
39 30
   :target: _images/synnefo-overview.png
40 31

  
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.
32
Synnefo is designed with simplicity, scalability and stability in mind.
33
Furthermore, although it can be deployed in small configurations, it was
34
initially designed to address large installation problems.
44 35

  
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.
36
All Synnefo components use an intuitive settings mechanism, that adds and
37
removes settings dynamically as components are getting added or removed from a
38
physical node. All settings are stored in a single location.
48 39

  
49 40

  
50 41
.. _general-arch:
......
52 43
Synnefo General Architecture
53 44
============================
54 45

  
55
The following graph shows the whole Synnefo stack and how it interacts with
46
The following figure shows the whole Synnefo stack and how it interacts with
56 47
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:
48
from the cluster layer enhancing robustness, scalability, and ease of
49
administration and upgrades without impacting VM stability. As shown in the
50
figure below, Synnefo sits on the cloud layer:
59 51

  
60 52
.. image:: images/snf-architecture.png
61
   :width: 100%
62 53
   :target: _images/snf-architecture.png
63 54

  
64
Synnefo manages multiple Ganeti clusters and different kind of storage backends
65
such as a Ceph/RADOS cluster or an NFS-based backend.
55
Synnefo manages multiple Ganeti clusters and different storage backends
56
(e.g., Ceph/RADOS or NFS-based backends as shown in the figure).
66 57

  
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>`.
58
For an extensive view of all components, the interconnection and APIs between
59
them, please take a look at the Admin Guide's :ref:`corresponding figure
60
<syn+archip>`.
69 61

  
70 62

  
71 63
Synnefo Guides
......
80 72
whole Synnefo stack up and running and allows for a quick preview of the basic
81 73
Synnefo features.
82 74

  
83
The Admin's installation guide describes how to install the whole Synnefo stack
75
The Admin's Installation guide describes how to install the whole Synnefo stack
84 76
in just two physical nodes. This guide is useful to those interested in
85 77
deploying Synnefo in large scale, as a starting point that will help them get
86 78
familiar with the Synnefo components and overall architecture, as well as the
......
111 103
   Installation Guide (on two nodes) <quick-install-admin-guide>
112 104

  
113 105
.. toctree::
114
   :maxdepth: 2
106
   :maxdepth: 1
115 107

  
116 108
   Administrator's Guide <admin-guide>
117 109
   Developer's Guide <dev-guide>
118 110

  
119 111

  
120
List of all Synnefo components
121
==============================
112
Synnefo tools
113
=============
122 114

  
123
They are also available from our apt repository: ``apt.dev.grnet.gr``
115
There are also the following tools:
116

  
117
.. toctree::
118
   :maxdepth: 1
124 119

  
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://www.synnefo.org/docs/snf-vncauthproxy/latest/index.html>`_
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>`_
120
   kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html>
121
   snf-deploy: Synnefo deployment tool <snf-deploy>
122
   snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>
123
   snf-image: Secure image deployment tool <http://www.synnefo.org/docs/snf-image/latest/index.html>
124
   snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin>
140 125

  
141 126

  
142 127
Design
......
163 148
The official site is:
164 149

  
165 150
 `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`

Also available in: Unified diff