root / docs / index.rst @ b11446c1
History | View | Annotate | Download (4 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 3 guides for Synnefo. The Administrator's Guide targets system |
49 |
administrators, who want to deploy Synnefo on small or large installations. The |
50 |
Developer's Guide targets developers, who want to build on top of Synnefo and so |
51 |
describes all the different types of interfaces Synnefo provides to the external |
52 |
world. The Integrator's Guide targets developers, who want to actually |
53 |
extend/modify/change Synnefo itself, so describes Synnefo's indepth architecture |
54 |
and the internals of Synnefo components. |
55 |
|
56 |
.. toctree:: |
57 |
:maxdepth: 2 |
58 |
|
59 |
Administrator's Guide <admin-guide> |
60 |
Developer's Guide <dev-guide> |
61 |
Integrator's Guide <intgrt-guide> |
62 |
|
63 |
|
64 |
List of all Synnefo components |
65 |
============================== |
66 |
|
67 |
Here are all Synnefo components. Combined in different ways, they provide all |
68 |
Synnefo services. All components are released as: |
69 |
|
70 |
.. toctree:: |
71 |
|
72 |
debian packages <http://docs.dev.grnet.gr/debs/> |
73 |
python packages <http://docs.dev.grnet.gr/pypi/> |
74 |
|
75 |
They are also available from our apt repository: ``apt.okeanos.grnet.gr`` |
76 |
|
77 |
* `snf-common <http://docs.dev.grnet.gr/snf-common/latest/index.html>`_ |
78 |
* `snf-webproject <http://docs.dev.grnet.gr/snf-webproject/latest/index.html>`_ |
79 |
* `snf-astakos-app <http://docs.dev.grnet.gr/astakos/latest/index.html>`_ |
80 |
* `snf-pithos-backend <http://docs.dev.grnet.gr/pithos/latest/backends.html>`_ |
81 |
* `snf-pithos-app <http://docs.dev.grnet.gr/pithos/latest/index.html>`_ |
82 |
* `snf-pithos-tools <http://docs.dev.grnet.gr/pithos/latest/index.html>`_ |
83 |
* `snf-pithos-webclient <http://docs.dev.grnet.gr/pithos-webclient/latest/index.html>`_ |
84 |
* `snf-cyclades-app <http://docs.dev.grnet.gr/snf-cyclades-app/latest/index.html>`_ |
85 |
* `snf-cyclades-gtools <http://docs.dev.grnet.gr/snf-cyclades-gtools/latest/index.html>`_ |
86 |
* `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ |
87 |
* `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ |
88 |
* `snf-occi <http://docs.dev.grnet.gr/snf-occi/latest/index.html>`_ |
89 |
* `snf-cloudcms <http://docs.dev.grnet.gr/snf-cloudcms/latest/index.html>`_ |
90 |
* `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_ |
91 |
|
92 |
|
93 |
Contact |
94 |
======= |
95 |
|
96 |
You can contact the Synnefo team at: synnefo@lists.grnet.gr |
97 |
|
98 |
|
99 |
Indices and tables |
100 |
================== |
101 |
|
102 |
|
103 |
* :ref:`genindex` |
104 |
* :ref:`modindex` |
105 |
* :ref:`search` |