root / docs / index.rst @ 0a3027c3
History | View | Annotate | Download (5.4 kB)
1 | f936cac5 | Constantinos Venetsanopoulos | Welcome to the Synnefo documentation |
---|---|---|---|
2 | f936cac5 | 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 | f936cac5 | Constantinos Venetsanopoulos | low-level VM operations and uses `Archipelago |
11 | f936cac5 | Constantinos Venetsanopoulos | <http://www.synnefo.org/docs/archipelago/latest/>`_ to unify cloud storage. To |
12 | f936cac5 | Constantinos Venetsanopoulos | boost 3rd-party compatibility, Synnefo exposes the OpenStack APIs to users. |
13 | 9940eacf | Kostas Papadimitriou | |
14 | f936cac5 | Constantinos Venetsanopoulos | Synnefo powers GRNET's `~okeanos public cloud service |
15 | f936cac5 | Constantinos Venetsanopoulos | <http://okeanos.grnet.gr>`_ and you can try it out live at `demo.synnefo.org |
16 | f936cac5 | Constantinos Venetsanopoulos | <http://demo.synnefo.org>`_. |
17 | 3a0ce98e | Constantinos Venetsanopoulos | |
18 | 3a0ce98e | Constantinos Venetsanopoulos | Synnefo has three main components providing the corresponding services: |
19 | 9940eacf | Kostas Papadimitriou | |
20 | d0e436db | Constantinos Venetsanopoulos | .. toctree:: |
21 | d0e436db | Constantinos Venetsanopoulos | :maxdepth: 1 |
22 | 9940eacf | Kostas Papadimitriou | |
23 | 3a0ce98e | Constantinos Venetsanopoulos | Astakos: Identity/Account services <astakos> |
24 | 3a0ce98e | Constantinos Venetsanopoulos | Pithos: File/Object Storage service <pithos> |
25 | 3a0ce98e | Constantinos Venetsanopoulos | Cyclades: Compute/Network/Image/Volume services <cyclades> |
26 | d6153e72 | Kostas Papadimitriou | |
27 | 3a0ce98e | Constantinos Venetsanopoulos | This is an overview of the Synnefo services: |
28 | 3a0ce98e | Constantinos Venetsanopoulos | |
29 | 3a0ce98e | Constantinos Venetsanopoulos | .. image:: images/synnefo-overview.png |
30 | 3a0ce98e | Constantinos Venetsanopoulos | :target: _images/synnefo-overview.png |
31 | d0e436db | Constantinos Venetsanopoulos | |
32 | f936cac5 | Constantinos Venetsanopoulos | Synnefo is designed with simplicity, scalability and stability in mind. |
33 | f936cac5 | Constantinos Venetsanopoulos | Furthermore, although it can be deployed in small configurations, it was |
34 | f936cac5 | Constantinos Venetsanopoulos | initially designed to address large installation problems. |
35 | d0e436db | Constantinos Venetsanopoulos | |
36 | f936cac5 | Constantinos Venetsanopoulos | All Synnefo components use an intuitive settings mechanism, that adds and |
37 | f936cac5 | Constantinos Venetsanopoulos | removes settings dynamically as components are getting added or removed from a |
38 | f936cac5 | Constantinos Venetsanopoulos | physical node. All settings are stored in a single location. |
39 | d0e436db | Constantinos Venetsanopoulos | |
40 | 14267d89 | Constantinos Venetsanopoulos | |
41 | 301294a9 | Constantinos Venetsanopoulos | .. _general-arch: |
42 | d0e436db | Constantinos Venetsanopoulos | |
43 | eab73849 | Constantinos Venetsanopoulos | Synnefo General Architecture |
44 | eab73849 | Constantinos Venetsanopoulos | ============================ |
45 | eab73849 | Constantinos Venetsanopoulos | |
46 | f936cac5 | Constantinos Venetsanopoulos | The following figure shows the whole Synnefo stack and how it interacts with |
47 | 14267d89 | Constantinos Venetsanopoulos | multiple Ganeti clusters and the storage backends. Synnefo decouples the cloud |
48 | f936cac5 | Constantinos Venetsanopoulos | from the cluster layer enhancing robustness, scalability, and ease of |
49 | f936cac5 | Constantinos Venetsanopoulos | administration and upgrades without impacting VM stability. As shown in the |
50 | f936cac5 | Constantinos Venetsanopoulos | figure below, Synnefo sits on the cloud layer: |
51 | eab73849 | Constantinos Venetsanopoulos | |
52 | 14267d89 | Constantinos Venetsanopoulos | .. image:: images/snf-architecture.png |
53 | 14267d89 | Constantinos Venetsanopoulos | :target: _images/snf-architecture.png |
54 | 14267d89 | Constantinos Venetsanopoulos | |
55 | f936cac5 | Constantinos Venetsanopoulos | Synnefo manages multiple Ganeti clusters and different storage backends |
56 | f936cac5 | Constantinos Venetsanopoulos | (e.g., Ceph/RADOS or NFS-based backends as shown in the figure). |
57 | 14267d89 | Constantinos Venetsanopoulos | |
58 | f936cac5 | Constantinos Venetsanopoulos | For an extensive view of all components, the interconnection and APIs between |
59 | f936cac5 | Constantinos Venetsanopoulos | them, please take a look at the Admin Guide's :ref:`corresponding figure |
60 | f936cac5 | Constantinos Venetsanopoulos | <syn+archip>`. |
61 | eab73849 | Constantinos Venetsanopoulos | |
62 | eab73849 | Constantinos Venetsanopoulos | |
63 | bc055d09 | Constantinos Venetsanopoulos | Synnefo Guides |
64 | bc055d09 | Constantinos Venetsanopoulos | ============== |
65 | d0e436db | Constantinos Venetsanopoulos | |
66 | 2ca07643 | Constantinos Venetsanopoulos | There are 4 guides for Synnefo. |
67 | 2ca07643 | Constantinos Venetsanopoulos | |
68 | 2ca07643 | Constantinos Venetsanopoulos | The Quick Installation guide describes how to install Synnefo on a single node |
69 | 2ca07643 | Constantinos Venetsanopoulos | in less than 10 minutes using the `snf-deploy` tool. This kind of installation |
70 | 2ca07643 | Constantinos Venetsanopoulos | is targeted for testing and demo environments rather than production usage |
71 | 2ca07643 | Constantinos Venetsanopoulos | deployments. It is the perfect way, even for an inexperienced user to have the |
72 | 2ca07643 | Constantinos Venetsanopoulos | whole Synnefo stack up and running and allows for a quick preview of the basic |
73 | 2ca07643 | Constantinos Venetsanopoulos | Synnefo features. |
74 | 2ca07643 | Constantinos Venetsanopoulos | |
75 | f936cac5 | Constantinos Venetsanopoulos | The Admin's Installation guide describes how to install the whole Synnefo stack |
76 | 2ca07643 | Constantinos Venetsanopoulos | in just two physical nodes. This guide is useful to those interested in |
77 | 2ca07643 | Constantinos Venetsanopoulos | deploying Synnefo in large scale, as a starting point that will help them get |
78 | 2ca07643 | Constantinos Venetsanopoulos | familiar with the Synnefo components and overall architecture, as well as the |
79 | 2ca07643 | Constantinos Venetsanopoulos | interconnection between different services. This guide explains the whole |
80 | 2ca07643 | Constantinos Venetsanopoulos | procedure step by step, without the use of the `snf-deploy` tool. Anyone |
81 | 2ca07643 | Constantinos Venetsanopoulos | familiar with this guide, will be able to easily install Synnefo in a larger |
82 | 2ca07643 | Constantinos Venetsanopoulos | number of nodes too, or even expand the two node installation dynamically. |
83 | 7a3439cf | Constantinos Venetsanopoulos | |
84 | 7a3439cf | Constantinos Venetsanopoulos | The Administrator's Guide targets system administrators, who want to dive into |
85 | 301294a9 | Constantinos Venetsanopoulos | more details and common tasks regarding Synnefo. For the experienced Synnefo |
86 | 8b5be818 | Constantinos Venetsanopoulos | administrator, there is also a section that describes how to do scale-out |
87 | 8b5be818 | Constantinos Venetsanopoulos | Synnefo deployments with corresponding examples. This targets large scale |
88 | 8b5be818 | Constantinos Venetsanopoulos | installations of Synnefo. |
89 | 7a3439cf | Constantinos Venetsanopoulos | |
90 | 301294a9 | Constantinos Venetsanopoulos | The Developer's Guide targets developers, who want to build on top of Synnefo |
91 | 301294a9 | Constantinos Venetsanopoulos | and so describes all the different types of interfaces Synnefo provides to the |
92 | 8b5be818 | Constantinos Venetsanopoulos | external world. Also documents all Synnefo external REST APIs. |
93 | 8b5be818 | Constantinos Venetsanopoulos | |
94 | 8b5be818 | Constantinos Venetsanopoulos | .. The Integrator's Guide targets developers, who want to actually |
95 | 8b5be818 | Constantinos Venetsanopoulos | .. extend/modify/change Synnefo itself, so describes Synnefo's indepth |
96 | 8b5be818 | Constantinos Venetsanopoulos | .. architecture and the internals of Synnefo components (currently out-of-date!). |
97 | 6928da52 | Dimitris Aragiorgis | |
98 | 77180645 | Dimitris Aragiorgis | |
99 | 77180645 | Dimitris Aragiorgis | .. toctree:: |
100 | 7a3439cf | Constantinos Venetsanopoulos | :maxdepth: 1 |
101 | 7a3439cf | Constantinos Venetsanopoulos | |
102 | 2ca07643 | Constantinos Venetsanopoulos | Quick Installation Guide (single node) <quick-install-guide> |
103 | ff6ba888 | Constantinos Venetsanopoulos | Installation Guide (on two nodes) <quick-install-admin-guide> |
104 | d0e436db | Constantinos Venetsanopoulos | |
105 | bc055d09 | Constantinos Venetsanopoulos | .. toctree:: |
106 | f936cac5 | Constantinos Venetsanopoulos | :maxdepth: 1 |
107 | bdb83fd6 | cven | |
108 | bc055d09 | Constantinos Venetsanopoulos | Administrator's Guide <admin-guide> |
109 | bc055d09 | Constantinos Venetsanopoulos | Developer's Guide <dev-guide> |
110 | d0e436db | Constantinos Venetsanopoulos | |
111 | d0e436db | Constantinos Venetsanopoulos | |
112 | f936cac5 | Constantinos Venetsanopoulos | Synnefo tools |
113 | f936cac5 | Constantinos Venetsanopoulos | ============= |
114 | 44c34efd | Constantinos Venetsanopoulos | |
115 | f936cac5 | Constantinos Venetsanopoulos | There are also the following tools: |
116 | f936cac5 | Constantinos Venetsanopoulos | |
117 | f936cac5 | Constantinos Venetsanopoulos | .. toctree:: |
118 | f936cac5 | Constantinos Venetsanopoulos | :maxdepth: 1 |
119 | 44c34efd | Constantinos Venetsanopoulos | |
120 | f936cac5 | Constantinos Venetsanopoulos | kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html> |
121 | f936cac5 | Constantinos Venetsanopoulos | snf-deploy: Synnefo deployment tool <snf-deploy> |
122 | f936cac5 | Constantinos Venetsanopoulos | snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html> |
123 | f936cac5 | Constantinos Venetsanopoulos | snf-image: Secure image deployment tool <http://www.synnefo.org/docs/snf-image/latest/index.html> |
124 | f936cac5 | Constantinos Venetsanopoulos | snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin> |
125 | 44c34efd | Constantinos Venetsanopoulos | |
126 | 44c34efd | Constantinos Venetsanopoulos | |
127 | 98ae2c12 | Constantinos Venetsanopoulos | Design |
128 | 98ae2c12 | Constantinos Venetsanopoulos | ====== |
129 | 98ae2c12 | Constantinos Venetsanopoulos | |
130 | 98ae2c12 | Constantinos Venetsanopoulos | Drafts |
131 | 98ae2c12 | Constantinos Venetsanopoulos | ------ |
132 | 98ae2c12 | Constantinos Venetsanopoulos | |
133 | 98ae2c12 | Constantinos Venetsanopoulos | .. toctree:: |
134 | 98ae2c12 | Constantinos Venetsanopoulos | :maxdepth: 1 |
135 | 98ae2c12 | Constantinos Venetsanopoulos | |
136 | f68199bd | Giorgos Korfiatis | Resource-pool projects design <design/resource-pool-projects> |
137 | 111adca0 | Giorgos Korfiatis | Resource defaults design <design/resource-defaults> |
138 | 98ae2c12 | Constantinos Venetsanopoulos | |
139 | 98ae2c12 | Constantinos Venetsanopoulos | |
140 | d0e436db | Constantinos Venetsanopoulos | Contact |
141 | bc055d09 | Constantinos Venetsanopoulos | ======= |
142 | d0e436db | Constantinos Venetsanopoulos | |
143 | eab73849 | Constantinos Venetsanopoulos | You can contact the Synnefo team at the following mailing lists: |
144 | 9940eacf | Kostas Papadimitriou | |
145 | eab73849 | Constantinos Venetsanopoulos | * Users list: synnefo@googlegroups.com |
146 | eab73849 | Constantinos Venetsanopoulos | * Developers list: synnefo-devel@googlegroups.com |
147 | bc055d09 | Constantinos Venetsanopoulos | |
148 | 301294a9 | Constantinos Venetsanopoulos | The official site is: |
149 | 301294a9 | Constantinos Venetsanopoulos | |
150 | 301294a9 | Constantinos Venetsanopoulos | `http://www.synnefo.org <http://www.synnefo.org>`_ |