Statistics
| Branch: | Tag: | Revision:

root / docs / index.rst @ 70f13b0f

History | View | Annotate | Download (3.3 kB)

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