root / docs / index.rst @ 81243c3d
History | View | Annotate | Download (3.3 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 |
Compute Service (codename: cyclades) <cyclades> |
17 |
File Storage Service (codename: pithos+) <http://docs.dev.grnet.gr/pithos> |
18 |
Image Registry (codename: plankton) <http://docs.dev.grnet.gr/cyclades/plankton> |
19 |
Volume Storage Service (codename: archipelagos) <http://docs.dev.grnet.gr/archipelagos> |
20 |
Identity Management (codename: astakos) <http://docs.dev.grnet.gr/astakos> |
21 |
Billing Service (codename: aquarium) <http://docs.dev.grnet.gr/aquarium> |
22 |
|
23 |
There are also components for: |
24 |
|
25 |
.. toctree:: |
26 |
:maxdepth: 1 |
27 |
|
28 |
Secure image deployment (image tool) <snf-image> |
29 |
Command-line cloud management (kamaki tool) <http://docs.dev.grnet.gr/cyclades/kamaki> |
30 |
|
31 |
synnefo is designed to be as simple, scalable and production ready as possible. |
32 |
Furthermore, although it can be deployed in small configurations, its prime |
33 |
target is large installations. If you are planning for the latter, you should |
34 |
first be completely aware of what you want to provide, the architecture of your |
35 |
cluster/s and synnefo's overall architecture before you start deploying. |
36 |
|
37 |
All synnefo components use an intuitive settings mechanism, that gives you the |
38 |
ability to either deploy the above services independently and standalone, or |
39 |
interconnected with each other, in large configurations. |
40 |
|
41 |
For complete documentation on each service's architecture, installation, |
42 |
configuration, components needed, interfaces, APIs, and deployment follow the |
43 |
above links. You can also browse all synnefo component in this list. |
44 |
|
45 |
Quick Installation Guide |
46 |
------------------------ |
47 |
|
48 |
A quick installation guide is provided, that describes how to install synnefo in |
49 |
just one physical node for testing and development purposes. This guide is also |
50 |
useful to those interested in deploying synnefo in large scale, as a starting |
51 |
point that will help them get familiar with the synnefo components and overall |
52 |
architecture, as well as the interconnection between different services. Such an |
53 |
installation, also provides a quick preview of the basic synnefo features, |
54 |
although we would like to think that its real power will unveil while scaling. |
55 |
|
56 |
The quick installation guide comes in two versions: |
57 |
|
58 |
| :ref:`Administrator's quick installation guide <quick-install-admin-guide>` |
59 |
| This guide will walk you through a complete installation using debian packages. |
60 |
|
61 |
| :ref:`Developer's quick installation guide <quick-install-dev-guide>` |
62 |
| This guide will setup a development environment using pip install. |
63 |
|
64 |
Standard Installation |
65 |
--------------------- |
66 |
|
67 |
Also a complete standard installation guide will soon be available, that will |
68 |
describe thoroughly how to deploy all services, interconnected with each other, |
69 |
on multiple physical nodes. For now, please refer to each services own |
70 |
documentation. |
71 |
|
72 |
Contact |
73 |
------- |
74 |
|
75 |
You can contact the synnefo team at: synnefo@lists.grnet.gr |
76 |
|
77 |
Indices and tables |
78 |
------------------ |
79 |
|
80 |
|
81 |
* :ref:`genindex` |
82 |
* :ref:`modindex` |
83 |
* :ref:`search` |