root / docs / index.rst @ 2c85833e
History | View | Annotate | Download (3.9 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/Network Service (codename: cyclades) <cyclades> |
19 |
Image Registry (codename: plankton) <plankton> |
20 |
Billing Service (codename: aquarium) <http://docs.dev.grnet.gr/aquarium/latest/index.html> |
21 |
Volume Storage Service (codename: archipelago) <archipelago> |
22 |
|
23 |
.. image:: images/synnefo-overview.png |
24 |
|
25 |
There are also components for: |
26 |
|
27 |
.. toctree:: |
28 |
:maxdepth: 1 |
29 |
|
30 |
Secure image deployment (image tool) <snf-image> |
31 |
Command-line cloud management (kamaki tool) <http://docs.dev.grnet.gr/kamaki/latest/index.html> |
32 |
|
33 |
synnefo is designed to be as simple, scalable and production ready as possible. |
34 |
Furthermore, although it can be deployed in small configurations, its prime |
35 |
target is large installations. If you are planning for the latter, you should |
36 |
first be completely aware of what you want to provide, the architecture of your |
37 |
cluster/s and synnefo's overall architecture before you start deploying. |
38 |
|
39 |
All synnefo components use an intuitive settings mechanism, that gives you the |
40 |
ability to either deploy the above services independently and standalone, or |
41 |
interconnected with each other, in large configurations. |
42 |
|
43 |
|
44 |
Synnefo Guides |
45 |
============== |
46 |
|
47 |
There are 3 guides for Synnefo. The Administrator's Guide targets system |
48 |
administrators, who want to deploy synnefo on small or large installations. The |
49 |
Developer's Guide targets developers, who want to build on top of synnefo and so |
50 |
describes all the different types of interfaces synnefo provides to the external |
51 |
world. The Integrator's Guide targets developers, who want to actually |
52 |
extend/modify/change synnefo itself, so describes synnefo's indepth architecture |
53 |
and the internals of synnefo components. |
54 |
|
55 |
.. toctree:: |
56 |
:maxdepth: 2 |
57 |
|
58 |
Administrator's Guide <admin-guide> |
59 |
Developer's Guide <dev-guide> |
60 |
Integrator's Guide <intgrt-guide> |
61 |
|
62 |
|
63 |
List of all Synnefo components |
64 |
============================== |
65 |
|
66 |
Here are all synnefo components. Combined in different ways, they provide all |
67 |
synnefo services. All components are released as: |
68 |
|
69 |
.. toctree:: |
70 |
|
71 |
debian packages <http://docs.dev.grnet.gr/debs/> |
72 |
python packages <http://docs.dev.grnet.gr/pypi/> |
73 |
|
74 |
They are also available from our apt repository: ``apt.okeanos.grnet.gr`` |
75 |
|
76 |
* `snf-common <http://docs.dev.grnet.gr/snf-common/latest/index.html>`_ |
77 |
* `snf-webproject <http://docs.dev.grnet.gr/snf-webproject/latest/index.html>`_ |
78 |
* `snf-astakos-app <http://docs.dev.grnet.gr/astakos/latest/index.html>`_ |
79 |
* `snf-pithos-backend <http://docs.dev.grnet.gr/pithos/latest/backends.html>`_ |
80 |
* `snf-pithos-app <http://docs.dev.grnet.gr/pithos/latest/index.html>`_ |
81 |
* `snf-pithos-tools <http://docs.dev.grnet.gr/pithos/latest/index.html>`_ |
82 |
* `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_ |
83 |
* `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_ |
84 |
* `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_ |
85 |
* `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ |
86 |
* `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ |
87 |
* `snf-occi <http://docs.dev.grnet.gr/snf-occi/latest/index.html>`_ |
88 |
* `snf-cloudcms <http://docs.dev.grnet.gr/snf-cloudcms/latest/index.html>`_ |
89 |
* `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_ |
90 |
|
91 |
|
92 |
Contact |
93 |
======= |
94 |
|
95 |
You can contact the synnefo team at: synnefo@lists.grnet.gr |
96 |
|
97 |
|
98 |
Indices and tables |
99 |
================== |
100 |
|
101 |
|
102 |
* :ref:`genindex` |
103 |
* :ref:`modindex` |
104 |
* :ref:`search` |