Revision 301294a9 docs/index.rst

b/docs/index.rst
17 17
   :maxdepth: 1
18 18

  
19 19
   Identity Management (codename: astakos) <astakos>
20
   Object Storage Service (codename: pithos+) <pithos>
20
   Object Storage Service (codename: pithos) <pithos>
21 21
   Compute Service (codename: cyclades) <cyclades>
22 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>
23
   Image Service (codename: plankton) <plankton>
25 24
   Volume Storage Service (codename: archipelago) <archipelago>
26 25

  
27 26
.. image:: images/synnefo-overview.png
28 27
   :target: _images/synnefo-overview.png
29 28

  
30
There are also components for:
29
There are also the following tools:
31 30

  
32 31
.. toctree::
33 32
   :maxdepth: 1
34 33

  
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>
34
   kamaki: Command-line client <http://docs.dev.grnet.gr/kamaki/latest/index.html>
35
   snf-image-creator: Image bundling/uploading/registering tool <http://docs.dev.grnet.gr/snf-image-creator/latest/index.html>
36
   snf-image: Secure image deployment tool <snf-image>
38 37

  
39 38
Synnefo is designed to be as simple, scalable and production ready as possible.
40 39
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.
40
target is large installations.
44 41

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

  
46
.. _general-arch:
49 47

  
50 48
Synnefo General Architecture
51 49
============================
52 50

  
53 51
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.
52
with multiple Ganeti clusters.
56 53

  
57
.. image:: images/synnefo-architecture1.png
54
.. image:: images/synnefo-arch2.png
58 55
   :width: 100%
59
   :target: _images/synnefo-architecture1.png
56
   :target: _images/synnefo-arch2.png
60 57

  
58
Synnefo also supports RADOS as an alternative storage backend for
59
Files/Images/VM disks. :ref:`Here <syn+archip+rados>` is a graph that shows
60
Synnefo running with two different storage backends.
61 61

  
62 62
Synnefo Guides
63 63
==============
64 64

  
65
There are 5 guides for Synnefo.
65
There are 4 guides for Synnefo.
66 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
67
The quick installation guide describes how to install the whole Synnefo stack
73 68
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
69
interested in deploying Synnefo in large scale, as a starting point that will
70
help them get familiar with the Synnefo components and overall architecture, as
76 71
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.
72
also provides a quick preview of the basic Synnefo features, although we would
73
like to think that Synnefo's real power unveils while scaling.
79 74

  
80 75
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.
76
more details and common tasks regarding Synnefo. For the experienced Synnefo
77
administrator, there is also a section that describes how to deploy Synnefo in
78
large scale with a corresponding guide.
87 79

  
88

  
89
.. toctree::
90
   :maxdepth: 1
91

  
92
   Installation Guide/Overview <i-synnefo>
80
The Developer's Guide targets developers, who want to build on top of Synnefo
81
and so describes all the different types of interfaces Synnefo provides to the
82
external world. The Integrator's Guide targets developers, who want to actually
83
extend/modify/change Synnefo itself, so describes Synnefo's indepth
84
architecture and the internals of Synnefo components (currently out-of-date!).
93 85

  
94 86
.. toctree::
95 87
   :maxdepth: 1
......
107 99
List of all Synnefo components
108 100
==============================
109 101

  
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 102
They are also available from our apt repository: ``apt.okeanos.grnet.gr``
119 103

  
120 104
 * `snf-common <http://docs.dev.grnet.gr/snf-common/latest/index.html>`_
......
122 106
 * `snf-astakos-app <http://docs.dev.grnet.gr/astakos/latest/index.html>`_
123 107
 * `snf-pithos-backend <http://docs.dev.grnet.gr/pithos/latest/backends.html>`_
124 108
 * `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 109
 * `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_
127 110
 * `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_
128 111
 * `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_
......
142 125
 * Users list: synnefo@googlegroups.com
143 126
 * Developers list: synnefo-devel@googlegroups.com
144 127

  
128
The official site is:
129

  
130
 `http://www.synnefo.org <http://www.synnefo.org>`_
131

  
145 132
Indices and tables
146 133
==================
147 134

  

Also available in: Unified diff