root / docs / index.rst @ d29f0371
History | View | Annotate | Download (6 kB)
1 | aacbeed2 | Constantinos Venetsanopoulos | Welcome to Synnefo's documentation |
---|---|---|---|
2 | bc055d09 | Constantinos Venetsanopoulos | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
3 | 9940eacf | Kostas Papadimitriou | |
4 | 9940eacf | Kostas Papadimitriou | .. image:: /images/synnefo-logo.png |
5 | 9940eacf | Kostas Papadimitriou | |
6 | 31e6eb2d | Constantinos Venetsanopoulos | | Synnefo is open source cloud software, used to create massively scalable IaaS |
7 | 31e6eb2d | Constantinos Venetsanopoulos | clouds. |
8 | 64bcbfe9 | Kostas Papadimitriou | | Synnefo uses `Google Ganeti <http://code.google.com/p/ganeti/>`_ for the low |
9 | 31e6eb2d | Constantinos Venetsanopoulos | level VM management part. |
10 | 9940eacf | Kostas Papadimitriou | |
11 | aacbeed2 | Constantinos Venetsanopoulos | | You can see Synnefo in action, powering GRNET's |
12 | 31e6eb2d | Constantinos Venetsanopoulos | `~okeanos public cloud service <http://okeanos.io>`_. |
13 | 52f2c69b | Stavros Sachtouris | | It is a collection of components (``snf-*``), most of them written in python, that |
14 | d0e436db | Constantinos Venetsanopoulos | are used as the building bricks to provide the following services: |
15 | 9940eacf | Kostas Papadimitriou | |
16 | d0e436db | Constantinos Venetsanopoulos | .. toctree:: |
17 | d0e436db | Constantinos Venetsanopoulos | :maxdepth: 1 |
18 | 9940eacf | Kostas Papadimitriou | |
19 | bc055d09 | Constantinos Venetsanopoulos | Identity Management (codename: astakos) <astakos> |
20 | 301294a9 | Constantinos Venetsanopoulos | Object Storage Service (codename: pithos) <pithos> |
21 | b11446c1 | Constantinos Venetsanopoulos | Compute Service (codename: cyclades) <cyclades> |
22 | b11446c1 | Constantinos Venetsanopoulos | Network Service (part of Cyclades) <networks> |
23 | 73ebcd68 | Constantinos Venetsanopoulos | Image Service (part of Cyclades) <plankton> |
24 | bc055d09 | Constantinos Venetsanopoulos | Volume Storage Service (codename: archipelago) <archipelago> |
25 | d0e436db | Constantinos Venetsanopoulos | |
26 | d6153e72 | Kostas Papadimitriou | .. image:: images/synnefo-overview.png |
27 | 16539dad | Kostas Papadimitriou | :target: _images/synnefo-overview.png |
28 | d6153e72 | Kostas Papadimitriou | |
29 | 301294a9 | Constantinos Venetsanopoulos | There are also the following tools: |
30 | 9940eacf | Kostas Papadimitriou | |
31 | 9940eacf | Kostas Papadimitriou | .. toctree:: |
32 | 9940eacf | Kostas Papadimitriou | :maxdepth: 1 |
33 | 9940eacf | Kostas Papadimitriou | |
34 | 34e79416 | Constantinos Venetsanopoulos | kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html> |
35 | 20c0dfdc | Dimitris Aragiorgis | snf-deploy: Synnefo deployment tool <snf-deploy> |
36 | 34e79416 | Constantinos Venetsanopoulos | snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html> |
37 | 301294a9 | Constantinos Venetsanopoulos | snf-image: Secure image deployment tool <snf-image> |
38 | 4f7d5233 | Ilias Tsitsimpis | snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin> |
39 | 77180645 | Dimitris Aragiorgis | |
40 | d0e436db | Constantinos Venetsanopoulos | |
41 | aacbeed2 | Constantinos Venetsanopoulos | Synnefo is designed to be as simple, scalable and production ready as possible. |
42 | d0e436db | Constantinos Venetsanopoulos | Furthermore, although it can be deployed in small configurations, its prime |
43 | 301294a9 | Constantinos Venetsanopoulos | target is large installations. |
44 | d0e436db | Constantinos Venetsanopoulos | |
45 | 301294a9 | Constantinos Venetsanopoulos | All Synnefo components use an intuitive settings mechanism, that adds and removes |
46 | 301294a9 | Constantinos Venetsanopoulos | settings dynamically as components are getting added or removed from a physical |
47 | 301294a9 | Constantinos Venetsanopoulos | node. All settings are stored in a single location. |
48 | d0e436db | Constantinos Venetsanopoulos | |
49 | 301294a9 | Constantinos Venetsanopoulos | .. _general-arch: |
50 | d0e436db | Constantinos Venetsanopoulos | |
51 | eab73849 | Constantinos Venetsanopoulos | Synnefo General Architecture |
52 | eab73849 | Constantinos Venetsanopoulos | ============================ |
53 | eab73849 | Constantinos Venetsanopoulos | |
54 | eab73849 | Constantinos Venetsanopoulos | The following graph shows the whole Synnefo architecture and how it interacts |
55 | 301294a9 | Constantinos Venetsanopoulos | with multiple Ganeti clusters. |
56 | eab73849 | Constantinos Venetsanopoulos | |
57 | 301294a9 | Constantinos Venetsanopoulos | .. image:: images/synnefo-arch2.png |
58 | 16539dad | Kostas Papadimitriou | :width: 100% |
59 | 301294a9 | Constantinos Venetsanopoulos | :target: _images/synnefo-arch2.png |
60 | eab73849 | Constantinos Venetsanopoulos | |
61 | 301294a9 | Constantinos Venetsanopoulos | Synnefo also supports RADOS as an alternative storage backend for |
62 | 301294a9 | Constantinos Venetsanopoulos | Files/Images/VM disks. :ref:`Here <syn+archip+rados>` is a graph that shows |
63 | 301294a9 | Constantinos Venetsanopoulos | Synnefo running with two different storage backends. |
64 | eab73849 | Constantinos Venetsanopoulos | |
65 | bc055d09 | Constantinos Venetsanopoulos | Synnefo Guides |
66 | bc055d09 | Constantinos Venetsanopoulos | ============== |
67 | d0e436db | Constantinos Venetsanopoulos | |
68 | 2ca07643 | Constantinos Venetsanopoulos | There are 4 guides for Synnefo. |
69 | 2ca07643 | Constantinos Venetsanopoulos | |
70 | 2ca07643 | Constantinos Venetsanopoulos | The Quick Installation guide describes how to install Synnefo on a single node |
71 | 2ca07643 | Constantinos Venetsanopoulos | in less than 10 minutes using the `snf-deploy` tool. This kind of installation |
72 | 2ca07643 | Constantinos Venetsanopoulos | is targeted for testing and demo environments rather than production usage |
73 | 2ca07643 | Constantinos Venetsanopoulos | deployments. It is the perfect way, even for an inexperienced user to have the |
74 | 2ca07643 | Constantinos Venetsanopoulos | whole Synnefo stack up and running and allows for a quick preview of the basic |
75 | 2ca07643 | Constantinos Venetsanopoulos | Synnefo features. |
76 | 2ca07643 | Constantinos Venetsanopoulos | |
77 | 2ca07643 | Constantinos Venetsanopoulos | The Admin's installation guide describes how to install the whole Synnefo stack |
78 | 2ca07643 | Constantinos Venetsanopoulos | in just two physical nodes. This guide is useful to those interested in |
79 | 2ca07643 | Constantinos Venetsanopoulos | deploying Synnefo in large scale, as a starting point that will help them get |
80 | 2ca07643 | Constantinos Venetsanopoulos | familiar with the Synnefo components and overall architecture, as well as the |
81 | 2ca07643 | Constantinos Venetsanopoulos | interconnection between different services. This guide explains the whole |
82 | 2ca07643 | Constantinos Venetsanopoulos | procedure step by step, without the use of the `snf-deploy` tool. Anyone |
83 | 2ca07643 | Constantinos Venetsanopoulos | familiar with this guide, will be able to easily install Synnefo in a larger |
84 | 2ca07643 | Constantinos Venetsanopoulos | number of nodes too, or even expand the two node installation dynamically. |
85 | 7a3439cf | Constantinos Venetsanopoulos | |
86 | 7a3439cf | Constantinos Venetsanopoulos | The Administrator's Guide targets system administrators, who want to dive into |
87 | 301294a9 | Constantinos Venetsanopoulos | more details and common tasks regarding Synnefo. For the experienced Synnefo |
88 | 8b5be818 | Constantinos Venetsanopoulos | administrator, there is also a section that describes how to do scale-out |
89 | 8b5be818 | Constantinos Venetsanopoulos | Synnefo deployments with corresponding examples. This targets large scale |
90 | 8b5be818 | Constantinos Venetsanopoulos | installations of Synnefo. |
91 | 7a3439cf | Constantinos Venetsanopoulos | |
92 | 301294a9 | Constantinos Venetsanopoulos | The Developer's Guide targets developers, who want to build on top of Synnefo |
93 | 301294a9 | Constantinos Venetsanopoulos | and so describes all the different types of interfaces Synnefo provides to the |
94 | 8b5be818 | Constantinos Venetsanopoulos | external world. Also documents all Synnefo external REST APIs. |
95 | 8b5be818 | Constantinos Venetsanopoulos | |
96 | 8b5be818 | Constantinos Venetsanopoulos | .. The Integrator's Guide targets developers, who want to actually |
97 | 8b5be818 | Constantinos Venetsanopoulos | .. extend/modify/change Synnefo itself, so describes Synnefo's indepth |
98 | 8b5be818 | Constantinos Venetsanopoulos | .. architecture and the internals of Synnefo components (currently out-of-date!). |
99 | 6928da52 | Dimitris Aragiorgis | |
100 | 77180645 | Dimitris Aragiorgis | |
101 | 77180645 | Dimitris Aragiorgis | .. toctree:: |
102 | 7a3439cf | Constantinos Venetsanopoulos | :maxdepth: 1 |
103 | 7a3439cf | Constantinos Venetsanopoulos | |
104 | 2ca07643 | Constantinos Venetsanopoulos | Quick Installation Guide (single node) <quick-install-guide> |
105 | ff6ba888 | Constantinos Venetsanopoulos | Installation Guide (on two nodes) <quick-install-admin-guide> |
106 | d0e436db | Constantinos Venetsanopoulos | |
107 | bc055d09 | Constantinos Venetsanopoulos | .. toctree:: |
108 | bc055d09 | Constantinos Venetsanopoulos | :maxdepth: 2 |
109 | bdb83fd6 | cven | |
110 | bc055d09 | Constantinos Venetsanopoulos | Administrator's Guide <admin-guide> |
111 | bc055d09 | Constantinos Venetsanopoulos | Developer's Guide <dev-guide> |
112 | d0e436db | Constantinos Venetsanopoulos | |
113 | d0e436db | Constantinos Venetsanopoulos | |
114 | 44c34efd | Constantinos Venetsanopoulos | List of all Synnefo components |
115 | 44c34efd | Constantinos Venetsanopoulos | ============================== |
116 | 44c34efd | Constantinos Venetsanopoulos | |
117 | 8c81d088 | Stratos Psomadakis | They are also available from our apt repository: ``apt.dev.grnet.gr`` |
118 | 44c34efd | Constantinos Venetsanopoulos | |
119 | 34e79416 | Constantinos Venetsanopoulos | * `snf-common <http://www.synnefo.org/docs/snf-common/latest/index.html>`_ |
120 | 34e79416 | Constantinos Venetsanopoulos | * `snf-webproject <http://www.synnefo.org/docs/snf-webproject/latest/index.html>`_ |
121 | 34e79416 | Constantinos Venetsanopoulos | * `snf-astakos-app <http://www.synnefo.org/docs/astakos/latest/index.html>`_ |
122 | 34e79416 | Constantinos Venetsanopoulos | * `snf-pithos-backend <http://www.synnefo.org/docs/pithos/latest/backends.html>`_ |
123 | 34e79416 | Constantinos Venetsanopoulos | * `snf-pithos-app <http://www.synnefo.org/docs/pithos/latest/index.html>`_ |
124 | 34e79416 | Constantinos Venetsanopoulos | * `snf-pithos-webclient <http://www.synnefo.org/docs/pithos-webclient/latest/index.html>`_ |
125 | 34e79416 | Constantinos Venetsanopoulos | * `snf-cyclades-app <http://www.synnefo.org/docs/snf-cyclades-app/latest/index.html>`_ |
126 | 34e79416 | Constantinos Venetsanopoulos | * `snf-cyclades-gtools <http://www.synnefo.org/docs/snf-cyclades-gtools/latest/index.html>`_ |
127 | 65fb5cf6 | Giorgos Korfiatis | * `astakosclient <http://www.synnefo.org/docs/astakosclient/latest/index.html>`_ |
128 | bb440e17 | Kostas Papadimitriou | * `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ |
129 | bb440e17 | Kostas Papadimitriou | * `snf-image <https://code.grnet.gr/projects/snf-image/wiki/>`_ |
130 | 34e79416 | Constantinos Venetsanopoulos | * `snf-image-creator <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>`_ |
131 | 34e79416 | Constantinos Venetsanopoulos | * `snf-occi <http://www.synnefo.org/docs/snf-occi/latest/index.html>`_ |
132 | 34e79416 | Constantinos Venetsanopoulos | * `snf-cloudcms <http://www.synnefo.org/docs/snf-cloudcms/latest/index.html>`_ |
133 | bb440e17 | Kostas Papadimitriou | * `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_ |
134 | 44c34efd | Constantinos Venetsanopoulos | |
135 | 44c34efd | Constantinos Venetsanopoulos | |
136 | d0e436db | Constantinos Venetsanopoulos | Contact |
137 | bc055d09 | Constantinos Venetsanopoulos | ======= |
138 | d0e436db | Constantinos Venetsanopoulos | |
139 | eab73849 | Constantinos Venetsanopoulos | You can contact the Synnefo team at the following mailing lists: |
140 | 9940eacf | Kostas Papadimitriou | |
141 | eab73849 | Constantinos Venetsanopoulos | * Users list: synnefo@googlegroups.com |
142 | eab73849 | Constantinos Venetsanopoulos | * Developers list: synnefo-devel@googlegroups.com |
143 | bc055d09 | Constantinos Venetsanopoulos | |
144 | 301294a9 | Constantinos Venetsanopoulos | The official site is: |
145 | 301294a9 | Constantinos Venetsanopoulos | |
146 | 301294a9 | Constantinos Venetsanopoulos | `http://www.synnefo.org <http://www.synnefo.org>`_ |
147 | 301294a9 | Constantinos Venetsanopoulos | |
148 | 9940eacf | Kostas Papadimitriou | Indices and tables |
149 | bc055d09 | Constantinos Venetsanopoulos | ================== |
150 | 9940eacf | Kostas Papadimitriou | |
151 | 9940eacf | Kostas Papadimitriou | |
152 | 9940eacf | Kostas Papadimitriou | * :ref:`genindex` |
153 | 9940eacf | Kostas Papadimitriou | * :ref:`modindex` |
154 | 9940eacf | Kostas Papadimitriou | * :ref:`search` |