root / docs / index.rst @ 6d8a47d0
History | View | Annotate | Download (6.5 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 | 3a0ce98e | Constantinos Venetsanopoulos | Synnefo is a complete open source cloud stack written in Python that provides |
7 | 3a0ce98e | Constantinos Venetsanopoulos | Compute, Network, Image, Volume and Storage services, similar to the ones |
8 | 3a0ce98e | Constantinos Venetsanopoulos | offered by AWS. Synnefo manages multiple `Ganeti |
9 | 3a0ce98e | Constantinos Venetsanopoulos | <http://code.google.com/p/ganeti>`_ clusters at the backend for handling of |
10 | 3a0ce98e | Constantinos Venetsanopoulos | low-level VM operations. To boost 3rd-party compatibility, Synnefo exposes the |
11 | 3a0ce98e | Constantinos Venetsanopoulos | OpenStack APIs to users. |
12 | 9940eacf | Kostas Papadimitriou | |
13 | 3a0ce98e | Constantinos Venetsanopoulos | You can see Synnefo in action, powering GRNET's |
14 | 3a0ce98e | Constantinos Venetsanopoulos | `~okeanos public cloud service <http://okeanos.grnet.gr>`_. |
15 | 3a0ce98e | Constantinos Venetsanopoulos | |
16 | 3a0ce98e | Constantinos Venetsanopoulos | Synnefo has three main components providing the corresponding services: |
17 | 9940eacf | Kostas Papadimitriou | |
18 | d0e436db | Constantinos Venetsanopoulos | .. toctree:: |
19 | d0e436db | Constantinos Venetsanopoulos | :maxdepth: 1 |
20 | 9940eacf | Kostas Papadimitriou | |
21 | 3a0ce98e | Constantinos Venetsanopoulos | Astakos: Identity/Account services <astakos> |
22 | 3a0ce98e | Constantinos Venetsanopoulos | Pithos: File/Object Storage service <pithos> |
23 | 3a0ce98e | Constantinos Venetsanopoulos | Cyclades: Compute/Network/Image/Volume services <cyclades> |
24 | d6153e72 | Kostas Papadimitriou | |
25 | 301294a9 | Constantinos Venetsanopoulos | There are also the following tools: |
26 | 9940eacf | Kostas Papadimitriou | |
27 | 9940eacf | Kostas Papadimitriou | .. toctree:: |
28 | 9940eacf | Kostas Papadimitriou | :maxdepth: 1 |
29 | 9940eacf | Kostas Papadimitriou | |
30 | 34e79416 | Constantinos Venetsanopoulos | kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html> |
31 | 20c0dfdc | Dimitris Aragiorgis | snf-deploy: Synnefo deployment tool <snf-deploy> |
32 | 34e79416 | Constantinos Venetsanopoulos | snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html> |
33 | 59ab0466 | Nikos Skalkotos | snf-image: Secure image deployment tool <http://www.synnefo.org/docs/snf-image/latest/index.html> |
34 | 4f7d5233 | Ilias Tsitsimpis | snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin> |
35 | 77180645 | Dimitris Aragiorgis | |
36 | 3a0ce98e | Constantinos Venetsanopoulos | This is an overview of the Synnefo services: |
37 | 3a0ce98e | Constantinos Venetsanopoulos | |
38 | 3a0ce98e | Constantinos Venetsanopoulos | .. image:: images/synnefo-overview.png |
39 | 3a0ce98e | Constantinos Venetsanopoulos | :target: _images/synnefo-overview.png |
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 | 14267d89 | Constantinos Venetsanopoulos | |
50 | 301294a9 | Constantinos Venetsanopoulos | .. _general-arch: |
51 | d0e436db | Constantinos Venetsanopoulos | |
52 | eab73849 | Constantinos Venetsanopoulos | Synnefo General Architecture |
53 | eab73849 | Constantinos Venetsanopoulos | ============================ |
54 | eab73849 | Constantinos Venetsanopoulos | |
55 | 14267d89 | Constantinos Venetsanopoulos | The following graph shows the whole Synnefo stack and how it interacts with |
56 | 14267d89 | Constantinos Venetsanopoulos | multiple Ganeti clusters and the storage backends. Synnefo decouples the cloud |
57 | 14267d89 | Constantinos Venetsanopoulos | from the cluster layer enhancing robustness, stability and ease of |
58 | 14267d89 | Constantinos Venetsanopoulos | administration. As shown in the figure below, Synnefo sits on the cloud layer: |
59 | eab73849 | Constantinos Venetsanopoulos | |
60 | 14267d89 | Constantinos Venetsanopoulos | .. image:: images/snf-architecture.png |
61 | 16539dad | Kostas Papadimitriou | :width: 100% |
62 | 14267d89 | Constantinos Venetsanopoulos | :target: _images/snf-architecture.png |
63 | 14267d89 | Constantinos Venetsanopoulos | |
64 | 14267d89 | Constantinos Venetsanopoulos | Synnefo manages multiple Ganeti clusters and different kind of storage backends |
65 | 14267d89 | Constantinos Venetsanopoulos | such as a Ceph/RADOS cluster or an NFS-based backend. |
66 | 14267d89 | Constantinos Venetsanopoulos | |
67 | 14267d89 | Constantinos Venetsanopoulos | For an extensive view of all components and APIs between them, please take a |
68 | 14267d89 | Constantinos Venetsanopoulos | look at the Admin Guide's :ref:`corresponding figure <syn+archip>`. |
69 | eab73849 | Constantinos Venetsanopoulos | |
70 | eab73849 | Constantinos Venetsanopoulos | |
71 | bc055d09 | Constantinos Venetsanopoulos | Synnefo Guides |
72 | bc055d09 | Constantinos Venetsanopoulos | ============== |
73 | d0e436db | Constantinos Venetsanopoulos | |
74 | 2ca07643 | Constantinos Venetsanopoulos | There are 4 guides for Synnefo. |
75 | 2ca07643 | Constantinos Venetsanopoulos | |
76 | 2ca07643 | Constantinos Venetsanopoulos | The Quick Installation guide describes how to install Synnefo on a single node |
77 | 2ca07643 | Constantinos Venetsanopoulos | in less than 10 minutes using the `snf-deploy` tool. This kind of installation |
78 | 2ca07643 | Constantinos Venetsanopoulos | is targeted for testing and demo environments rather than production usage |
79 | 2ca07643 | Constantinos Venetsanopoulos | deployments. It is the perfect way, even for an inexperienced user to have the |
80 | 2ca07643 | Constantinos Venetsanopoulos | whole Synnefo stack up and running and allows for a quick preview of the basic |
81 | 2ca07643 | Constantinos Venetsanopoulos | Synnefo features. |
82 | 2ca07643 | Constantinos Venetsanopoulos | |
83 | 2ca07643 | Constantinos Venetsanopoulos | The Admin's installation guide describes how to install the whole Synnefo stack |
84 | 2ca07643 | Constantinos Venetsanopoulos | in just two physical nodes. This guide is useful to those interested in |
85 | 2ca07643 | Constantinos Venetsanopoulos | deploying Synnefo in large scale, as a starting point that will help them get |
86 | 2ca07643 | Constantinos Venetsanopoulos | familiar with the Synnefo components and overall architecture, as well as the |
87 | 2ca07643 | Constantinos Venetsanopoulos | interconnection between different services. This guide explains the whole |
88 | 2ca07643 | Constantinos Venetsanopoulos | procedure step by step, without the use of the `snf-deploy` tool. Anyone |
89 | 2ca07643 | Constantinos Venetsanopoulos | familiar with this guide, will be able to easily install Synnefo in a larger |
90 | 2ca07643 | Constantinos Venetsanopoulos | number of nodes too, or even expand the two node installation dynamically. |
91 | 7a3439cf | Constantinos Venetsanopoulos | |
92 | 7a3439cf | Constantinos Venetsanopoulos | The Administrator's Guide targets system administrators, who want to dive into |
93 | 301294a9 | Constantinos Venetsanopoulos | more details and common tasks regarding Synnefo. For the experienced Synnefo |
94 | 8b5be818 | Constantinos Venetsanopoulos | administrator, there is also a section that describes how to do scale-out |
95 | 8b5be818 | Constantinos Venetsanopoulos | Synnefo deployments with corresponding examples. This targets large scale |
96 | 8b5be818 | Constantinos Venetsanopoulos | installations of Synnefo. |
97 | 7a3439cf | Constantinos Venetsanopoulos | |
98 | 301294a9 | Constantinos Venetsanopoulos | The Developer's Guide targets developers, who want to build on top of Synnefo |
99 | 301294a9 | Constantinos Venetsanopoulos | and so describes all the different types of interfaces Synnefo provides to the |
100 | 8b5be818 | Constantinos Venetsanopoulos | external world. Also documents all Synnefo external REST APIs. |
101 | 8b5be818 | Constantinos Venetsanopoulos | |
102 | 8b5be818 | Constantinos Venetsanopoulos | .. The Integrator's Guide targets developers, who want to actually |
103 | 8b5be818 | Constantinos Venetsanopoulos | .. extend/modify/change Synnefo itself, so describes Synnefo's indepth |
104 | 8b5be818 | Constantinos Venetsanopoulos | .. architecture and the internals of Synnefo components (currently out-of-date!). |
105 | 6928da52 | Dimitris Aragiorgis | |
106 | 77180645 | Dimitris Aragiorgis | |
107 | 77180645 | Dimitris Aragiorgis | .. toctree:: |
108 | 7a3439cf | Constantinos Venetsanopoulos | :maxdepth: 1 |
109 | 7a3439cf | Constantinos Venetsanopoulos | |
110 | 2ca07643 | Constantinos Venetsanopoulos | Quick Installation Guide (single node) <quick-install-guide> |
111 | ff6ba888 | Constantinos Venetsanopoulos | Installation Guide (on two nodes) <quick-install-admin-guide> |
112 | d0e436db | Constantinos Venetsanopoulos | |
113 | bc055d09 | Constantinos Venetsanopoulos | .. toctree:: |
114 | bc055d09 | Constantinos Venetsanopoulos | :maxdepth: 2 |
115 | bdb83fd6 | cven | |
116 | bc055d09 | Constantinos Venetsanopoulos | Administrator's Guide <admin-guide> |
117 | bc055d09 | Constantinos Venetsanopoulos | Developer's Guide <dev-guide> |
118 | d0e436db | Constantinos Venetsanopoulos | |
119 | d0e436db | Constantinos Venetsanopoulos | |
120 | 44c34efd | Constantinos Venetsanopoulos | List of all Synnefo components |
121 | 44c34efd | Constantinos Venetsanopoulos | ============================== |
122 | 44c34efd | Constantinos Venetsanopoulos | |
123 | 8c81d088 | Stratos Psomadakis | They are also available from our apt repository: ``apt.dev.grnet.gr`` |
124 | 44c34efd | Constantinos Venetsanopoulos | |
125 | 34e79416 | Constantinos Venetsanopoulos | * `snf-common <http://www.synnefo.org/docs/snf-common/latest/index.html>`_ |
126 | 34e79416 | Constantinos Venetsanopoulos | * `snf-webproject <http://www.synnefo.org/docs/snf-webproject/latest/index.html>`_ |
127 | 34e79416 | Constantinos Venetsanopoulos | * `snf-astakos-app <http://www.synnefo.org/docs/astakos/latest/index.html>`_ |
128 | 34e79416 | Constantinos Venetsanopoulos | * `snf-pithos-backend <http://www.synnefo.org/docs/pithos/latest/backends.html>`_ |
129 | 34e79416 | Constantinos Venetsanopoulos | * `snf-pithos-app <http://www.synnefo.org/docs/pithos/latest/index.html>`_ |
130 | 34e79416 | Constantinos Venetsanopoulos | * `snf-pithos-webclient <http://www.synnefo.org/docs/pithos-webclient/latest/index.html>`_ |
131 | 34e79416 | Constantinos Venetsanopoulos | * `snf-cyclades-app <http://www.synnefo.org/docs/snf-cyclades-app/latest/index.html>`_ |
132 | 34e79416 | Constantinos Venetsanopoulos | * `snf-cyclades-gtools <http://www.synnefo.org/docs/snf-cyclades-gtools/latest/index.html>`_ |
133 | 65fb5cf6 | Giorgos Korfiatis | * `astakosclient <http://www.synnefo.org/docs/astakosclient/latest/index.html>`_ |
134 | bb440e17 | Kostas Papadimitriou | * `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_ |
135 | 5beef175 | Nikos Skalkotos | * `snf-image <http://www.synnefo.org/docs/snf-image/latest/index.html/>`_ |
136 | 34e79416 | Constantinos Venetsanopoulos | * `snf-image-creator <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>`_ |
137 | 34e79416 | Constantinos Venetsanopoulos | * `snf-occi <http://www.synnefo.org/docs/snf-occi/latest/index.html>`_ |
138 | 34e79416 | Constantinos Venetsanopoulos | * `snf-cloudcms <http://www.synnefo.org/docs/snf-cloudcms/latest/index.html>`_ |
139 | bb440e17 | Kostas Papadimitriou | * `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_ |
140 | 44c34efd | Constantinos Venetsanopoulos | |
141 | 44c34efd | Constantinos Venetsanopoulos | |
142 | 98ae2c12 | Constantinos Venetsanopoulos | Design |
143 | 98ae2c12 | Constantinos Venetsanopoulos | ====== |
144 | 98ae2c12 | Constantinos Venetsanopoulos | |
145 | 98ae2c12 | Constantinos Venetsanopoulos | Drafts |
146 | 98ae2c12 | Constantinos Venetsanopoulos | ------ |
147 | 98ae2c12 | Constantinos Venetsanopoulos | |
148 | 98ae2c12 | Constantinos Venetsanopoulos | .. toctree:: |
149 | 98ae2c12 | Constantinos Venetsanopoulos | :maxdepth: 1 |
150 | 98ae2c12 | Constantinos Venetsanopoulos | |
151 | f68199bd | Giorgos Korfiatis | Resource-pool projects design <design/resource-pool-projects> |
152 | 111adca0 | Giorgos Korfiatis | Resource defaults design <design/resource-defaults> |
153 | 98ae2c12 | Constantinos Venetsanopoulos | |
154 | 98ae2c12 | Constantinos Venetsanopoulos | |
155 | d0e436db | Constantinos Venetsanopoulos | Contact |
156 | bc055d09 | Constantinos Venetsanopoulos | ======= |
157 | d0e436db | Constantinos Venetsanopoulos | |
158 | eab73849 | Constantinos Venetsanopoulos | You can contact the Synnefo team at the following mailing lists: |
159 | 9940eacf | Kostas Papadimitriou | |
160 | eab73849 | Constantinos Venetsanopoulos | * Users list: synnefo@googlegroups.com |
161 | eab73849 | Constantinos Venetsanopoulos | * Developers list: synnefo-devel@googlegroups.com |
162 | bc055d09 | Constantinos Venetsanopoulos | |
163 | 301294a9 | Constantinos Venetsanopoulos | The official site is: |
164 | 301294a9 | Constantinos Venetsanopoulos | |
165 | 301294a9 | Constantinos Venetsanopoulos | `http://www.synnefo.org <http://www.synnefo.org>`_ |
166 | 301294a9 | Constantinos Venetsanopoulos | |
167 | 9940eacf | Kostas Papadimitriou | Indices and tables |
168 | bc055d09 | Constantinos Venetsanopoulos | ================== |
169 | 9940eacf | Kostas Papadimitriou | |
170 | 9940eacf | Kostas Papadimitriou | |
171 | 9940eacf | Kostas Papadimitriou | * :ref:`genindex` |
172 | 9940eacf | Kostas Papadimitriou | * :ref:`modindex` |
173 | 9940eacf | Kostas Papadimitriou | * :ref:`search` |