Statistics
| Branch: | Tag: | Revision:

root / docs / index.rst @ 7a3439cf

History | View | Annotate | Download (4.6 kB)

1
Welcome to Synnefo's documentation
2
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3

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

    
6
Synnefo is opensource software, used to create massively scalable IaaS clouds.
7

    
8
| You can see Synnefo in action, powering GRNET's
9
  `~okeanos cloud service <https://okeanos.grnet.gr>`_.
10
| It is a collection of components (snf-*), most of them written in python, that
11
  are used as the building bricks to provide the following services:
12

    
13
.. toctree::
14
   :maxdepth: 1
15

    
16
   Identity Management (codename: astakos) <astakos>
17
   Object Storage Service (codename: pithos+) <pithos>
18
   Compute Service (codename: cyclades) <cyclades>
19
   Network Service (part of Cyclades) <networks>
20
   Image Registry (codename: plankton) <plankton>
21
   Billing Service (codename: aquarium) <http://docs.dev.grnet.gr/aquarium/latest/index.html>
22
   Volume Storage Service (codename: archipelago) <archipelago>
23

    
24
.. image:: images/synnefo-overview.png
25

    
26
There are also components for:
27

    
28
.. toctree::
29
   :maxdepth: 1
30

    
31
   Secure image deployment (image tool) <snf-image>
32
   Command-line cloud management (kamaki tool) <http://docs.dev.grnet.gr/kamaki/latest/index.html>
33

    
34
Synnefo is designed to be as simple, scalable and production ready as possible.
35
Furthermore, although it can be deployed in small configurations, its prime
36
target is large installations. If you are planning for the latter, you should
37
first be completely aware of what you want to provide, the architecture of your
38
cluster/s and Synnefo's overall architecture before you start deploying.
39

    
40
All Synnefo components use an intuitive settings mechanism, that gives you the
41
ability to either deploy the above services independently and standalone, or
42
interconnected with each other, in large configurations.
43

    
44

    
45
Synnefo Guides
46
==============
47

    
48
There are 4 guides for Synnefo.
49

    
50
The quick installation guide describes how to install the whole synnefo stack
51
in just two physical nodes, for testing purposes. This guide is useful to those
52
interested in deploying synnefo in large scale, as a starting point that will
53
help them get familiar with the synnefo components and overall architecture, as
54
well as the interconnection between different services. Such an installation,
55
also provides a quick preview of the basic synnefo features, although we would
56
like to think that synnefo unveils its real power while scaling.
57

    
58
The Administrator's Guide targets system administrators, who want to dive into
59
more details and common tasks regarding Synnefo. The Developer's Guide targets
60
developers, who want to build on top of Synnefo and so describes all the
61
different types of interfaces Synnefo provides to the external world. The
62
Integrator's Guide targets developers, who want to actually
63
extend/modify/change Synnefo itself, so describes Synnefo's indepth
64
architecture and the internals of Synnefo components.
65

    
66
.. toctree::
67
   :maxdepth: 1
68

    
69
   Quick Installation Guide <quick-install-admin-guide>
70

    
71
.. toctree::
72
   :maxdepth: 2
73

    
74
   Administrator's Guide <admin-guide>
75
   Developer's Guide <dev-guide>
76
   Integrator's Guide <intgrt-guide>
77

    
78

    
79
List of all Synnefo components
80
==============================
81

    
82
Here are all Synnefo components. Combined in different ways, they provide all
83
Synnefo services. All components are released as:
84

    
85
.. toctree::
86

    
87
   debian packages <http://docs.dev.grnet.gr/debs/>
88
   python packages <http://docs.dev.grnet.gr/pypi/>
89

    
90
They are also available from our apt repository: ``apt.okeanos.grnet.gr``
91

    
92
 * `snf-common <http://docs.dev.grnet.gr/snf-common/latest/index.html>`_
93
 * `snf-webproject <http://docs.dev.grnet.gr/snf-webproject/latest/index.html>`_
94
 * `snf-astakos-app <http://docs.dev.grnet.gr/astakos/latest/index.html>`_
95
 * `snf-pithos-backend <http://docs.dev.grnet.gr/pithos/latest/backends.html>`_
96
 * `snf-pithos-app <http://docs.dev.grnet.gr/pithos/latest/index.html>`_
97
 * `snf-pithos-tools <http://docs.dev.grnet.gr/pithos/latest/index.html>`_
98
 * `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_
99
 * `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_
100
 * `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_
101
 * `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_
102
 * `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ 
103
 * `snf-occi <http://docs.dev.grnet.gr/snf-occi/latest/index.html>`_
104
 * `snf-cloudcms <http://docs.dev.grnet.gr/snf-cloudcms/latest/index.html>`_
105
 * `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_
106

    
107

    
108
Contact
109
=======
110

    
111
You can contact the Synnefo team at: synnefo@lists.grnet.gr
112

    
113

    
114
Indices and tables
115
==================
116

    
117

    
118
* :ref:`genindex`
119
* :ref:`modindex`
120
* :ref:`search`