root / docs / quick-install-admin-guide.rst @ a5fbc00d
History | View | Annotate | Download (76.2 kB)
1 | bdb83fd6 | cven | .. _quick-install-admin-guide: |
---|---|---|---|
2 | bdb83fd6 | cven | |
3 | bdb83fd6 | cven | Administrator's Quick Installation Guide |
4 | a96ec00f | Constantinos Venetsanopoulos | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
5 | a96ec00f | Constantinos Venetsanopoulos | |
6 | a96ec00f | Constantinos Venetsanopoulos | This is the Administrator's quick installation guide. |
7 | a96ec00f | Constantinos Venetsanopoulos | |
8 | a96ec00f | Constantinos Venetsanopoulos | It describes how to install the whole synnefo stack on two (2) physical nodes, |
9 | a96ec00f | Constantinos Venetsanopoulos | with minimum configuration. It installs synnefo from Debian packages, and |
10 | a96ec00f | Constantinos Venetsanopoulos | assumes the nodes run Debian Squeeze. After successful installation, you will |
11 | a96ec00f | Constantinos Venetsanopoulos | have the following services running: |
12 | a96ec00f | Constantinos Venetsanopoulos | |
13 | d587329c | Konstantinos Tompoulidis | * Identity Management (Astakos) |
14 | d587329c | Konstantinos Tompoulidis | * Object Storage Service (Pithos+) |
15 | d587329c | Konstantinos Tompoulidis | * Compute Service (Cyclades) |
16 | d587329c | Konstantinos Tompoulidis | * Image Registry Service (Plankton) |
17 | a96ec00f | Constantinos Venetsanopoulos | |
18 | a96ec00f | Constantinos Venetsanopoulos | and a single unified Web UI to manage them all. |
19 | a96ec00f | Constantinos Venetsanopoulos | |
20 | a96ec00f | Constantinos Venetsanopoulos | The Volume Storage Service (Archipelago) and the Billing Service (Aquarium) are |
21 | a96ec00f | Constantinos Venetsanopoulos | not released yet. |
22 | a96ec00f | Constantinos Venetsanopoulos | |
23 | d587329c | Konstantinos Tompoulidis | If you just want to install the Object Storage Service (Pithos+), follow the |
24 | d587329c | Konstantinos Tompoulidis | guide and just stop after the "Testing of Pithos+" section. |
25 | a96ec00f | Constantinos Venetsanopoulos | |
26 | a96ec00f | Constantinos Venetsanopoulos | |
27 | a96ec00f | Constantinos Venetsanopoulos | Installation of Synnefo / Introduction |
28 | a96ec00f | Constantinos Venetsanopoulos | ====================================== |
29 | a96ec00f | Constantinos Venetsanopoulos | |
30 | a96ec00f | Constantinos Venetsanopoulos | We will install the services with the above list's order. Cyclades and Plankton |
31 | a96ec00f | Constantinos Venetsanopoulos | will be installed in a single step (at the end), because at the moment they are |
32 | a96ec00f | Constantinos Venetsanopoulos | contained in the same software component. Furthermore, we will install all |
33 | a96ec00f | Constantinos Venetsanopoulos | services in the first physical node, except Pithos+ which will be installed in |
34 | a96ec00f | Constantinos Venetsanopoulos | the second, due to a conflict between the snf-pithos-app and snf-cyclades-app |
35 | a96ec00f | Constantinos Venetsanopoulos | component (scheduled to be fixed in the next version). |
36 | a96ec00f | Constantinos Venetsanopoulos | |
37 | a96ec00f | Constantinos Venetsanopoulos | For the rest of the documentation we will refer to the first physical node as |
38 | a96ec00f | Constantinos Venetsanopoulos | "node1" and the second as "node2". We will also assume that their domain names |
39 | a96ec00f | Constantinos Venetsanopoulos | are "node1.example.com" and "node2.example.com" and their IPs are "4.3.2.1" and |
40 | a96ec00f | Constantinos Venetsanopoulos | "4.3.2.2" respectively. |
41 | a96ec00f | Constantinos Venetsanopoulos | |
42 | 04308336 | Ilias Tsitsimpis | .. note:: It is import that the two machines are under the same domain name. |
43 | 04308336 | Ilias Tsitsimpis | If they are not, you can do this by editting the file ``/etc/hosts`` |
44 | 04308336 | Ilias Tsitsimpis | on both machines, and add the following lines: |
45 | 04308336 | Ilias Tsitsimpis | |
46 | 04308336 | Ilias Tsitsimpis | .. code-block:: console |
47 | 04308336 | Ilias Tsitsimpis | |
48 | 04308336 | Ilias Tsitsimpis | 4.3.2.1 node1.example.com |
49 | 04308336 | Ilias Tsitsimpis | 4.3.2.2 node2.example.com |
50 | 04308336 | Ilias Tsitsimpis | |
51 | a96ec00f | Constantinos Venetsanopoulos | |
52 | a96ec00f | Constantinos Venetsanopoulos | General Prerequisites |
53 | a96ec00f | Constantinos Venetsanopoulos | ===================== |
54 | a96ec00f | Constantinos Venetsanopoulos | |
55 | a96ec00f | Constantinos Venetsanopoulos | These are the general synnefo prerequisites, that you need on node1 and node2 |
56 | a96ec00f | Constantinos Venetsanopoulos | and are related to all the services (Astakos, Pithos+, Cyclades, Plankton). |
57 | a96ec00f | Constantinos Venetsanopoulos | |
58 | a96ec00f | Constantinos Venetsanopoulos | To be able to download all synnefo components you need to add the following |
59 | a96ec00f | Constantinos Venetsanopoulos | lines in your ``/etc/apt/sources.list`` file: |
60 | a96ec00f | Constantinos Venetsanopoulos | |
61 | d33aa38d | Stratos Psomadakis | | ``deb http://apt2.dev.grnet.gr stable/`` |
62 | d33aa38d | Stratos Psomadakis | | ``deb-src http://apt2.dev.grnet.gr stable/`` |
63 | a96ec00f | Constantinos Venetsanopoulos | |
64 | ec9862dd | Stratos Psomadakis | and import the repo's GPG key: |
65 | ec9862dd | Stratos Psomadakis | |
66 | ec9862dd | Stratos Psomadakis | | ``curl https://dev.grnet.gr/files/apt-grnetdev.pub | apt-key add -`` |
67 | ec9862dd | Stratos Psomadakis | |
68 | 169f7d38 | Vangelis Koukis | Also add the following line to enable the ``squeeze-backports`` repository, |
69 | 169f7d38 | Vangelis Koukis | which may provide more recent versions of certain packages. The repository |
70 | 169f7d38 | Vangelis Koukis | is deactivated by default and must be specified expicitly in ``apt-get`` |
71 | 169f7d38 | Vangelis Koukis | operations: |
72 | 169f7d38 | Vangelis Koukis | |
73 | 169f7d38 | Vangelis Koukis | | ``deb http://backports.debian.org/debian-backports squeeze-backports main`` |
74 | 169f7d38 | Vangelis Koukis | |
75 | a96ec00f | Constantinos Venetsanopoulos | You also need a shared directory visible by both nodes. Pithos+ will save all |
76 | a96ec00f | Constantinos Venetsanopoulos | data inside this directory. By 'all data', we mean files, images, and pithos |
77 | a96ec00f | Constantinos Venetsanopoulos | specific mapping data. If you plan to upload more than one basic image, this |
78 | a96ec00f | Constantinos Venetsanopoulos | directory should have at least 50GB of free space. During this guide, we will |
79 | a96ec00f | Constantinos Venetsanopoulos | assume that node1 acts as an NFS server and serves the directory ``/srv/pithos`` |
80 | ba173277 | Ilias Tsitsimpis | to node2 (be sure to set no_root_squash flag). Node2 has this directory |
81 | ba173277 | Ilias Tsitsimpis | mounted under ``/srv/pithos``, too. |
82 | a96ec00f | Constantinos Venetsanopoulos | |
83 | a96ec00f | Constantinos Venetsanopoulos | Before starting the synnefo installation, you will need basic third party |
84 | a96ec00f | Constantinos Venetsanopoulos | software to be installed and configured on the physical nodes. We will describe |
85 | a96ec00f | Constantinos Venetsanopoulos | each node's general prerequisites separately. Any additional configuration, |
86 | a96ec00f | Constantinos Venetsanopoulos | specific to a synnefo service for each node, will be described at the service's |
87 | a96ec00f | Constantinos Venetsanopoulos | section. |
88 | a96ec00f | Constantinos Venetsanopoulos | |
89 | 7df5a742 | Christos Stavrakakis | Finally, it is required for Cyclades and Ganeti nodes to have synchronized |
90 | 7df5a742 | Christos Stavrakakis | system clocks (e.g. by running ntpd). |
91 | 7df5a742 | Christos Stavrakakis | |
92 | a96ec00f | Constantinos Venetsanopoulos | Node1 |
93 | a96ec00f | Constantinos Venetsanopoulos | ----- |
94 | a96ec00f | Constantinos Venetsanopoulos | |
95 | a96ec00f | Constantinos Venetsanopoulos | General Synnefo dependencies |
96 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
97 | a96ec00f | Constantinos Venetsanopoulos | |
98 | d587329c | Konstantinos Tompoulidis | * apache (http server) |
99 | d587329c | Konstantinos Tompoulidis | * gunicorn (WSGI http server) |
100 | d587329c | Konstantinos Tompoulidis | * postgresql (database) |
101 | d587329c | Konstantinos Tompoulidis | * rabbitmq (message queue) |
102 | d587329c | Konstantinos Tompoulidis | * ntp (NTP daemon) |
103 | d587329c | Konstantinos Tompoulidis | * gevent |
104 | a96ec00f | Constantinos Venetsanopoulos | |
105 | 7df5a742 | Christos Stavrakakis | You can install apache2, progresql and ntp by running: |
106 | a96ec00f | Constantinos Venetsanopoulos | |
107 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
108 | a96ec00f | Constantinos Venetsanopoulos | |
109 | 7df5a742 | Christos Stavrakakis | # apt-get install apache2 postgresql ntp |
110 | a96ec00f | Constantinos Venetsanopoulos | |
111 | 73ff1d54 | Constantinos Venetsanopoulos | Make sure to install gunicorn >= v0.12.2. You can do this by installing from |
112 | 73ff1d54 | Constantinos Venetsanopoulos | the official debian backports: |
113 | 73ff1d54 | Constantinos Venetsanopoulos | |
114 | 73ff1d54 | Constantinos Venetsanopoulos | .. code-block:: console |
115 | 73ff1d54 | Constantinos Venetsanopoulos | |
116 | 73ff1d54 | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install gunicorn |
117 | 73ff1d54 | Constantinos Venetsanopoulos | |
118 | 576e059b | Constantinos Venetsanopoulos | Also, make sure to install gevent >= 0.13.6. Again from the debian backports: |
119 | 576e059b | Constantinos Venetsanopoulos | |
120 | 576e059b | Constantinos Venetsanopoulos | .. code-block:: console |
121 | 576e059b | Constantinos Venetsanopoulos | |
122 | 576e059b | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install python-gevent |
123 | 576e059b | Constantinos Venetsanopoulos | |
124 | 73ff1d54 | Constantinos Venetsanopoulos | On node1, we will create our databases, so you will also need the |
125 | 73ff1d54 | Constantinos Venetsanopoulos | python-psycopg2 package: |
126 | a96ec00f | Constantinos Venetsanopoulos | |
127 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
128 | a96ec00f | Constantinos Venetsanopoulos | |
129 | a96ec00f | Constantinos Venetsanopoulos | # apt-get install python-psycopg2 |
130 | a96ec00f | Constantinos Venetsanopoulos | |
131 | 29291ebc | Christos Stavrakakis | To install RabbitMQ>=2.8.4, use the RabbitMQ APT repository by adding the |
132 | 29291ebc | Christos Stavrakakis | following line to ``/etc/apt/sources.list``: |
133 | 29291ebc | Christos Stavrakakis | |
134 | 29291ebc | Christos Stavrakakis | .. code-block:: console |
135 | 29291ebc | Christos Stavrakakis | |
136 | d587329c | Konstantinos Tompoulidis | deb http://www.rabbitmq.com/debian testing main |
137 | 29291ebc | Christos Stavrakakis | |
138 | 29291ebc | Christos Stavrakakis | Add RabbitMQ public key, to trusted key list: |
139 | 29291ebc | Christos Stavrakakis | |
140 | 29291ebc | Christos Stavrakakis | .. code-block:: console |
141 | 29291ebc | Christos Stavrakakis | |
142 | 29291ebc | Christos Stavrakakis | # wget http://www.rabbitmq.com/rabbitmq-signing-key-public.asc |
143 | 29291ebc | Christos Stavrakakis | # apt-key add rabbitmq-signing-key-public.asc |
144 | 29291ebc | Christos Stavrakakis | |
145 | 29291ebc | Christos Stavrakakis | Finally, to install the package run: |
146 | 29291ebc | Christos Stavrakakis | |
147 | 29291ebc | Christos Stavrakakis | .. code-block:: console |
148 | 29291ebc | Christos Stavrakakis | |
149 | 29291ebc | Christos Stavrakakis | # apt-get update |
150 | 29291ebc | Christos Stavrakakis | # apt-get install rabbitmq-server |
151 | 29291ebc | Christos Stavrakakis | |
152 | a96ec00f | Constantinos Venetsanopoulos | Database setup |
153 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
154 | a96ec00f | Constantinos Venetsanopoulos | |
155 | a96ec00f | Constantinos Venetsanopoulos | On node1, we create a database called ``snf_apps``, that will host all django |
156 | a96ec00f | Constantinos Venetsanopoulos | apps related tables. We also create the user ``synnefo`` and grant him all |
157 | a96ec00f | Constantinos Venetsanopoulos | privileges on the database. We do this by running: |
158 | a96ec00f | Constantinos Venetsanopoulos | |
159 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
160 | a96ec00f | Constantinos Venetsanopoulos | |
161 | d587329c | Konstantinos Tompoulidis | root@node1:~ # su - postgres |
162 | d587329c | Konstantinos Tompoulidis | postgres@node1:~ $ psql |
163 | d587329c | Konstantinos Tompoulidis | postgres=# CREATE DATABASE snf_apps WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0; |
164 | d587329c | Konstantinos Tompoulidis | postgres=# CREATE USER synnefo WITH PASSWORD 'example_passw0rd'; |
165 | d587329c | Konstantinos Tompoulidis | postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_apps TO synnefo; |
166 | a96ec00f | Constantinos Venetsanopoulos | |
167 | a96ec00f | Constantinos Venetsanopoulos | We also create the database ``snf_pithos`` needed by the pithos+ backend and |
168 | a96ec00f | Constantinos Venetsanopoulos | grant the ``synnefo`` user all privileges on the database. This database could |
169 | a96ec00f | Constantinos Venetsanopoulos | be created on node2 instead, but we do it on node1 for simplicity. We will |
170 | a96ec00f | Constantinos Venetsanopoulos | create all needed databases on node1 and then node2 will connect to them. |
171 | a96ec00f | Constantinos Venetsanopoulos | |
172 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
173 | a96ec00f | Constantinos Venetsanopoulos | |
174 | d587329c | Konstantinos Tompoulidis | postgres=# CREATE DATABASE snf_pithos WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0; |
175 | d587329c | Konstantinos Tompoulidis | postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_pithos TO synnefo; |
176 | a96ec00f | Constantinos Venetsanopoulos | |
177 | a96ec00f | Constantinos Venetsanopoulos | Configure the database to listen to all network interfaces. You can do this by |
178 | a96ec00f | Constantinos Venetsanopoulos | editting the file ``/etc/postgresql/8.4/main/postgresql.conf`` and change |
179 | a96ec00f | Constantinos Venetsanopoulos | ``listen_addresses`` to ``'*'`` : |
180 | a96ec00f | Constantinos Venetsanopoulos | |
181 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
182 | a96ec00f | Constantinos Venetsanopoulos | |
183 | d587329c | Konstantinos Tompoulidis | listen_addresses = '*' |
184 | a96ec00f | Constantinos Venetsanopoulos | |
185 | a96ec00f | Constantinos Venetsanopoulos | Furthermore, edit ``/etc/postgresql/8.4/main/pg_hba.conf`` to allow node1 and |
186 | a96ec00f | Constantinos Venetsanopoulos | node2 to connect to the database. Add the following lines under ``#IPv4 local |
187 | a96ec00f | Constantinos Venetsanopoulos | connections:`` : |
188 | a96ec00f | Constantinos Venetsanopoulos | |
189 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
190 | a96ec00f | Constantinos Venetsanopoulos | |
191 | d587329c | Konstantinos Tompoulidis | host all all 4.3.2.1/32 md5 |
192 | d587329c | Konstantinos Tompoulidis | host all all 4.3.2.2/32 md5 |
193 | a96ec00f | Constantinos Venetsanopoulos | |
194 | a96ec00f | Constantinos Venetsanopoulos | Make sure to substitute "4.3.2.1" and "4.3.2.2" with node1's and node2's |
195 | a96ec00f | Constantinos Venetsanopoulos | actual IPs. Now, restart the server to apply the changes: |
196 | a96ec00f | Constantinos Venetsanopoulos | |
197 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
198 | a96ec00f | Constantinos Venetsanopoulos | |
199 | a96ec00f | Constantinos Venetsanopoulos | # /etc/init.d/postgresql restart |
200 | a96ec00f | Constantinos Venetsanopoulos | |
201 | a96ec00f | Constantinos Venetsanopoulos | Gunicorn setup |
202 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
203 | a96ec00f | Constantinos Venetsanopoulos | |
204 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/gunicorn.d/synnefo`` containing the following: |
205 | a96ec00f | Constantinos Venetsanopoulos | |
206 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
207 | a96ec00f | Constantinos Venetsanopoulos | |
208 | d587329c | Konstantinos Tompoulidis | CONFIG = { |
209 | d587329c | Konstantinos Tompoulidis | 'mode': 'django', |
210 | d587329c | Konstantinos Tompoulidis | 'environment': { |
211 | d587329c | Konstantinos Tompoulidis | 'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
212 | d587329c | Konstantinos Tompoulidis | }, |
213 | d587329c | Konstantinos Tompoulidis | 'working_dir': '/etc/synnefo', |
214 | d587329c | Konstantinos Tompoulidis | 'user': 'www-data', |
215 | d587329c | Konstantinos Tompoulidis | 'group': 'www-data', |
216 | d587329c | Konstantinos Tompoulidis | 'args': ( |
217 | d587329c | Konstantinos Tompoulidis | '--bind=127.0.0.1:8080', |
218 | d587329c | Konstantinos Tompoulidis | '--worker-class=gevent', |
219 | d587329c | Konstantinos Tompoulidis | '--workers=8', |
220 | d587329c | Konstantinos Tompoulidis | '--log-level=debug', |
221 | d587329c | Konstantinos Tompoulidis | ), |
222 | d587329c | Konstantinos Tompoulidis | } |
223 | a96ec00f | Constantinos Venetsanopoulos | |
224 | 0c40b4ac | Kostas Papadimitriou | .. warning:: Do NOT start the server yet, because it won't find the |
225 | d587329c | Konstantinos Tompoulidis | ``synnefo.settings`` module. Also, in case you are using ``/etc/hosts`` |
226 | d587329c | Konstantinos Tompoulidis | instead of a DNS to get the hostnames, change ``--worker-class=gevent`` to |
227 | d587329c | Konstantinos Tompoulidis | ``--worker-class=sync``. We will start the server after successful |
228 | 4de94e15 | Kostas Papadimitriou | installation of astakos. If the server is running:: |
229 | a96ec00f | Constantinos Venetsanopoulos | |
230 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/gunicorn stop |
231 | a96ec00f | Constantinos Venetsanopoulos | |
232 | a96ec00f | Constantinos Venetsanopoulos | Apache2 setup |
233 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~ |
234 | a96ec00f | Constantinos Venetsanopoulos | |
235 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/apache2/sites-available/synnefo`` containing the |
236 | d587329c | Konstantinos Tompoulidis | following: |
237 | a96ec00f | Constantinos Venetsanopoulos | |
238 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
239 | a96ec00f | Constantinos Venetsanopoulos | |
240 | d587329c | Konstantinos Tompoulidis | <VirtualHost *:80> |
241 | d587329c | Konstantinos Tompoulidis | ServerName node1.example.com |
242 | a96ec00f | Constantinos Venetsanopoulos | |
243 | d587329c | Konstantinos Tompoulidis | RewriteEngine On |
244 | d587329c | Konstantinos Tompoulidis | RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
245 | d587329c | Konstantinos Tompoulidis | RewriteRule ^(.*)$ - [F,L] |
246 | d587329c | Konstantinos Tompoulidis | RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
247 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
248 | a96ec00f | Constantinos Venetsanopoulos | |
249 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/apache2/sites-available/synnefo-ssl`` containing the |
250 | d587329c | Konstantinos Tompoulidis | following: |
251 | a96ec00f | Constantinos Venetsanopoulos | |
252 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
253 | a96ec00f | Constantinos Venetsanopoulos | |
254 | d587329c | Konstantinos Tompoulidis | <IfModule mod_ssl.c> |
255 | d587329c | Konstantinos Tompoulidis | <VirtualHost _default_:443> |
256 | d587329c | Konstantinos Tompoulidis | ServerName node1.example.com |
257 | a96ec00f | Constantinos Venetsanopoulos | |
258 | d587329c | Konstantinos Tompoulidis | Alias /static "/usr/share/synnefo/static" |
259 | a96ec00f | Constantinos Venetsanopoulos | |
260 | d587329c | Konstantinos Tompoulidis | # SetEnv no-gzip |
261 | d587329c | Konstantinos Tompoulidis | # SetEnv dont-vary |
262 | a96ec00f | Constantinos Venetsanopoulos | |
263 | d587329c | Konstantinos Tompoulidis | AllowEncodedSlashes On |
264 | 04427415 | Constantinos Venetsanopoulos | |
265 | d587329c | Konstantinos Tompoulidis | RequestHeader set X-Forwarded-Protocol "https" |
266 | a96ec00f | Constantinos Venetsanopoulos | |
267 | d587329c | Konstantinos Tompoulidis | <Proxy * > |
268 | d587329c | Konstantinos Tompoulidis | Order allow,deny |
269 | d587329c | Konstantinos Tompoulidis | Allow from all |
270 | d587329c | Konstantinos Tompoulidis | </Proxy> |
271 | a96ec00f | Constantinos Venetsanopoulos | |
272 | d587329c | Konstantinos Tompoulidis | SetEnv proxy-sendchunked |
273 | d587329c | Konstantinos Tompoulidis | SSLProxyEngine off |
274 | d587329c | Konstantinos Tompoulidis | ProxyErrorOverride off |
275 | a96ec00f | Constantinos Venetsanopoulos | |
276 | d587329c | Konstantinos Tompoulidis | ProxyPass /static ! |
277 | d587329c | Konstantinos Tompoulidis | ProxyPass / http://localhost:8080/ retry=0 |
278 | d587329c | Konstantinos Tompoulidis | ProxyPassReverse / http://localhost:8080/ |
279 | a96ec00f | Constantinos Venetsanopoulos | |
280 | d587329c | Konstantinos Tompoulidis | RewriteEngine On |
281 | d587329c | Konstantinos Tompoulidis | RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
282 | d587329c | Konstantinos Tompoulidis | RewriteRule ^(.*)$ - [F,L] |
283 | a96ec00f | Constantinos Venetsanopoulos | |
284 | d587329c | Konstantinos Tompoulidis | SSLEngine on |
285 | d587329c | Konstantinos Tompoulidis | SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem |
286 | d587329c | Konstantinos Tompoulidis | SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key |
287 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
288 | d587329c | Konstantinos Tompoulidis | </IfModule> |
289 | a96ec00f | Constantinos Venetsanopoulos | |
290 | a96ec00f | Constantinos Venetsanopoulos | Now enable sites and modules by running: |
291 | a96ec00f | Constantinos Venetsanopoulos | |
292 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
293 | a96ec00f | Constantinos Venetsanopoulos | |
294 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod ssl |
295 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod rewrite |
296 | a96ec00f | Constantinos Venetsanopoulos | # a2dissite default |
297 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo |
298 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo-ssl |
299 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod headers |
300 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod proxy_http |
301 | a96ec00f | Constantinos Venetsanopoulos | |
302 | 4de94e15 | Kostas Papadimitriou | .. warning:: Do NOT start/restart the server yet. If the server is running:: |
303 | a96ec00f | Constantinos Venetsanopoulos | |
304 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/apache2 stop |
305 | a96ec00f | Constantinos Venetsanopoulos | |
306 | 2c85833e | Constantinos Venetsanopoulos | .. _rabbitmq-setup: |
307 | 2c85833e | Constantinos Venetsanopoulos | |
308 | bdfd94c9 | Constantinos Venetsanopoulos | Message Queue setup |
309 | bdfd94c9 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~ |
310 | bdfd94c9 | Constantinos Venetsanopoulos | |
311 | bdfd94c9 | Constantinos Venetsanopoulos | The message queue will run on node1, so we need to create the appropriate |
312 | bdfd94c9 | Constantinos Venetsanopoulos | rabbitmq user. The user is named ``synnefo`` and gets full privileges on all |
313 | bdfd94c9 | Constantinos Venetsanopoulos | exchanges: |
314 | bdfd94c9 | Constantinos Venetsanopoulos | |
315 | bdfd94c9 | Constantinos Venetsanopoulos | .. code-block:: console |
316 | bdfd94c9 | Constantinos Venetsanopoulos | |
317 | 69aa7f21 | Ilias Tsitsimpis | # rabbitmqctl add_user synnefo "example_rabbitmq_passw0rd" |
318 | bdfd94c9 | Constantinos Venetsanopoulos | # rabbitmqctl set_permissions synnefo ".*" ".*" ".*" |
319 | bdfd94c9 | Constantinos Venetsanopoulos | |
320 | bdfd94c9 | Constantinos Venetsanopoulos | We do not need to initialize the exchanges. This will be done automatically, |
321 | bdfd94c9 | Constantinos Venetsanopoulos | during the Cyclades setup. |
322 | bdfd94c9 | Constantinos Venetsanopoulos | |
323 | a96ec00f | Constantinos Venetsanopoulos | Pithos+ data directory setup |
324 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
325 | a96ec00f | Constantinos Venetsanopoulos | |
326 | a96ec00f | Constantinos Venetsanopoulos | As mentioned in the General Prerequisites section, there is a directory called |
327 | a96ec00f | Constantinos Venetsanopoulos | ``/srv/pithos`` visible by both nodes. We create and setup the ``data`` |
328 | a96ec00f | Constantinos Venetsanopoulos | directory inside it: |
329 | a96ec00f | Constantinos Venetsanopoulos | |
330 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
331 | a96ec00f | Constantinos Venetsanopoulos | |
332 | a96ec00f | Constantinos Venetsanopoulos | # cd /srv/pithos |
333 | a96ec00f | Constantinos Venetsanopoulos | # mkdir data |
334 | a96ec00f | Constantinos Venetsanopoulos | # chown www-data:www-data data |
335 | a96ec00f | Constantinos Venetsanopoulos | # chmod g+ws data |
336 | a96ec00f | Constantinos Venetsanopoulos | |
337 | a96ec00f | Constantinos Venetsanopoulos | You are now ready with all general prerequisites concerning node1. Let's go to |
338 | a96ec00f | Constantinos Venetsanopoulos | node2. |
339 | a96ec00f | Constantinos Venetsanopoulos | |
340 | a96ec00f | Constantinos Venetsanopoulos | Node2 |
341 | a96ec00f | Constantinos Venetsanopoulos | ----- |
342 | a96ec00f | Constantinos Venetsanopoulos | |
343 | a96ec00f | Constantinos Venetsanopoulos | General Synnefo dependencies |
344 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
345 | a96ec00f | Constantinos Venetsanopoulos | |
346 | d587329c | Konstantinos Tompoulidis | * apache (http server) |
347 | d587329c | Konstantinos Tompoulidis | * gunicorn (WSGI http server) |
348 | d587329c | Konstantinos Tompoulidis | * postgresql (database) |
349 | d587329c | Konstantinos Tompoulidis | * ntp (NTP daemon) |
350 | d587329c | Konstantinos Tompoulidis | * gevent |
351 | a96ec00f | Constantinos Venetsanopoulos | |
352 | a96ec00f | Constantinos Venetsanopoulos | You can install the above by running: |
353 | a96ec00f | Constantinos Venetsanopoulos | |
354 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
355 | a96ec00f | Constantinos Venetsanopoulos | |
356 | 7df5a742 | Christos Stavrakakis | # apt-get install apache2 postgresql ntp |
357 | 73ff1d54 | Constantinos Venetsanopoulos | |
358 | 73ff1d54 | Constantinos Venetsanopoulos | Make sure to install gunicorn >= v0.12.2. You can do this by installing from |
359 | 73ff1d54 | Constantinos Venetsanopoulos | the official debian backports: |
360 | 73ff1d54 | Constantinos Venetsanopoulos | |
361 | 73ff1d54 | Constantinos Venetsanopoulos | .. code-block:: console |
362 | 73ff1d54 | Constantinos Venetsanopoulos | |
363 | 73ff1d54 | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install gunicorn |
364 | a96ec00f | Constantinos Venetsanopoulos | |
365 | 576e059b | Constantinos Venetsanopoulos | Also, make sure to install gevent >= 0.13.6. Again from the debian backports: |
366 | 576e059b | Constantinos Venetsanopoulos | |
367 | 576e059b | Constantinos Venetsanopoulos | .. code-block:: console |
368 | 576e059b | Constantinos Venetsanopoulos | |
369 | 576e059b | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install python-gevent |
370 | 576e059b | Constantinos Venetsanopoulos | |
371 | 73ff1d54 | Constantinos Venetsanopoulos | Node2 will connect to the databases on node1, so you will also need the |
372 | 73ff1d54 | Constantinos Venetsanopoulos | python-psycopg2 package: |
373 | a96ec00f | Constantinos Venetsanopoulos | |
374 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
375 | a96ec00f | Constantinos Venetsanopoulos | |
376 | a96ec00f | Constantinos Venetsanopoulos | # apt-get install python-psycopg2 |
377 | a96ec00f | Constantinos Venetsanopoulos | |
378 | a96ec00f | Constantinos Venetsanopoulos | Database setup |
379 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
380 | a96ec00f | Constantinos Venetsanopoulos | |
381 | a96ec00f | Constantinos Venetsanopoulos | All databases have been created and setup on node1, so we do not need to take |
382 | a96ec00f | Constantinos Venetsanopoulos | any action here. From node2, we will just connect to them. When you get familiar |
383 | a96ec00f | Constantinos Venetsanopoulos | with the software you may choose to run different databases on different nodes, |
384 | a96ec00f | Constantinos Venetsanopoulos | for performance/scalability/redundancy reasons, but those kind of setups are out |
385 | a96ec00f | Constantinos Venetsanopoulos | of the purpose of this guide. |
386 | a96ec00f | Constantinos Venetsanopoulos | |
387 | a96ec00f | Constantinos Venetsanopoulos | Gunicorn setup |
388 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
389 | a96ec00f | Constantinos Venetsanopoulos | |
390 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/gunicorn.d/synnefo`` containing the following |
391 | a96ec00f | Constantinos Venetsanopoulos | (same contents as in node1; you can just copy/paste the file): |
392 | a96ec00f | Constantinos Venetsanopoulos | |
393 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
394 | a96ec00f | Constantinos Venetsanopoulos | |
395 | d587329c | Konstantinos Tompoulidis | CONFIG = { |
396 | d587329c | Konstantinos Tompoulidis | 'mode': 'django', |
397 | d587329c | Konstantinos Tompoulidis | 'environment': { |
398 | a96ec00f | Constantinos Venetsanopoulos | 'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
399 | d587329c | Konstantinos Tompoulidis | }, |
400 | d587329c | Konstantinos Tompoulidis | 'working_dir': '/etc/synnefo', |
401 | d587329c | Konstantinos Tompoulidis | 'user': 'www-data', |
402 | d587329c | Konstantinos Tompoulidis | 'group': 'www-data', |
403 | d587329c | Konstantinos Tompoulidis | 'args': ( |
404 | d587329c | Konstantinos Tompoulidis | '--bind=127.0.0.1:8080', |
405 | d587329c | Konstantinos Tompoulidis | '--worker-class=gevent', |
406 | d587329c | Konstantinos Tompoulidis | '--workers=4', |
407 | d587329c | Konstantinos Tompoulidis | '--log-level=debug', |
408 | d587329c | Konstantinos Tompoulidis | '--timeout=43200' |
409 | d587329c | Konstantinos Tompoulidis | ), |
410 | d587329c | Konstantinos Tompoulidis | } |
411 | a96ec00f | Constantinos Venetsanopoulos | |
412 | 0c40b4ac | Kostas Papadimitriou | .. warning:: Do NOT start the server yet, because it won't find the |
413 | d587329c | Konstantinos Tompoulidis | ``synnefo.settings`` module. Also, in case you are using ``/etc/hosts`` |
414 | d587329c | Konstantinos Tompoulidis | instead of a DNS to get the hostnames, change ``--worker-class=gevent`` to |
415 | d587329c | Konstantinos Tompoulidis | ``--worker-class=sync``. We will start the server after successful |
416 | 4de94e15 | Kostas Papadimitriou | installation of astakos. If the server is running:: |
417 | a96ec00f | Constantinos Venetsanopoulos | |
418 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/gunicorn stop |
419 | bdb83fd6 | cven | |
420 | a96ec00f | Constantinos Venetsanopoulos | Apache2 setup |
421 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~ |
422 | 5b6feb88 | Vangelis Koukis | |
423 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/apache2/sites-available/synnefo`` containing the |
424 | d587329c | Konstantinos Tompoulidis | following: |
425 | 5b6feb88 | Vangelis Koukis | |
426 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
427 | a96ec00f | Constantinos Venetsanopoulos | |
428 | d587329c | Konstantinos Tompoulidis | <VirtualHost *:80> |
429 | d587329c | Konstantinos Tompoulidis | ServerName node2.example.com |
430 | a96ec00f | Constantinos Venetsanopoulos | |
431 | d587329c | Konstantinos Tompoulidis | RewriteEngine On |
432 | d587329c | Konstantinos Tompoulidis | RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
433 | d587329c | Konstantinos Tompoulidis | RewriteRule ^(.*)$ - [F,L] |
434 | d587329c | Konstantinos Tompoulidis | RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
435 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
436 | a96ec00f | Constantinos Venetsanopoulos | |
437 | a96ec00f | Constantinos Venetsanopoulos | Create the file ``synnefo-ssl`` under ``/etc/apache2/sites-available/`` |
438 | a96ec00f | Constantinos Venetsanopoulos | containing the following: |
439 | a96ec00f | Constantinos Venetsanopoulos | |
440 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
441 | a96ec00f | Constantinos Venetsanopoulos | |
442 | d587329c | Konstantinos Tompoulidis | <IfModule mod_ssl.c> |
443 | d587329c | Konstantinos Tompoulidis | <VirtualHost _default_:443> |
444 | d587329c | Konstantinos Tompoulidis | ServerName node2.example.com |
445 | a96ec00f | Constantinos Venetsanopoulos | |
446 | d587329c | Konstantinos Tompoulidis | Alias /static "/usr/share/synnefo/static" |
447 | a96ec00f | Constantinos Venetsanopoulos | |
448 | d587329c | Konstantinos Tompoulidis | SetEnv no-gzip |
449 | d587329c | Konstantinos Tompoulidis | SetEnv dont-vary |
450 | d587329c | Konstantinos Tompoulidis | AllowEncodedSlashes On |
451 | a96ec00f | Constantinos Venetsanopoulos | |
452 | d587329c | Konstantinos Tompoulidis | RequestHeader set X-Forwarded-Protocol "https" |
453 | a96ec00f | Constantinos Venetsanopoulos | |
454 | d587329c | Konstantinos Tompoulidis | <Proxy * > |
455 | d587329c | Konstantinos Tompoulidis | Order allow,deny |
456 | d587329c | Konstantinos Tompoulidis | Allow from all |
457 | d587329c | Konstantinos Tompoulidis | </Proxy> |
458 | a96ec00f | Constantinos Venetsanopoulos | |
459 | d587329c | Konstantinos Tompoulidis | SetEnv proxy-sendchunked |
460 | d587329c | Konstantinos Tompoulidis | SSLProxyEngine off |
461 | d587329c | Konstantinos Tompoulidis | ProxyErrorOverride off |
462 | a96ec00f | Constantinos Venetsanopoulos | |
463 | d587329c | Konstantinos Tompoulidis | ProxyPass /static ! |
464 | d587329c | Konstantinos Tompoulidis | ProxyPass / http://localhost:8080/ retry=0 |
465 | d587329c | Konstantinos Tompoulidis | ProxyPassReverse / http://localhost:8080/ |
466 | a96ec00f | Constantinos Venetsanopoulos | |
467 | d587329c | Konstantinos Tompoulidis | SSLEngine on |
468 | d587329c | Konstantinos Tompoulidis | SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem |
469 | d587329c | Konstantinos Tompoulidis | SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key |
470 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
471 | d587329c | Konstantinos Tompoulidis | </IfModule> |
472 | a96ec00f | Constantinos Venetsanopoulos | |
473 | a96ec00f | Constantinos Venetsanopoulos | As in node1, enable sites and modules by running: |
474 | a96ec00f | Constantinos Venetsanopoulos | |
475 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
476 | a96ec00f | Constantinos Venetsanopoulos | |
477 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod ssl |
478 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod rewrite |
479 | a96ec00f | Constantinos Venetsanopoulos | # a2dissite default |
480 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo |
481 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo-ssl |
482 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod headers |
483 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod proxy_http |
484 | a96ec00f | Constantinos Venetsanopoulos | |
485 | 4de94e15 | Kostas Papadimitriou | .. warning:: Do NOT start/restart the server yet. If the server is running:: |
486 | a96ec00f | Constantinos Venetsanopoulos | |
487 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/apache2 stop |
488 | a96ec00f | Constantinos Venetsanopoulos | |
489 | a96ec00f | Constantinos Venetsanopoulos | We are now ready with all general prerequisites for node2. Now that we have |
490 | a96ec00f | Constantinos Venetsanopoulos | finished with all general prerequisites for both nodes, we can start installing |
491 | a96ec00f | Constantinos Venetsanopoulos | the services. First, let's install Astakos on node1. |
492 | a96ec00f | Constantinos Venetsanopoulos | |
493 | a96ec00f | Constantinos Venetsanopoulos | |
494 | a96ec00f | Constantinos Venetsanopoulos | Installation of Astakos on node1 |
495 | a96ec00f | Constantinos Venetsanopoulos | ================================ |
496 | a96ec00f | Constantinos Venetsanopoulos | |
497 | a96ec00f | Constantinos Venetsanopoulos | To install astakos, grab the package from our repository (make sure you made |
498 | a96ec00f | Constantinos Venetsanopoulos | the additions needed in your ``/etc/apt/sources.list`` file, as described |
499 | a96ec00f | Constantinos Venetsanopoulos | previously), by running: |
500 | a96ec00f | Constantinos Venetsanopoulos | |
501 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
502 | a96ec00f | Constantinos Venetsanopoulos | |
503 | d587329c | Konstantinos Tompoulidis | # apt-get install snf-astakos-app snf-quotaholder-app snf-pithos-backend |
504 | a96ec00f | Constantinos Venetsanopoulos | |
505 | a96ec00f | Constantinos Venetsanopoulos | After successful installation of snf-astakos-app, make sure that also |
506 | a96ec00f | Constantinos Venetsanopoulos | snf-webproject has been installed (marked as "Recommended" package). By default |
507 | a96ec00f | Constantinos Venetsanopoulos | Debian installs "Recommended" packages, but if you have changed your |
508 | a96ec00f | Constantinos Venetsanopoulos | configuration and the package didn't install automatically, you should |
509 | a96ec00f | Constantinos Venetsanopoulos | explicitly install it manually running: |
510 | a96ec00f | Constantinos Venetsanopoulos | |
511 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
512 | a96ec00f | Constantinos Venetsanopoulos | |
513 | a96ec00f | Constantinos Venetsanopoulos | # apt-get install snf-webproject |
514 | a96ec00f | Constantinos Venetsanopoulos | |
515 | a96ec00f | Constantinos Venetsanopoulos | The reason snf-webproject is "Recommended" and not a hard dependency, is to give |
516 | d587329c | Konstantinos Tompoulidis | the experienced administrator the ability to install Synnefo in a custom made |
517 | d587329c | Konstantinos Tompoulidis | `Django <https://www.djangoproject.com/>`_ project. This corner case |
518 | d587329c | Konstantinos Tompoulidis | concerns only very advanced users that know what they are doing and want to |
519 | d587329c | Konstantinos Tompoulidis | experiment with synnefo. |
520 | a96ec00f | Constantinos Venetsanopoulos | |
521 | 04c1254b | Constantinos Venetsanopoulos | |
522 | 04c1254b | Constantinos Venetsanopoulos | .. _conf-astakos: |
523 | 04c1254b | Constantinos Venetsanopoulos | |
524 | a96ec00f | Constantinos Venetsanopoulos | Configuration of Astakos |
525 | a96ec00f | Constantinos Venetsanopoulos | ======================== |
526 | a96ec00f | Constantinos Venetsanopoulos | |
527 | a96ec00f | Constantinos Venetsanopoulos | Conf Files |
528 | a96ec00f | Constantinos Venetsanopoulos | ---------- |
529 | a96ec00f | Constantinos Venetsanopoulos | |
530 | a96ec00f | Constantinos Venetsanopoulos | After astakos is successfully installed, you will find the directory |
531 | a96ec00f | Constantinos Venetsanopoulos | ``/etc/synnefo`` and some configuration files inside it. The files contain |
532 | a96ec00f | Constantinos Venetsanopoulos | commented configuration options, which are the default options. While installing |
533 | a96ec00f | Constantinos Venetsanopoulos | new snf-* components, new configuration files will appear inside the directory. |
534 | a96ec00f | Constantinos Venetsanopoulos | In this guide (and for all services), we will edit only the minimum necessary |
535 | a96ec00f | Constantinos Venetsanopoulos | configuration options, to reflect our setup. Everything else will remain as is. |
536 | a96ec00f | Constantinos Venetsanopoulos | |
537 | a96ec00f | Constantinos Venetsanopoulos | After getting familiar with synnefo, you will be able to customize the software |
538 | a96ec00f | Constantinos Venetsanopoulos | as you wish and fits your needs. Many options are available, to empower the |
539 | a96ec00f | Constantinos Venetsanopoulos | administrator with extensively customizable setups. |
540 | a96ec00f | Constantinos Venetsanopoulos | |
541 | a96ec00f | Constantinos Venetsanopoulos | For the snf-webproject component (installed as an astakos dependency), we |
542 | a96ec00f | Constantinos Venetsanopoulos | need the following: |
543 | a96ec00f | Constantinos Venetsanopoulos | |
544 | a96ec00f | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/10-snf-webproject-database.conf``. You will need to |
545 | a96ec00f | Constantinos Venetsanopoulos | uncomment and edit the ``DATABASES`` block to reflect our database: |
546 | a96ec00f | Constantinos Venetsanopoulos | |
547 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
548 | a96ec00f | Constantinos Venetsanopoulos | |
549 | d587329c | Konstantinos Tompoulidis | DATABASES = { |
550 | d587329c | Konstantinos Tompoulidis | 'default': { |
551 | d587329c | Konstantinos Tompoulidis | # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle' |
552 | d587329c | Konstantinos Tompoulidis | 'ENGINE': 'postgresql_psycopg2', |
553 | a96ec00f | Constantinos Venetsanopoulos | # ATTENTION: This *must* be the absolute path if using sqlite3. |
554 | a96ec00f | Constantinos Venetsanopoulos | # See: http://docs.djangoproject.com/en/dev/ref/settings/#name |
555 | d587329c | Konstantinos Tompoulidis | 'NAME': 'snf_apps', |
556 | d587329c | Konstantinos Tompoulidis | 'USER': 'synnefo', # Not used with sqlite3. |
557 | d587329c | Konstantinos Tompoulidis | 'PASSWORD': 'example_passw0rd', # Not used with sqlite3. |
558 | d587329c | Konstantinos Tompoulidis | # Set to empty string for localhost. Not used with sqlite3. |
559 | d587329c | Konstantinos Tompoulidis | 'HOST': '4.3.2.1', |
560 | d587329c | Konstantinos Tompoulidis | # Set to empty string for default. Not used with sqlite3. |
561 | d587329c | Konstantinos Tompoulidis | 'PORT': '5432', |
562 | d587329c | Konstantinos Tompoulidis | } |
563 | a96ec00f | Constantinos Venetsanopoulos | } |
564 | a96ec00f | Constantinos Venetsanopoulos | |
565 | a96ec00f | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/10-snf-webproject-deploy.conf``. Uncomment and edit |
566 | d587329c | Konstantinos Tompoulidis | ``SECRET_KEY``. This is a Django specific setting which is used to provide a |
567 | a96ec00f | Constantinos Venetsanopoulos | seed in secret-key hashing algorithms. Set this to a random string of your |
568 | a96ec00f | Constantinos Venetsanopoulos | choise and keep it private: |
569 | a96ec00f | Constantinos Venetsanopoulos | |
570 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
571 | a96ec00f | Constantinos Venetsanopoulos | |
572 | d587329c | Konstantinos Tompoulidis | SECRET_KEY = 'sy6)mw6a7x%n)-example_secret_key#zzk4jo6f2=uqu!1o%)' |
573 | a96ec00f | Constantinos Venetsanopoulos | |
574 | a96ec00f | Constantinos Venetsanopoulos | For astakos specific configuration, edit the following options in |
575 | 73ff1d54 | Constantinos Venetsanopoulos | ``/etc/synnefo/20-snf-astakos-app-settings.conf`` : |
576 | a96ec00f | Constantinos Venetsanopoulos | |
577 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
578 | a96ec00f | Constantinos Venetsanopoulos | |
579 | d587329c | Konstantinos Tompoulidis | ASTAKOS_DEFAULT_ADMIN_EMAIL = None |
580 | 4404e02e | Ilias Tsitsimpis | |
581 | d587329c | Konstantinos Tompoulidis | ASTAKOS_COOKIE_DOMAIN = '.example.com' |
582 | a96ec00f | Constantinos Venetsanopoulos | |
583 | d587329c | Konstantinos Tompoulidis | ASTAKOS_BASEURL = 'https://node1.example.com' |
584 | a96ec00f | Constantinos Venetsanopoulos | |
585 | 4e3e3d24 | Constantinos Venetsanopoulos | The ``ASTAKOS_COOKIE_DOMAIN`` should be the base url of our domain (for all |
586 | 4e3e3d24 | Constantinos Venetsanopoulos | services). ``ASTAKOS_BASEURL`` is the astakos home page. |
587 | 5b6feb88 | Vangelis Koukis | |
588 | 4404e02e | Ilias Tsitsimpis | ``ASTAKOS_DEFAULT_ADMIN_EMAIL`` refers to the administrator's email. |
589 | 4404e02e | Ilias Tsitsimpis | Every time a new account is created a notification is sent to this email. |
590 | 4404e02e | Ilias Tsitsimpis | For this we need access to a running mail server, so we have disabled |
591 | 4404e02e | Ilias Tsitsimpis | it for now by setting its value to None. For more informations on this, |
592 | 4404e02e | Ilias Tsitsimpis | read the relative :ref:`section <mail-server>`. |
593 | 4404e02e | Ilias Tsitsimpis | |
594 | 4e3e3d24 | Constantinos Venetsanopoulos | .. note:: For the purpose of this guide, we don't enable recaptcha authentication. |
595 | 4e3e3d24 | Constantinos Venetsanopoulos | If you would like to enable it, you have to edit the following options: |
596 | 319b615d | Ilias Tsitsimpis | |
597 | 319b615d | Ilias Tsitsimpis | .. code-block:: console |
598 | 319b615d | Ilias Tsitsimpis | |
599 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_PUBLIC_KEY = 'example_recaptcha_public_key!@#$%^&*(' |
600 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_PRIVATE_KEY = 'example_recaptcha_private_key!@#$%^&*(' |
601 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_USE_SSL = True |
602 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_ENABLED = True |
603 | 319b615d | Ilias Tsitsimpis | |
604 | 319b615d | Ilias Tsitsimpis | For the ``ASTAKOS_RECAPTCHA_PUBLIC_KEY`` and ``ASTAKOS_RECAPTCHA_PRIVATE_KEY`` |
605 | 319b615d | Ilias Tsitsimpis | go to https://www.google.com/recaptcha/admin/create and create your own pair. |
606 | 5b6feb88 | Vangelis Koukis | |
607 | 610ff8cf | Constantinos Venetsanopoulos | Then edit ``/etc/synnefo/20-snf-astakos-app-cloudbar.conf`` : |
608 | 610ff8cf | Constantinos Venetsanopoulos | |
609 | 610ff8cf | Constantinos Venetsanopoulos | .. code-block:: console |
610 | 610ff8cf | Constantinos Venetsanopoulos | |
611 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
612 | 610ff8cf | Constantinos Venetsanopoulos | |
613 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services' |
614 | 610ff8cf | Constantinos Venetsanopoulos | |
615 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_MENU_URL = 'https://node1.example.com/im/get_menu' |
616 | 610ff8cf | Constantinos Venetsanopoulos | |
617 | d587329c | Konstantinos Tompoulidis | Those settings have to do with the black cloudbar endpoints and will be |
618 | d587329c | Konstantinos Tompoulidis | described in more detail later on in this guide. For now, just edit the domain |
619 | d587329c | Konstantinos Tompoulidis | to point at node1 which is where we have installed Astakos. |
620 | 610ff8cf | Constantinos Venetsanopoulos | |
621 | d587329c | Konstantinos Tompoulidis | If you are an advanced user and want to use the Shibboleth Authentication |
622 | d587329c | Konstantinos Tompoulidis | method, read the relative :ref:`section <shibboleth-auth>`. |
623 | d2a9f85f | Sofia Papagiannaki | |
624 | 5a2d4e43 | Christos Stavrakakis | .. note:: Because Cyclades and Astakos are running on the same machine |
625 | 5a2d4e43 | Christos Stavrakakis | in our example, we have to deactivate the CSRF verification. We can do so |
626 | 5a2d4e43 | Christos Stavrakakis | by adding to |
627 | 5a2d4e43 | Christos Stavrakakis | ``/etc/synnefo/99-local.conf``: |
628 | 5a2d4e43 | Christos Stavrakakis | |
629 | 5a2d4e43 | Christos Stavrakakis | .. code-block:: console |
630 | 5a2d4e43 | Christos Stavrakakis | |
631 | 5a2d4e43 | Christos Stavrakakis | MIDDLEWARE_CLASSES.remove('django.middleware.csrf.CsrfViewMiddleware') |
632 | 5a2d4e43 | Christos Stavrakakis | TEMPLATE_CONTEXT_PROCESSORS.remove('django.core.context_processors.csrf') |
633 | 5a2d4e43 | Christos Stavrakakis | |
634 | d587329c | Konstantinos Tompoulidis | Since version 0.13 you need to configure some basic settings for the new *Quota* |
635 | d587329c | Konstantinos Tompoulidis | feature. |
636 | d587329c | Konstantinos Tompoulidis | |
637 | d587329c | Konstantinos Tompoulidis | Specifically: |
638 | d587329c | Konstantinos Tompoulidis | |
639 | d587329c | Konstantinos Tompoulidis | Edit ``/etc/synnefo/20-snf-astakos-app-settings.conf``: |
640 | d587329c | Konstantinos Tompoulidis | |
641 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
642 | d587329c | Konstantinos Tompoulidis | |
643 | d587329c | Konstantinos Tompoulidis | QUOTAHOLDER_URL = 'https://node1.example.com/quotaholder/v' |
644 | d587329c | Konstantinos Tompoulidis | QUOTAHOLDER_TOKEN = 'aExampleTokenJbFm12w' |
645 | d587329c | Konstantinos Tompoulidis | ASTAKOS_QUOTAHOLDER_TOKEN = 'aExampleTokenJbFm12w' |
646 | d587329c | Konstantinos Tompoulidis | ASTAKOS_QUOTAHOLDER_URL = 'https://node1.example.com/quotaholder/v' |
647 | d587329c | Konstantinos Tompoulidis | |
648 | 4e3e3d24 | Constantinos Venetsanopoulos | Enable Pooling |
649 | 4e3e3d24 | Constantinos Venetsanopoulos | -------------- |
650 | 4e3e3d24 | Constantinos Venetsanopoulos | |
651 | 4e3e3d24 | Constantinos Venetsanopoulos | This section can be bypassed, but we strongly recommend you apply the following, |
652 | 4e3e3d24 | Constantinos Venetsanopoulos | since they result in a significant performance boost. |
653 | 4e3e3d24 | Constantinos Venetsanopoulos | |
654 | 4e3e3d24 | Constantinos Venetsanopoulos | Synnefo includes a pooling DBAPI driver for PostgreSQL, as a thin wrapper |
655 | 4e3e3d24 | Constantinos Venetsanopoulos | around Psycopg2. This allows independent Django requests to reuse pooled DB |
656 | 4e3e3d24 | Constantinos Venetsanopoulos | connections, with significant performance gains. |
657 | 4e3e3d24 | Constantinos Venetsanopoulos | |
658 | 4e3e3d24 | Constantinos Venetsanopoulos | To use, first monkey-patch psycopg2. For Django, run this before the |
659 | 4e3e3d24 | Constantinos Venetsanopoulos | ``DATABASES`` setting in ``/etc/synnefo/10-snf-webproject-database.conf``: |
660 | 4e3e3d24 | Constantinos Venetsanopoulos | |
661 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
662 | 4e3e3d24 | Constantinos Venetsanopoulos | |
663 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2 |
664 | d587329c | Konstantinos Tompoulidis | monkey_patch_psycopg2() |
665 | 4e3e3d24 | Constantinos Venetsanopoulos | |
666 | 576e059b | Constantinos Venetsanopoulos | Since we are running with greenlets, we should modify psycopg2 behavior, so it |
667 | 576e059b | Constantinos Venetsanopoulos | works properly in a greenlet context: |
668 | 4e3e3d24 | Constantinos Venetsanopoulos | |
669 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
670 | 4e3e3d24 | Constantinos Venetsanopoulos | |
671 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.psyco_gevent import make_psycopg_green |
672 | d587329c | Konstantinos Tompoulidis | make_psycopg_green() |
673 | 4e3e3d24 | Constantinos Venetsanopoulos | |
674 | 4e3e3d24 | Constantinos Venetsanopoulos | Use the Psycopg2 driver as usual. For Django, this means using |
675 | 4e3e3d24 | Constantinos Venetsanopoulos | ``django.db.backends.postgresql_psycopg2`` without any modifications. To enable |
676 | 4e3e3d24 | Constantinos Venetsanopoulos | connection pooling, pass a nonzero ``synnefo_poolsize`` option to the DBAPI |
677 | d587329c | Konstantinos Tompoulidis | driver, through ``DATABASES.OPTIONS`` in Django. |
678 | 4e3e3d24 | Constantinos Venetsanopoulos | |
679 | 4e3e3d24 | Constantinos Venetsanopoulos | All the above will result in an ``/etc/synnefo/10-snf-webproject-database.conf`` |
680 | 4e3e3d24 | Constantinos Venetsanopoulos | file that looks like this: |
681 | 4e3e3d24 | Constantinos Venetsanopoulos | |
682 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
683 | 4e3e3d24 | Constantinos Venetsanopoulos | |
684 | d587329c | Konstantinos Tompoulidis | # Monkey-patch psycopg2 |
685 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2 |
686 | d587329c | Konstantinos Tompoulidis | monkey_patch_psycopg2() |
687 | 4e3e3d24 | Constantinos Venetsanopoulos | |
688 | d587329c | Konstantinos Tompoulidis | # If running with greenlets |
689 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.psyco_gevent import make_psycopg_green |
690 | d587329c | Konstantinos Tompoulidis | make_psycopg_green() |
691 | 4e3e3d24 | Constantinos Venetsanopoulos | |
692 | d587329c | Konstantinos Tompoulidis | DATABASES = { |
693 | d587329c | Konstantinos Tompoulidis | 'default': { |
694 | d587329c | Konstantinos Tompoulidis | # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle' |
695 | d587329c | Konstantinos Tompoulidis | 'ENGINE': 'postgresql_psycopg2', |
696 | d587329c | Konstantinos Tompoulidis | 'OPTIONS': {'synnefo_poolsize': 8}, |
697 | 4e3e3d24 | Constantinos Venetsanopoulos | |
698 | 4e3e3d24 | Constantinos Venetsanopoulos | # ATTENTION: This *must* be the absolute path if using sqlite3. |
699 | 4e3e3d24 | Constantinos Venetsanopoulos | # See: http://docs.djangoproject.com/en/dev/ref/settings/#name |
700 | d587329c | Konstantinos Tompoulidis | 'NAME': 'snf_apps', |
701 | d587329c | Konstantinos Tompoulidis | 'USER': 'synnefo', # Not used with sqlite3. |
702 | d587329c | Konstantinos Tompoulidis | 'PASSWORD': 'example_passw0rd', # Not used with sqlite3. |
703 | d587329c | Konstantinos Tompoulidis | # Set to empty string for localhost. Not used with sqlite3. |
704 | d587329c | Konstantinos Tompoulidis | 'HOST': '4.3.2.1', |
705 | d587329c | Konstantinos Tompoulidis | # Set to empty string for default. Not used with sqlite3. |
706 | d587329c | Konstantinos Tompoulidis | 'PORT': '5432', |
707 | d587329c | Konstantinos Tompoulidis | } |
708 | 4e3e3d24 | Constantinos Venetsanopoulos | } |
709 | 5a2d4e43 | Christos Stavrakakis | |
710 | a96ec00f | Constantinos Venetsanopoulos | Database Initialization |
711 | a96ec00f | Constantinos Venetsanopoulos | ----------------------- |
712 | a96ec00f | Constantinos Venetsanopoulos | |
713 | de20a465 | Constantinos Venetsanopoulos | After configuration is done, we initialize the database by running: |
714 | 5b6feb88 | Vangelis Koukis | |
715 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
716 | a96ec00f | Constantinos Venetsanopoulos | |
717 | d587329c | Konstantinos Tompoulidis | # snf-manage syncdb |
718 | a96ec00f | Constantinos Venetsanopoulos | |
719 | a96ec00f | Constantinos Venetsanopoulos | At this example we don't need to create a django superuser, so we select |
720 | a96ec00f | Constantinos Venetsanopoulos | ``[no]`` to the question. After a successful sync, we run the migration needed |
721 | a96ec00f | Constantinos Venetsanopoulos | for astakos: |
722 | 5b6feb88 | Vangelis Koukis | |
723 | 5b6feb88 | Vangelis Koukis | .. code-block:: console |
724 | 5b6feb88 | Vangelis Koukis | |
725 | d587329c | Konstantinos Tompoulidis | # snf-manage migrate im |
726 | a96ec00f | Constantinos Venetsanopoulos | |
727 | de20a465 | Constantinos Venetsanopoulos | Then, we load the pre-defined user groups |
728 | d2a9f85f | Sofia Papagiannaki | |
729 | d2a9f85f | Sofia Papagiannaki | .. code-block:: console |
730 | d2a9f85f | Sofia Papagiannaki | |
731 | d587329c | Konstantinos Tompoulidis | # snf-manage loaddata groups |
732 | d2a9f85f | Sofia Papagiannaki | |
733 | de20a465 | Constantinos Venetsanopoulos | .. _services-reg: |
734 | de20a465 | Constantinos Venetsanopoulos | |
735 | de20a465 | Constantinos Venetsanopoulos | Services Registration |
736 | de20a465 | Constantinos Venetsanopoulos | --------------------- |
737 | de20a465 | Constantinos Venetsanopoulos | |
738 | de20a465 | Constantinos Venetsanopoulos | When the database is ready, we configure the elements of the Astakos cloudbar, |
739 | de20a465 | Constantinos Venetsanopoulos | to point to our future services: |
740 | de20a465 | Constantinos Venetsanopoulos | |
741 | de20a465 | Constantinos Venetsanopoulos | .. code-block:: console |
742 | de20a465 | Constantinos Venetsanopoulos | |
743 | d587329c | Konstantinos Tompoulidis | # snf-manage service-add "~okeanos home" https://node1.example.com/im/ home-icon.png |
744 | d587329c | Konstantinos Tompoulidis | # snf-manage service-add "cyclades" https://node1.example.com/ui/ |
745 | d587329c | Konstantinos Tompoulidis | # snf-manage service-add "pithos+" https://node2.example.com/ui/ |
746 | de20a465 | Constantinos Venetsanopoulos | |
747 | de20a465 | Constantinos Venetsanopoulos | Servers Initialization |
748 | de20a465 | Constantinos Venetsanopoulos | ---------------------- |
749 | de20a465 | Constantinos Venetsanopoulos | |
750 | de20a465 | Constantinos Venetsanopoulos | Finally, we initialize the servers on node1: |
751 | de20a465 | Constantinos Venetsanopoulos | |
752 | de20a465 | Constantinos Venetsanopoulos | .. code-block:: console |
753 | de20a465 | Constantinos Venetsanopoulos | |
754 | d587329c | Konstantinos Tompoulidis | root@node1:~ # /etc/init.d/gunicorn restart |
755 | d587329c | Konstantinos Tompoulidis | root@node1:~ # /etc/init.d/apache2 restart |
756 | de20a465 | Constantinos Venetsanopoulos | |
757 | de20a465 | Constantinos Venetsanopoulos | We have now finished the Astakos setup. Let's test it now. |
758 | a96ec00f | Constantinos Venetsanopoulos | |
759 | a96ec00f | Constantinos Venetsanopoulos | |
760 | a96ec00f | Constantinos Venetsanopoulos | Testing of Astakos |
761 | a96ec00f | Constantinos Venetsanopoulos | ================== |
762 | a96ec00f | Constantinos Venetsanopoulos | |
763 | a96ec00f | Constantinos Venetsanopoulos | Open your favorite browser and go to: |
764 | a96ec00f | Constantinos Venetsanopoulos | |
765 | a96ec00f | Constantinos Venetsanopoulos | ``http://node1.example.com/im`` |
766 | a96ec00f | Constantinos Venetsanopoulos | |
767 | d587329c | Konstantinos Tompoulidis | If this redirects you to ``https://node1.example.com/im/`` and you can see |
768 | a96ec00f | Constantinos Venetsanopoulos | the "welcome" door of Astakos, then you have successfully setup Astakos. |
769 | a96ec00f | Constantinos Venetsanopoulos | |
770 | a96ec00f | Constantinos Venetsanopoulos | Let's create our first user. At the homepage click the "CREATE ACCOUNT" button |
771 | a96ec00f | Constantinos Venetsanopoulos | and fill all your data at the sign up form. Then click "SUBMIT". You should now |
772 | a96ec00f | Constantinos Venetsanopoulos | see a green box on the top, which informs you that you made a successful request |
773 | d587329c | Konstantinos Tompoulidis | and the request has been sent to the administrators. So far so good, let's |
774 | d587329c | Konstantinos Tompoulidis | assume that you created the user with username ``user@example.com``. |
775 | a96ec00f | Constantinos Venetsanopoulos | |
776 | a96ec00f | Constantinos Venetsanopoulos | Now we need to activate that user. Return to a command prompt at node1 and run: |
777 | a96ec00f | Constantinos Venetsanopoulos | |
778 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
779 | a96ec00f | Constantinos Venetsanopoulos | |
780 | d587329c | Konstantinos Tompoulidis | root@node1:~ # snf-manage user-list |
781 | a96ec00f | Constantinos Venetsanopoulos | |
782 | a96ec00f | Constantinos Venetsanopoulos | This command should show you a list with only one user; the one we just created. |
783 | a96ec00f | Constantinos Venetsanopoulos | This user should have an id with a value of ``1``. It should also have an |
784 | a96ec00f | Constantinos Venetsanopoulos | "active" status with the value of ``0`` (inactive). Now run: |
785 | a96ec00f | Constantinos Venetsanopoulos | |
786 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
787 | a96ec00f | Constantinos Venetsanopoulos | |
788 | d587329c | Konstantinos Tompoulidis | root@node1:~ # snf-manage user-update --set-active 1 |
789 | a96ec00f | Constantinos Venetsanopoulos | |
790 | a96ec00f | Constantinos Venetsanopoulos | This modifies the active value to ``1``, and actually activates the user. |
791 | a96ec00f | Constantinos Venetsanopoulos | When running in production, the activation is done automatically with different |
792 | a96ec00f | Constantinos Venetsanopoulos | types of moderation, that Astakos supports. You can see the moderation methods |
793 | a96ec00f | Constantinos Venetsanopoulos | (by invitation, whitelists, matching regexp, etc.) at the Astakos specific |
794 | f846d8df | Constantinos Venetsanopoulos | documentation. In production, you can also manually activate a user, by sending |
795 | f846d8df | Constantinos Venetsanopoulos | him/her an activation email. See how to do this at the :ref:`User |
796 | f846d8df | Constantinos Venetsanopoulos | activation <user_activation>` section. |
797 | a96ec00f | Constantinos Venetsanopoulos | |
798 | d587329c | Konstantinos Tompoulidis | Now let's go back to the homepage. Open ``http://node1.example.com/im/`` with |
799 | a96ec00f | Constantinos Venetsanopoulos | your browser again. Try to sign in using your new credentials. If the astakos |
800 | a96ec00f | Constantinos Venetsanopoulos | menu appears and you can see your profile, then you have successfully setup |
801 | a96ec00f | Constantinos Venetsanopoulos | Astakos. |
802 | a96ec00f | Constantinos Venetsanopoulos | |
803 | a96ec00f | Constantinos Venetsanopoulos | Let's continue to install Pithos+ now. |
804 | a96ec00f | Constantinos Venetsanopoulos | |
805 | a96ec00f | Constantinos Venetsanopoulos | |
806 | a96ec00f | Constantinos Venetsanopoulos | Installation of Pithos+ on node2 |
807 | a96ec00f | Constantinos Venetsanopoulos | ================================ |
808 | a96ec00f | Constantinos Venetsanopoulos | |
809 | 138253bc | Constantinos Venetsanopoulos | To install pithos+, grab the packages from our repository (make sure you made |
810 | a96ec00f | Constantinos Venetsanopoulos | the additions needed in your ``/etc/apt/sources.list`` file, as described |
811 | a96ec00f | Constantinos Venetsanopoulos | previously), by running: |
812 | a96ec00f | Constantinos Venetsanopoulos | |
813 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
814 | a96ec00f | Constantinos Venetsanopoulos | |
815 | d587329c | Konstantinos Tompoulidis | # apt-get install snf-pithos-app snf-pithos-backend |
816 | a96ec00f | Constantinos Venetsanopoulos | |
817 | a96ec00f | Constantinos Venetsanopoulos | After successful installation of snf-pithos-app, make sure that also |
818 | a96ec00f | Constantinos Venetsanopoulos | snf-webproject has been installed (marked as "Recommended" package). Refer to |
819 | a96ec00f | Constantinos Venetsanopoulos | the "Installation of Astakos on node1" section, if you don't remember why this |
820 | 138253bc | Constantinos Venetsanopoulos | should happen. Now, install the pithos web interface: |
821 | a96ec00f | Constantinos Venetsanopoulos | |
822 | 138253bc | Constantinos Venetsanopoulos | .. code-block:: console |
823 | 138253bc | Constantinos Venetsanopoulos | |
824 | 138253bc | Constantinos Venetsanopoulos | # apt-get install snf-pithos-webclient |
825 | 138253bc | Constantinos Venetsanopoulos | |
826 | 138253bc | Constantinos Venetsanopoulos | This package provides the standalone pithos web client. The web client is the |
827 | 138253bc | Constantinos Venetsanopoulos | web UI for pithos+ and will be accessible by clicking "pithos+" on the Astakos |
828 | 138253bc | Constantinos Venetsanopoulos | interface's cloudbar, at the top of the Astakos homepage. |
829 | a96ec00f | Constantinos Venetsanopoulos | |
830 | caa6c07d | Constantinos Venetsanopoulos | |
831 | 04c1254b | Constantinos Venetsanopoulos | .. _conf-pithos: |
832 | 04c1254b | Constantinos Venetsanopoulos | |
833 | a96ec00f | Constantinos Venetsanopoulos | Configuration of Pithos+ |
834 | a96ec00f | Constantinos Venetsanopoulos | ======================== |
835 | a96ec00f | Constantinos Venetsanopoulos | |
836 | a96ec00f | Constantinos Venetsanopoulos | Conf Files |
837 | a96ec00f | Constantinos Venetsanopoulos | ---------- |
838 | a96ec00f | Constantinos Venetsanopoulos | |
839 | a96ec00f | Constantinos Venetsanopoulos | After pithos+ is successfully installed, you will find the directory |
840 | a96ec00f | Constantinos Venetsanopoulos | ``/etc/synnefo`` and some configuration files inside it, as you did in node1 |
841 | a96ec00f | Constantinos Venetsanopoulos | after installation of astakos. Here, you will not have to change anything that |
842 | a96ec00f | Constantinos Venetsanopoulos | has to do with snf-common or snf-webproject. Everything is set at node1. You |
843 | 138253bc | Constantinos Venetsanopoulos | only need to change settings that have to do with pithos+. Specifically: |
844 | a96ec00f | Constantinos Venetsanopoulos | |
845 | a96ec00f | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-pithos-app-settings.conf``. There you need to set |
846 | 11c16930 | Ilias Tsitsimpis | this options: |
847 | a96ec00f | Constantinos Venetsanopoulos | |
848 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
849 | a96ec00f | Constantinos Venetsanopoulos | |
850 | 4ab620b6 | Christos Stavrakakis | ASTAKOS_URL = 'https://node1.example.com/' |
851 | a96ec00f | Constantinos Venetsanopoulos | |
852 | 4ab620b6 | Christos Stavrakakis | PITHOS_BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos' |
853 | a96ec00f | Constantinos Venetsanopoulos | PITHOS_BACKEND_BLOCK_PATH = '/srv/pithos/data' |
854 | bdfd94c9 | Constantinos Venetsanopoulos | |
855 | a96ec00f | Constantinos Venetsanopoulos | |
856 | 3e6d0710 | Constantinos Venetsanopoulos | PITHOS_SERVICE_TOKEN = 'pithos_service_token22w==' |
857 | d587329c | Konstantinos Tompoulidis | |
858 | d587329c | Konstantinos Tompoulidis | PITHOS_QUOTAHOLDER_URL = 'https://node1.example.com/quotaholder/v' |
859 | d587329c | Konstantinos Tompoulidis | PITHOS_QUOTAHOLDER_TOKEN = 'aExampleTokenJbFm12w' |
860 | d587329c | Konstantinos Tompoulidis | PITHOS_USE_QUOTAHOLDER = True |
861 | d587329c | Konstantinos Tompoulidis | |
862 | d587329c | Konstantinos Tompoulidis | # Set to False if astakos & pithos are on the same host |
863 | d587329c | Konstantinos Tompoulidis | #PITHOS_PROXY_USER_SERVICES = True |
864 | 02d94254 | Sofia Papagiannaki | |
865 | 3e6d0710 | Constantinos Venetsanopoulos | |
866 | bdfd94c9 | Constantinos Venetsanopoulos | The ``PITHOS_BACKEND_DB_CONNECTION`` option tells to the pithos+ app where to |
867 | bdfd94c9 | Constantinos Venetsanopoulos | find the pithos+ backend database. Above we tell pithos+ that its database is |
868 | bdfd94c9 | Constantinos Venetsanopoulos | ``snf_pithos`` at node1 and to connect as user ``synnefo`` with password |
869 | bdfd94c9 | Constantinos Venetsanopoulos | ``example_passw0rd``. All those settings where setup during node1's "Database |
870 | bdfd94c9 | Constantinos Venetsanopoulos | setup" section. |
871 | a96ec00f | Constantinos Venetsanopoulos | |
872 | bdfd94c9 | Constantinos Venetsanopoulos | The ``PITHOS_BACKEND_BLOCK_PATH`` option tells to the pithos+ app where to find |
873 | bdfd94c9 | Constantinos Venetsanopoulos | the pithos+ backend data. Above we tell pithos+ to store its data under |
874 | a96ec00f | Constantinos Venetsanopoulos | ``/srv/pithos/data``, which is visible by both nodes. We have already setup this |
875 | a96ec00f | Constantinos Venetsanopoulos | directory at node1's "Pithos+ data directory setup" section. |
876 | a96ec00f | Constantinos Venetsanopoulos | |
877 | 4ab620b6 | Christos Stavrakakis | The ``ASTAKOS_URL`` option tells to the pithos+ app in which URI |
878 | 4ab620b6 | Christos Stavrakakis | is available the astakos authentication api. |
879 | 8f85321e | Sofia Papagiannaki | |
880 | 3e6d0710 | Constantinos Venetsanopoulos | The ``PITHOS_SERVICE_TOKEN`` should be the Pithos+ token returned by running on |
881 | 3e6d0710 | Constantinos Venetsanopoulos | the Astakos node (node1 in our case): |
882 | 3e6d0710 | Constantinos Venetsanopoulos | |
883 | 3e6d0710 | Constantinos Venetsanopoulos | .. code-block:: console |
884 | 3e6d0710 | Constantinos Venetsanopoulos | |
885 | 62b10e3f | Constantinos Venetsanopoulos | # snf-manage service-list |
886 | 3e6d0710 | Constantinos Venetsanopoulos | |
887 | 3e6d0710 | Constantinos Venetsanopoulos | The token has been generated automatically during the :ref:`Pithos+ service |
888 | 3e6d0710 | Constantinos Venetsanopoulos | registration <services-reg>`. |
889 | 3e6d0710 | Constantinos Venetsanopoulos | |
890 | 138253bc | Constantinos Venetsanopoulos | Then we need to setup the web UI and connect it to astakos. To do so, edit |
891 | 138253bc | Constantinos Venetsanopoulos | ``/etc/synnefo/20-snf-pithos-webclient-settings.conf``: |
892 | 138253bc | Constantinos Venetsanopoulos | |
893 | 138253bc | Constantinos Venetsanopoulos | .. code-block:: console |
894 | 138253bc | Constantinos Venetsanopoulos | |
895 | d587329c | Konstantinos Tompoulidis | PITHOS_UI_LOGIN_URL = "https://node1.example.com/im/login?next=" |
896 | d587329c | Konstantinos Tompoulidis | PITHOS_UI_FEEDBACK_URL = "https://node2.example.com/feedback" |
897 | 138253bc | Constantinos Venetsanopoulos | |
898 | 138253bc | Constantinos Venetsanopoulos | The ``PITHOS_UI_LOGIN_URL`` option tells the client where to redirect you, if |
899 | 138253bc | Constantinos Venetsanopoulos | you are not logged in. The ``PITHOS_UI_FEEDBACK_URL`` option points at the |
900 | 138253bc | Constantinos Venetsanopoulos | pithos+ feedback form. Astakos already provides a generic feedback form for all |
901 | 138253bc | Constantinos Venetsanopoulos | services, so we use this one. |
902 | 138253bc | Constantinos Venetsanopoulos | |
903 | 591e1df0 | Sofia Papagiannaki | The ``PITHOS_UPDATE_MD5`` option by default disables the computation of the |
904 | 591e1df0 | Sofia Papagiannaki | object checksums. This results to improved performance during object uploading. |
905 | 591e1df0 | Sofia Papagiannaki | However, if compatibility with the OpenStack Object Storage API is important |
906 | 591e1df0 | Sofia Papagiannaki | then it should be changed to ``True``. |
907 | 591e1df0 | Sofia Papagiannaki | |
908 | 138253bc | Constantinos Venetsanopoulos | Then edit ``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf``, to connect the |
909 | 138253bc | Constantinos Venetsanopoulos | pithos+ web UI with the astakos web UI (through the top cloudbar): |
910 | 138253bc | Constantinos Venetsanopoulos | |
911 | 138253bc | Constantinos Venetsanopoulos | .. code-block:: console |
912 | 138253bc | Constantinos Venetsanopoulos | |
913 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
914 | d587329c | Konstantinos Tompoulidis | PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE = '3' |
915 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services' |
916 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_MENU_URL = 'https://node1.example.com/im/get_menu' |
917 | 138253bc | Constantinos Venetsanopoulos | |
918 | 138253bc | Constantinos Venetsanopoulos | The ``CLOUDBAR_LOCATION`` tells the client where to find the astakos common |
919 | 138253bc | Constantinos Venetsanopoulos | cloudbar. |
920 | 138253bc | Constantinos Venetsanopoulos | |
921 | de20a465 | Constantinos Venetsanopoulos | The ``PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE`` points to an already registered |
922 | de20a465 | Constantinos Venetsanopoulos | Astakos service. You can see all :ref:`registered services <services-reg>` by |
923 | de20a465 | Constantinos Venetsanopoulos | running on the Astakos node (node1): |
924 | de20a465 | Constantinos Venetsanopoulos | |
925 | de20a465 | Constantinos Venetsanopoulos | .. code-block:: console |
926 | de20a465 | Constantinos Venetsanopoulos | |
927 | 62b10e3f | Constantinos Venetsanopoulos | # snf-manage service-list |
928 | de20a465 | Constantinos Venetsanopoulos | |
929 | d587329c | Konstantinos Tompoulidis | The value of ``PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE`` should be the pithos |
930 | d587329c | Konstantinos Tompoulidis | service's ``id`` as shown by the above command, in our case ``3``. |
931 | 138253bc | Constantinos Venetsanopoulos | |
932 | 138253bc | Constantinos Venetsanopoulos | The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are used by the |
933 | 138253bc | Constantinos Venetsanopoulos | pithos+ web client to get from astakos all the information needed to fill its |
934 | bdfd94c9 | Constantinos Venetsanopoulos | own cloudbar. So we put our astakos deployment urls there. |
935 | 138253bc | Constantinos Venetsanopoulos | |
936 | 4e3e3d24 | Constantinos Venetsanopoulos | Pooling and Greenlets |
937 | 4e3e3d24 | Constantinos Venetsanopoulos | --------------------- |
938 | 4e3e3d24 | Constantinos Venetsanopoulos | |
939 | 4e3e3d24 | Constantinos Venetsanopoulos | Pithos is pooling-ready without the need of further configuration, because it |
940 | 4e3e3d24 | Constantinos Venetsanopoulos | doesn't use a Django DB. It pools HTTP connections to Astakos and pithos |
941 | 4e3e3d24 | Constantinos Venetsanopoulos | backend objects for access to the Pithos DB. |
942 | 4e3e3d24 | Constantinos Venetsanopoulos | |
943 | 576e059b | Constantinos Venetsanopoulos | However, as in Astakos, since we are running with Greenlets, it is also |
944 | 576e059b | Constantinos Venetsanopoulos | recommended to modify psycopg2 behavior so it works properly in a greenlet |
945 | 576e059b | Constantinos Venetsanopoulos | context. This means adding the following lines at the top of your |
946 | 4e3e3d24 | Constantinos Venetsanopoulos | ``/etc/synnefo/10-snf-webproject-database.conf`` file: |
947 | 4e3e3d24 | Constantinos Venetsanopoulos | |
948 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
949 | 4e3e3d24 | Constantinos Venetsanopoulos | |
950 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.psyco_gevent import make_psycopg_green |
951 | d587329c | Konstantinos Tompoulidis | make_psycopg_green() |
952 | d587329c | Konstantinos Tompoulidis | |
953 | d587329c | Konstantinos Tompoulidis | Furthermore, add the ``--worker-class=gevent`` (or ``--worker-class=sync`` as |
954 | d587329c | Konstantinos Tompoulidis | mentioned above, depending on your setup) argument on your |
955 | d587329c | Konstantinos Tompoulidis | ``/etc/gunicorn.d/synnefo`` configuration file. The file should look something |
956 | d587329c | Konstantinos Tompoulidis | like this: |
957 | d587329c | Konstantinos Tompoulidis | |
958 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
959 | d587329c | Konstantinos Tompoulidis | |
960 | d587329c | Konstantinos Tompoulidis | CONFIG = { |
961 | d587329c | Konstantinos Tompoulidis | 'mode': 'django', |
962 | d587329c | Konstantinos Tompoulidis | 'environment': { |
963 | d587329c | Konstantinos Tompoulidis | 'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
964 | d587329c | Konstantinos Tompoulidis | }, |
965 | d587329c | Konstantinos Tompoulidis | 'working_dir': '/etc/synnefo', |
966 | d587329c | Konstantinos Tompoulidis | 'user': 'www-data', |
967 | d587329c | Konstantinos Tompoulidis | 'group': 'www-data', |
968 | d587329c | Konstantinos Tompoulidis | 'args': ( |
969 | d587329c | Konstantinos Tompoulidis | '--bind=127.0.0.1:8080', |
970 | d587329c | Konstantinos Tompoulidis | '--workers=4', |
971 | d587329c | Konstantinos Tompoulidis | '--worker-class=gevent', |
972 | d587329c | Konstantinos Tompoulidis | '--log-level=debug', |
973 | d587329c | Konstantinos Tompoulidis | '--timeout=43200' |
974 | d587329c | Konstantinos Tompoulidis | ), |
975 | d587329c | Konstantinos Tompoulidis | } |
976 | 4e3e3d24 | Constantinos Venetsanopoulos | |
977 | c17bd3a7 | Sofia Papagiannaki | Stamp Database Revision |
978 | c17bd3a7 | Sofia Papagiannaki | ----------------------- |
979 | c17bd3a7 | Sofia Papagiannaki | |
980 | c17bd3a7 | Sofia Papagiannaki | Pithos uses the alembic_ database migrations tool. |
981 | c17bd3a7 | Sofia Papagiannaki | |
982 | c17bd3a7 | Sofia Papagiannaki | .. _alembic: http://alembic.readthedocs.org |
983 | c17bd3a7 | Sofia Papagiannaki | |
984 | a33ee5d2 | Sofia Papagiannaki | After a sucessful installation, we should stamp it at the most recent |
985 | a33ee5d2 | Sofia Papagiannaki | revision, so that future migrations know where to start upgrading in |
986 | a33ee5d2 | Sofia Papagiannaki | the migration history. |
987 | c17bd3a7 | Sofia Papagiannaki | |
988 | a33ee5d2 | Sofia Papagiannaki | First, find the most recent revision in the migration history: |
989 | c17bd3a7 | Sofia Papagiannaki | |
990 | c17bd3a7 | Sofia Papagiannaki | .. code-block:: console |
991 | c17bd3a7 | Sofia Papagiannaki | |
992 | c17bd3a7 | Sofia Papagiannaki | root@node2:~ # pithos-migrate history |
993 | c17bd3a7 | Sofia Papagiannaki | 2a309a9a3438 -> 27381099d477 (head), alter public add column url |
994 | c17bd3a7 | Sofia Papagiannaki | 165ba3fbfe53 -> 2a309a9a3438, fix statistics negative population |
995 | c17bd3a7 | Sofia Papagiannaki | 3dd56e750a3 -> 165ba3fbfe53, update account in paths |
996 | c17bd3a7 | Sofia Papagiannaki | 230f8ce9c90f -> 3dd56e750a3, Fix latest_version |
997 | c17bd3a7 | Sofia Papagiannaki | 8320b1c62d9 -> 230f8ce9c90f, alter nodes add column latest version |
998 | c17bd3a7 | Sofia Papagiannaki | None -> 8320b1c62d9, create index nodes.parent |
999 | c17bd3a7 | Sofia Papagiannaki | |
1000 | c17bd3a7 | Sofia Papagiannaki | Finally, we stamp it with the one found in the previous step: |
1001 | c17bd3a7 | Sofia Papagiannaki | |
1002 | c17bd3a7 | Sofia Papagiannaki | .. code-block:: console |
1003 | c17bd3a7 | Sofia Papagiannaki | |
1004 | c17bd3a7 | Sofia Papagiannaki | root@node2:~ # pithos-migrate stamp 27381099d477 |
1005 | c17bd3a7 | Sofia Papagiannaki | |
1006 | a96ec00f | Constantinos Venetsanopoulos | Servers Initialization |
1007 | a96ec00f | Constantinos Venetsanopoulos | ---------------------- |
1008 | a96ec00f | Constantinos Venetsanopoulos | |
1009 | a96ec00f | Constantinos Venetsanopoulos | After configuration is done, we initialize the servers on node2: |
1010 | a96ec00f | Constantinos Venetsanopoulos | |
1011 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
1012 | a96ec00f | Constantinos Venetsanopoulos | |
1013 | d587329c | Konstantinos Tompoulidis | root@node2:~ # /etc/init.d/gunicorn restart |
1014 | d587329c | Konstantinos Tompoulidis | root@node2:~ # /etc/init.d/apache2 restart |
1015 | a96ec00f | Constantinos Venetsanopoulos | |
1016 | a96ec00f | Constantinos Venetsanopoulos | You have now finished the Pithos+ setup. Let's test it now. |
1017 | a96ec00f | Constantinos Venetsanopoulos | |
1018 | a96ec00f | Constantinos Venetsanopoulos | |
1019 | a96ec00f | Constantinos Venetsanopoulos | Testing of Pithos+ |
1020 | a96ec00f | Constantinos Venetsanopoulos | ================== |
1021 | a96ec00f | Constantinos Venetsanopoulos | |
1022 | bdfd94c9 | Constantinos Venetsanopoulos | Open your browser and go to the Astakos homepage: |
1023 | bdfd94c9 | Constantinos Venetsanopoulos | |
1024 | bdfd94c9 | Constantinos Venetsanopoulos | ``http://node1.example.com/im`` |
1025 | bdfd94c9 | Constantinos Venetsanopoulos | |
1026 | bdfd94c9 | Constantinos Venetsanopoulos | Login, and you will see your profile page. Now, click the "pithos+" link on the |
1027 | bdfd94c9 | Constantinos Venetsanopoulos | top black cloudbar. If everything was setup correctly, this will redirect you |
1028 | bdfd94c9 | Constantinos Venetsanopoulos | to: |
1029 | bdfd94c9 | Constantinos Venetsanopoulos | |
1030 | bdfd94c9 | Constantinos Venetsanopoulos | |
1031 | bdfd94c9 | Constantinos Venetsanopoulos | and you will see the blue interface of the Pithos+ application. Click the |
1032 | bdfd94c9 | Constantinos Venetsanopoulos | orange "Upload" button and upload your first file. If the file gets uploaded |
1033 | bdfd94c9 | Constantinos Venetsanopoulos | successfully, then this is your first sign of a successful Pithos+ installation. |
1034 | bdfd94c9 | Constantinos Venetsanopoulos | Go ahead and experiment with the interface to make sure everything works |
1035 | bdfd94c9 | Constantinos Venetsanopoulos | correctly. |
1036 | bdfd94c9 | Constantinos Venetsanopoulos | |
1037 | bdfd94c9 | Constantinos Venetsanopoulos | You can also use the Pithos+ clients to sync data from your Windows PC or MAC. |
1038 | bdfd94c9 | Constantinos Venetsanopoulos | |
1039 | bdfd94c9 | Constantinos Venetsanopoulos | If you don't stumble on any problems, then you have successfully installed |
1040 | bdfd94c9 | Constantinos Venetsanopoulos | Pithos+, which you can use as a standalone File Storage Service. |
1041 | bdfd94c9 | Constantinos Venetsanopoulos | |
1042 | bdfd94c9 | Constantinos Venetsanopoulos | If you would like to do more, such as: |
1043 | bdfd94c9 | Constantinos Venetsanopoulos | |
1044 | d587329c | Konstantinos Tompoulidis | * Spawning VMs |
1045 | d587329c | Konstantinos Tompoulidis | * Spawning VMs from Images stored on Pithos+ |
1046 | d587329c | Konstantinos Tompoulidis | * Uploading your custom Images to Pithos+ |
1047 | d587329c | Konstantinos Tompoulidis | * Spawning VMs from those custom Images |
1048 | d587329c | Konstantinos Tompoulidis | * Registering existing Pithos+ files as Images |
1049 | d587329c | Konstantinos Tompoulidis | * Connect VMs to the Internet |
1050 | d587329c | Konstantinos Tompoulidis | * Create Private Networks |
1051 | d587329c | Konstantinos Tompoulidis | * Add VMs to Private Networks |
1052 | bdfd94c9 | Constantinos Venetsanopoulos | |
1053 | bdfd94c9 | Constantinos Venetsanopoulos | please continue with the rest of the guide. |
1054 | a96ec00f | Constantinos Venetsanopoulos | |
1055 | caa6c07d | Constantinos Venetsanopoulos | |
1056 | 7a8df455 | Constantinos Venetsanopoulos | Cyclades (and Plankton) Prerequisites |
1057 | 7a8df455 | Constantinos Venetsanopoulos | ===================================== |
1058 | bc055d09 | Constantinos Venetsanopoulos | |
1059 | caa6c07d | Constantinos Venetsanopoulos | Before proceeding with the Cyclades (and Plankton) installation, make sure you |
1060 | caa6c07d | Constantinos Venetsanopoulos | have successfully set up Astakos and Pithos+ first, because Cyclades depends |
1061 | caa6c07d | Constantinos Venetsanopoulos | on them. If you don't have a working Astakos and Pithos+ installation yet, |
1062 | caa6c07d | Constantinos Venetsanopoulos | please return to the :ref:`top <quick-install-admin-guide>` of this guide. |
1063 | bc055d09 | Constantinos Venetsanopoulos | |
1064 | caa6c07d | Constantinos Venetsanopoulos | Besides Astakos and Pithos+, you will also need a number of additional working |
1065 | caa6c07d | Constantinos Venetsanopoulos | prerequisites, before you start the Cyclades installation. |
1066 | bc055d09 | Constantinos Venetsanopoulos | |
1067 | caa6c07d | Constantinos Venetsanopoulos | Ganeti |
1068 | 7a8df455 | Constantinos Venetsanopoulos | ------ |
1069 | bc055d09 | Constantinos Venetsanopoulos | |
1070 | caa6c07d | Constantinos Venetsanopoulos | `Ganeti <http://code.google.com/p/ganeti/>`_ handles the low level VM management |
1071 | caa6c07d | Constantinos Venetsanopoulos | for Cyclades, so Cyclades requires a working Ganeti installation at the backend. |
1072 | caa6c07d | Constantinos Venetsanopoulos | Please refer to the |
1073 | caa6c07d | Constantinos Venetsanopoulos | `ganeti documentation <http://docs.ganeti.org/ganeti/2.5/html>`_ for all the |
1074 | bc055d09 | Constantinos Venetsanopoulos | gory details. A successful Ganeti installation concludes with a working |
1075 | caa6c07d | Constantinos Venetsanopoulos | :ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs |
1076 | caa6c07d | Constantinos Venetsanopoulos | <GANETI_NODES>`. |
1077 | caa6c07d | Constantinos Venetsanopoulos | |
1078 | caa6c07d | Constantinos Venetsanopoulos | The above Ganeti cluster can run on different physical machines than node1 and |
1079 | caa6c07d | Constantinos Venetsanopoulos | node2 and can scale independently, according to your needs. |
1080 | caa6c07d | Constantinos Venetsanopoulos | |
1081 | caa6c07d | Constantinos Venetsanopoulos | For the purpose of this guide, we will assume that the :ref:`GANETI-MASTER |
1082 | caa6c07d | Constantinos Venetsanopoulos | <GANETI_NODES>` runs on node1 and is VM-capable. Also, node2 is a |
1083 | caa6c07d | Constantinos Venetsanopoulos | :ref:`GANETI-NODE <GANETI_NODES>` and is Master-capable and VM-capable too. |
1084 | caa6c07d | Constantinos Venetsanopoulos | |
1085 | caa6c07d | Constantinos Venetsanopoulos | We highly recommend that you read the official Ganeti documentation, if you are |
1086 | 576e059b | Constantinos Venetsanopoulos | not familiar with Ganeti. |
1087 | f1f5235e | Dimitris Aragiorgis | |
1088 | 576e059b | Constantinos Venetsanopoulos | Unfortunatelly, the current stable version of the stock Ganeti (v2.6.2) doesn't |
1089 | 576e059b | Constantinos Venetsanopoulos | support IP pool management. This feature will be available in Ganeti >= 2.7. |
1090 | 576e059b | Constantinos Venetsanopoulos | Synnefo depends on the IP pool functionality of Ganeti, so you have to use |
1091 | 576e059b | Constantinos Venetsanopoulos | GRNET provided packages until stable 2.7 is out. To do so: |
1092 | f1f5235e | Dimitris Aragiorgis | |
1093 | f1f5235e | Dimitris Aragiorgis | .. code-block:: console |
1094 | f1f5235e | Dimitris Aragiorgis | |
1095 | 576e059b | Constantinos Venetsanopoulos | # apt-get install snf-ganeti ganeti-htools |
1096 | d587329c | Konstantinos Tompoulidis | # rmmod -f drbd && modprobe drbd minor_count=255 usermode_helper=/bin/true |
1097 | cc16407a | Dimitris Aragiorgis | |
1098 | 576e059b | Constantinos Venetsanopoulos | You should have: |
1099 | cc16407a | Dimitris Aragiorgis | |
1100 | 576e059b | Constantinos Venetsanopoulos | Ganeti >= 2.6.2+ippool11+hotplug5+extstorage3+rdbfix1+kvmfix2-1 |
1101 | caa6c07d | Constantinos Venetsanopoulos | |
1102 | caa6c07d | Constantinos Venetsanopoulos | We assume that Ganeti will use the KVM hypervisor. After installing Ganeti on |
1103 | 92e4d1c6 | Dimitris Aragiorgis | both nodes, choose a domain name that resolves to a valid floating IP (let's |
1104 | 92e4d1c6 | Dimitris Aragiorgis | say it's ``ganeti.node1.example.com``). Make sure node1 and node2 have same |
1105 | 92e4d1c6 | Dimitris Aragiorgis | dsa/rsa keys and authorised_keys for password-less root ssh between each other. |
1106 | 92e4d1c6 | Dimitris Aragiorgis | If not then skip passing --no-ssh-init but be aware that it will replace |
1107 | 92e4d1c6 | Dimitris Aragiorgis | /root/.ssh/* related files and you might lose access to master node. Also, |
1108 | 92e4d1c6 | Dimitris Aragiorgis | make sure there is an lvm volume group named ``ganeti`` that will host your |
1109 | 92e4d1c6 | Dimitris Aragiorgis | VMs' disks. Finally, setup a bridge interface on the host machines (e.g: br0). |
1110 | 92e4d1c6 | Dimitris Aragiorgis | Then run on node1: |
1111 | caa6c07d | Constantinos Venetsanopoulos | |
1112 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1113 | caa6c07d | Constantinos Venetsanopoulos | |
1114 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster init --enabled-hypervisors=kvm --no-ssh-init \ |
1115 | d587329c | Konstantinos Tompoulidis | --no-etc-hosts --vg-name=ganeti --nic-parameters link=br0 \ |
1116 | d587329c | Konstantinos Tompoulidis | --master-netdev eth0 ganeti.node1.example.com |
1117 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --default-iallocator hail |
1118 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:kernel_path= |
1119 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:vnc_bind_address=0.0.0.0 |
1120 | caa6c07d | Constantinos Venetsanopoulos | |
1121 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-node add --no-ssh-key-check --master-capable=yes \ |
1122 | d587329c | Konstantinos Tompoulidis | --vm-capable=yes node2.example.com |
1123 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --disk-parameters=drbd:metavg=ganeti |
1124 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-group modify --disk-parameters=drbd:metavg=ganeti default |
1125 | caa6c07d | Constantinos Venetsanopoulos | |
1126 | caa6c07d | Constantinos Venetsanopoulos | For any problems you may stumble upon installing Ganeti, please refer to the |
1127 | caa6c07d | Constantinos Venetsanopoulos | `official documentation <http://docs.ganeti.org/ganeti/2.5/html>`_. Installation |
1128 | caa6c07d | Constantinos Venetsanopoulos | of Ganeti is out of the scope of this guide. |
1129 | caa6c07d | Constantinos Venetsanopoulos | |
1130 | caa6c07d | Constantinos Venetsanopoulos | .. _cyclades-install-snfimage: |
1131 | caa6c07d | Constantinos Venetsanopoulos | |
1132 | caa6c07d | Constantinos Venetsanopoulos | snf-image |
1133 | 7a8df455 | Constantinos Venetsanopoulos | --------- |
1134 | caa6c07d | Constantinos Venetsanopoulos | |
1135 | caa6c07d | Constantinos Venetsanopoulos | Installation |
1136 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~ |
1137 | caa6c07d | Constantinos Venetsanopoulos | For :ref:`Cyclades <cyclades>` to be able to launch VMs from specified Images, |
1138 | caa6c07d | Constantinos Venetsanopoulos | you need the :ref:`snf-image <snf-image>` OS Definition installed on *all* |
1139 | caa6c07d | Constantinos Venetsanopoulos | VM-capable Ganeti nodes. This means we need :ref:`snf-image <snf-image>` on |
1140 | caa6c07d | Constantinos Venetsanopoulos | node1 and node2. You can do this by running on *both* nodes: |
1141 | caa6c07d | Constantinos Venetsanopoulos | |
1142 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1143 | caa6c07d | Constantinos Venetsanopoulos | |
1144 | d587329c | Konstantinos Tompoulidis | # apt-get install snf-image snf-pithos-backend python-psycopg2 |
1145 | 1a37da56 | Constantinos Venetsanopoulos | |
1146 | d587329c | Konstantinos Tompoulidis | snf-image also needs the `snf-pithos-backend <snf-pithos-backend>`, to be able |
1147 | d587329c | Konstantinos Tompoulidis | to handle image files stored on Pithos+. It also needs `python-psycopg2` to be |
1148 | d587329c | Konstantinos Tompoulidis | able to access the Pithos+ database. This is why, we also install them on *all* |
1149 | 1a37da56 | Constantinos Venetsanopoulos | VM-capable Ganeti nodes. |
1150 | caa6c07d | Constantinos Venetsanopoulos | |
1151 | d587329c | Konstantinos Tompoulidis | .. warning:: snf-image uses ``curl`` for handling URLs. This means that it will |
1152 | d587329c | Konstantinos Tompoulidis | not work out of the box if you try to use URLs served by servers which do |
1153 | d587329c | Konstantinos Tompoulidis | not have a valid certificate. To circumvent this you should edit the file |
1154 | d587329c | Konstantinos Tompoulidis | ``/etc/default/snf-image``. Change ``#CURL="curl"`` to ``CURL="curl -k"``. |
1155 | d587329c | Konstantinos Tompoulidis | |
1156 | d587329c | Konstantinos Tompoulidis | After `snf-image` has been installed successfully, create the helper VM by |
1157 | caa6c07d | Constantinos Venetsanopoulos | running on *both* nodes: |
1158 | caa6c07d | Constantinos Venetsanopoulos | |
1159 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1160 | caa6c07d | Constantinos Venetsanopoulos | |
1161 | caa6c07d | Constantinos Venetsanopoulos | # snf-image-update-helper |
1162 | caa6c07d | Constantinos Venetsanopoulos | |
1163 | caa6c07d | Constantinos Venetsanopoulos | This will create all the needed files under ``/var/lib/snf-image/helper/`` for |
1164 | d587329c | Konstantinos Tompoulidis | snf-image to run successfully, and it may take a few minutes depending on your |
1165 | d587329c | Konstantinos Tompoulidis | Internet connection. |
1166 | caa6c07d | Constantinos Venetsanopoulos | |
1167 | caa6c07d | Constantinos Venetsanopoulos | Configuration |
1168 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~ |
1169 | caa6c07d | Constantinos Venetsanopoulos | snf-image supports native access to Images stored on Pithos+. This means that |
1170 | d587329c | Konstantinos Tompoulidis | it can talk directly to the Pithos+ backend, without the need of providing a |
1171 | d587329c | Konstantinos Tompoulidis | public URL. More details, are described in the next section. For now, the only |
1172 | caa6c07d | Constantinos Venetsanopoulos | thing we need to do, is configure snf-image to access our Pithos+ backend. |
1173 | caa6c07d | Constantinos Venetsanopoulos | |
1174 | caa6c07d | Constantinos Venetsanopoulos | To do this, we need to set the corresponding variables in |
1175 | caa6c07d | Constantinos Venetsanopoulos | ``/etc/default/snf-image``, to reflect our Pithos+ setup: |
1176 | caa6c07d | Constantinos Venetsanopoulos | |
1177 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1178 | caa6c07d | Constantinos Venetsanopoulos | |
1179 | d587329c | Konstantinos Tompoulidis | PITHOS_DB="postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos" |
1180 | caa6c07d | Constantinos Venetsanopoulos | |
1181 | d587329c | Konstantinos Tompoulidis | PITHOS_DATA="/srv/pithos/data" |
1182 | caa6c07d | Constantinos Venetsanopoulos | |
1183 | d587329c | Konstantinos Tompoulidis | If you have installed your Ganeti cluster on different nodes than node1 and |
1184 | d587329c | Konstantinos Tompoulidis | node2 make sure that ``/srv/pithos/data`` is visible by all of them. |
1185 | caa6c07d | Constantinos Venetsanopoulos | |
1186 | caa6c07d | Constantinos Venetsanopoulos | If you would like to use Images that are also/only stored locally, you need to |
1187 | caa6c07d | Constantinos Venetsanopoulos | save them under ``IMAGE_DIR``, however this guide targets Images stored only on |
1188 | caa6c07d | Constantinos Venetsanopoulos | Pithos+. |
1189 | caa6c07d | Constantinos Venetsanopoulos | |
1190 | caa6c07d | Constantinos Venetsanopoulos | Testing |
1191 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~ |
1192 | caa6c07d | Constantinos Venetsanopoulos | You can test that snf-image is successfully installed by running on the |
1193 | caa6c07d | Constantinos Venetsanopoulos | :ref:`GANETI-MASTER <GANETI_NODES>` (in our case node1): |
1194 | caa6c07d | Constantinos Venetsanopoulos | |
1195 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1196 | caa6c07d | Constantinos Venetsanopoulos | |
1197 | caa6c07d | Constantinos Venetsanopoulos | # gnt-os diagnose |
1198 | caa6c07d | Constantinos Venetsanopoulos | |
1199 | caa6c07d | Constantinos Venetsanopoulos | This should return ``valid`` for snf-image. |
1200 | caa6c07d | Constantinos Venetsanopoulos | |
1201 | caa6c07d | Constantinos Venetsanopoulos | If you are interested to learn more about snf-image's internals (and even use |
1202 | caa6c07d | Constantinos Venetsanopoulos | it alongside Ganeti without Synnefo), please see |
1203 | d587329c | Konstantinos Tompoulidis | `here <https://code.grnet.gr/projects/snf-image/wiki>`_ for information |
1204 | d587329c | Konstantinos Tompoulidis | concerning installation instructions, documentation on the design and |
1205 | d587329c | Konstantinos Tompoulidis | implementation, and supported Image formats. |
1206 | caa6c07d | Constantinos Venetsanopoulos | |
1207 | 8a4cd31b | Constantinos Venetsanopoulos | .. _snf-image-images: |
1208 | 8a4cd31b | Constantinos Venetsanopoulos | |
1209 | cd837dad | Constantinos Venetsanopoulos | Actual Images for snf-image |
1210 | cd837dad | Constantinos Venetsanopoulos | --------------------------- |
1211 | caa6c07d | Constantinos Venetsanopoulos | |
1212 | caa6c07d | Constantinos Venetsanopoulos | Now that snf-image is installed successfully we need to provide it with some |
1213 | caa6c07d | Constantinos Venetsanopoulos | Images. :ref:`snf-image <snf-image>` supports Images stored in ``extdump``, |
1214 | caa6c07d | Constantinos Venetsanopoulos | ``ntfsdump`` or ``diskdump`` format. We recommend the use of the ``diskdump`` |
1215 | cd837dad | Constantinos Venetsanopoulos | format. For more information about snf-image Image formats see `here |
1216 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki/Image_Format>`_. |
1217 | caa6c07d | Constantinos Venetsanopoulos | |
1218 | caa6c07d | Constantinos Venetsanopoulos | :ref:`snf-image <snf-image>` also supports three (3) different locations for the |
1219 | caa6c07d | Constantinos Venetsanopoulos | above Images to be stored: |
1220 | caa6c07d | Constantinos Venetsanopoulos | |
1221 | d587329c | Konstantinos Tompoulidis | * Under a local folder (usually an NFS mount, configurable as ``IMAGE_DIR`` |
1222 | d587329c | Konstantinos Tompoulidis | in :file:`/etc/default/snf-image`) |
1223 | d587329c | Konstantinos Tompoulidis | * On a remote host (accessible via public URL e.g: http://... or ftp://...) |
1224 | d587329c | Konstantinos Tompoulidis | * On Pithos+ (accessible natively, not only by its public URL) |
1225 | caa6c07d | Constantinos Venetsanopoulos | |
1226 | d587329c | Konstantinos Tompoulidis | For the purpose of this guide, we will use the Debian Squeeze Base Image found |
1227 | d587329c | Konstantinos Tompoulidis | on the official `snf-image page |
1228 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_. The image is |
1229 | caa6c07d | Constantinos Venetsanopoulos | of type ``diskdump``. We will store it in our new Pithos+ installation. |
1230 | caa6c07d | Constantinos Venetsanopoulos | |
1231 | caa6c07d | Constantinos Venetsanopoulos | To do so, do the following: |
1232 | caa6c07d | Constantinos Venetsanopoulos | |
1233 | d587329c | Konstantinos Tompoulidis | a) Download the Image from the official snf-image page. |
1234 | caa6c07d | Constantinos Venetsanopoulos | |
1235 | d587329c | Konstantinos Tompoulidis | b) Upload the Image to your Pithos+ installation, either using the Pithos+ Web |
1236 | d587329c | Konstantinos Tompoulidis | UI or the command line client `kamaki |
1237 | 34e79416 | Constantinos Venetsanopoulos | <http://www.synnefo.org/docs/kamaki/latest/index.html>`_. |
1238 | caa6c07d | Constantinos Venetsanopoulos | |
1239 | caa6c07d | Constantinos Venetsanopoulos | Once the Image is uploaded successfully, download the Image's metadata file |
1240 | d587329c | Konstantinos Tompoulidis | from the official snf-image page. You will need it, for spawning a VM from |
1241 | d587329c | Konstantinos Tompoulidis | Ganeti, in the next section. |
1242 | caa6c07d | Constantinos Venetsanopoulos | |
1243 | d587329c | Konstantinos Tompoulidis | Of course, you can repeat the procedure to upload more Images, available from |
1244 | d587329c | Konstantinos Tompoulidis | the `official snf-image page |
1245 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_. |
1246 | caa6c07d | Constantinos Venetsanopoulos | |
1247 | 8a4cd31b | Constantinos Venetsanopoulos | .. _ganeti-with-pithos-images: |
1248 | 8a4cd31b | Constantinos Venetsanopoulos | |
1249 | caa6c07d | Constantinos Venetsanopoulos | Spawning a VM from a Pithos+ Image, using Ganeti |
1250 | 7a8df455 | Constantinos Venetsanopoulos | ------------------------------------------------ |
1251 | caa6c07d | Constantinos Venetsanopoulos | |
1252 | caa6c07d | Constantinos Venetsanopoulos | Now, it is time to test our installation so far. So, we have Astakos and |
1253 | caa6c07d | Constantinos Venetsanopoulos | Pithos+ installed, we have a working Ganeti installation, the snf-image |
1254 | caa6c07d | Constantinos Venetsanopoulos | definition installed on all VM-capable nodes and a Debian Squeeze Image on |
1255 | caa6c07d | Constantinos Venetsanopoulos | Pithos+. Make sure you also have the `metadata file |
1256 | caa6c07d | Constantinos Venetsanopoulos | <https://pithos.okeanos.grnet.gr/public/gwqcv>`_ for this image. |
1257 | caa6c07d | Constantinos Venetsanopoulos | |
1258 | caa6c07d | Constantinos Venetsanopoulos | Run on the :ref:`GANETI-MASTER's <GANETI_NODES>` (node1) command line: |
1259 | caa6c07d | Constantinos Venetsanopoulos | |
1260 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1261 | caa6c07d | Constantinos Venetsanopoulos | |
1262 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1263 | d587329c | Konstantinos Tompoulidis | img_passwd=my_vm_example_passw0rd,img_format=diskdump,img_id="pithos://UUID/pithos/debian_base-6.0-7-x86_64.diskdump",img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' \ |
1264 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1265 | caa6c07d | Constantinos Venetsanopoulos | testvm1 |
1266 | caa6c07d | Constantinos Venetsanopoulos | |
1267 | caa6c07d | Constantinos Venetsanopoulos | In the above command: |
1268 | caa6c07d | Constantinos Venetsanopoulos | |
1269 | caa6c07d | Constantinos Venetsanopoulos | * ``img_passwd``: the arbitrary root password of your new instance |
1270 | caa6c07d | Constantinos Venetsanopoulos | * ``img_format``: set to ``diskdump`` to reflect the type of the uploaded Image |
1271 | caa6c07d | Constantinos Venetsanopoulos | * ``img_id``: If you want to deploy an Image stored on Pithos+ (our case), this |
1272 | d587329c | Konstantinos Tompoulidis | should have the format ``pithos://<UUID>/<container>/<filename>``: |
1273 | 301294a9 | Constantinos Venetsanopoulos | * ``username``: ``user@example.com`` (defined during Astakos sign up) |
1274 | 301294a9 | Constantinos Venetsanopoulos | * ``container``: ``pithos`` (default, if the Web UI was used) |
1275 | 301294a9 | Constantinos Venetsanopoulos | * ``filename``: the name of file (visible also from the Web UI) |
1276 | caa6c07d | Constantinos Venetsanopoulos | * ``img_properties``: taken from the metadata file. Used only the two mandatory |
1277 | caa6c07d | Constantinos Venetsanopoulos | properties ``OSFAMILY`` and ``ROOT_PARTITION``. `Learn more |
1278 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki/Image_Format#Image-Properties>`_ |
1279 | caa6c07d | Constantinos Venetsanopoulos | |
1280 | caa6c07d | Constantinos Venetsanopoulos | If the ``gnt-instance add`` command returns successfully, then run: |
1281 | caa6c07d | Constantinos Venetsanopoulos | |
1282 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1283 | caa6c07d | Constantinos Venetsanopoulos | |
1284 | caa6c07d | Constantinos Venetsanopoulos | # gnt-instance info testvm1 | grep "console connection" |
1285 | caa6c07d | Constantinos Venetsanopoulos | |
1286 | caa6c07d | Constantinos Venetsanopoulos | to find out where to connect using VNC. If you can connect successfully and can |
1287 | caa6c07d | Constantinos Venetsanopoulos | login to your new instance using the root password ``my_vm_example_passw0rd``, |
1288 | caa6c07d | Constantinos Venetsanopoulos | then everything works as expected and you have your new Debian Base VM up and |
1289 | caa6c07d | Constantinos Venetsanopoulos | running. |
1290 | caa6c07d | Constantinos Venetsanopoulos | |
1291 | caa6c07d | Constantinos Venetsanopoulos | If ``gnt-instance add`` fails, make sure that snf-image is correctly configured |
1292 | d587329c | Konstantinos Tompoulidis | to access the Pithos+ database and the Pithos+ backend data (newer versions |
1293 | d587329c | Konstantinos Tompoulidis | require UUID instead of a username). Another issue you may encounter is that in |
1294 | d587329c | Konstantinos Tompoulidis | relatively slow setups, you may need to raise the default HELPER_*_TIMEOUTS in |
1295 | d587329c | Konstantinos Tompoulidis | /etc/default/snf-image. Also, make sure you gave the correct ``img_id`` and |
1296 | d587329c | Konstantinos Tompoulidis | ``img_properties``. If ``gnt-instance add`` succeeds but you cannot connect, |
1297 | d587329c | Konstantinos Tompoulidis | again find out what went wrong. Do *NOT* proceed to the next steps unless you |
1298 | d587329c | Konstantinos Tompoulidis | are sure everything works till this point. |
1299 | caa6c07d | Constantinos Venetsanopoulos | |
1300 | 2f6143c9 | Constantinos Venetsanopoulos | If everything works, you have successfully connected Ganeti with Pithos+. Let's |
1301 | 2f6143c9 | Constantinos Venetsanopoulos | move on to networking now. |
1302 | caa6c07d | Constantinos Venetsanopoulos | |
1303 | 2f6143c9 | Constantinos Venetsanopoulos | .. warning:: |
1304 | e4404297 | Christos Stavrakakis | |
1305 | 7a8df455 | Constantinos Venetsanopoulos | You can bypass the networking sections and go straight to |
1306 | 2c85833e | Constantinos Venetsanopoulos | :ref:`Cyclades Ganeti tools <cyclades-gtools>`, if you do not want to setup |
1307 | 2c85833e | Constantinos Venetsanopoulos | the Cyclades Network Service, but only the Cyclades Compute Service |
1308 | 2c85833e | Constantinos Venetsanopoulos | (recommended for now). |
1309 | 2f6143c9 | Constantinos Venetsanopoulos | |
1310 | cc16407a | Dimitris Aragiorgis | Networking Setup Overview |
1311 | cc16407a | Dimitris Aragiorgis | ------------------------- |
1312 | 2f6143c9 | Constantinos Venetsanopoulos | |
1313 | 2f6143c9 | Constantinos Venetsanopoulos | This part is deployment-specific and must be customized based on the specific |
1314 | 2f6143c9 | Constantinos Venetsanopoulos | needs of the system administrator. However, to do so, the administrator needs |
1315 | 2f6143c9 | Constantinos Venetsanopoulos | to understand how each level handles Virtual Networks, to be able to setup the |
1316 | b11446c1 | Constantinos Venetsanopoulos | backend appropriately, before installing Cyclades. To do so, please read the |
1317 | b11446c1 | Constantinos Venetsanopoulos | :ref:`Network <networks>` section before proceeding. |
1318 | 2f6143c9 | Constantinos Venetsanopoulos | |
1319 | cc16407a | Dimitris Aragiorgis | Since synnefo 0.11 all network actions are managed with the snf-manage |
1320 | cc16407a | Dimitris Aragiorgis | network-* commands. This needs the underlying setup (Ganeti, nfdhcpd, |
1321 | cc16407a | Dimitris Aragiorgis | snf-network, bridges, vlans) to be already configured correctly. The only |
1322 | cc16407a | Dimitris Aragiorgis | actions needed in this point are: |
1323 | cc16407a | Dimitris Aragiorgis | |
1324 | cc16407a | Dimitris Aragiorgis | a) Have Ganeti with IP pool management support installed. |
1325 | 2f6143c9 | Constantinos Venetsanopoulos | |
1326 | cc16407a | Dimitris Aragiorgis | b) Install :ref:`snf-network <snf-network>`, which provides a synnefo specific kvm-ifup script, etc. |
1327 | 2f6143c9 | Constantinos Venetsanopoulos | |
1328 | cc16407a | Dimitris Aragiorgis | c) Install :ref:`nfdhcpd <nfdhcpd>`, which serves DHCP requests of the VMs. |
1329 | 2f6143c9 | Constantinos Venetsanopoulos | |
1330 | cc16407a | Dimitris Aragiorgis | In order to test that everything is setup correctly before installing Cyclades, |
1331 | cc16407a | Dimitris Aragiorgis | we will make some testing actions in this section, and the actual setup will be |
1332 | cc16407a | Dimitris Aragiorgis | done afterwards with snf-manage commands. |
1333 | 2f6143c9 | Constantinos Venetsanopoulos | |
1334 | cc16407a | Dimitris Aragiorgis | .. _snf-network: |
1335 | 2f6143c9 | Constantinos Venetsanopoulos | |
1336 | cc16407a | Dimitris Aragiorgis | snf-network |
1337 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~ |
1338 | 2f6143c9 | Constantinos Venetsanopoulos | |
1339 | cc16407a | Dimitris Aragiorgis | snf-network includes `kvm-vif-bridge` script that is invoked every time |
1340 | cc16407a | Dimitris Aragiorgis | a tap (a VM's NIC) is created. Based on environment variables passed by |
1341 | cc16407a | Dimitris Aragiorgis | Ganeti it issues various commands depending on the network type the NIC is |
1342 | cc16407a | Dimitris Aragiorgis | connected to and sets up a corresponding dhcp lease. |
1343 | 2f6143c9 | Constantinos Venetsanopoulos | |
1344 | cc16407a | Dimitris Aragiorgis | Install snf-network on all Ganeti nodes: |
1345 | 2f6143c9 | Constantinos Venetsanopoulos | |
1346 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1347 | 2f6143c9 | Constantinos Venetsanopoulos | |
1348 | cc16407a | Dimitris Aragiorgis | # apt-get install snf-network |
1349 | 2f6143c9 | Constantinos Venetsanopoulos | |
1350 | cc16407a | Dimitris Aragiorgis | Then, in :file:`/etc/default/snf-network` set: |
1351 | 2f6143c9 | Constantinos Venetsanopoulos | |
1352 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1353 | 2f6143c9 | Constantinos Venetsanopoulos | |
1354 | cc16407a | Dimitris Aragiorgis | MAC_MASK=ff:ff:f0:00:00:00 |
1355 | 2f6143c9 | Constantinos Venetsanopoulos | |
1356 | cc16407a | Dimitris Aragiorgis | .. _nfdhcpd: |
1357 | 2f6143c9 | Constantinos Venetsanopoulos | |
1358 | cc16407a | Dimitris Aragiorgis | nfdhcpd |
1359 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~ |
1360 | 2f6143c9 | Constantinos Venetsanopoulos | |
1361 | cc16407a | Dimitris Aragiorgis | Each NIC's IP is chosen by Ganeti (with IP pool management support). |
1362 | cc16407a | Dimitris Aragiorgis | `kvm-vif-bridge` script sets up dhcp leases and when the VM boots and |
1363 | cc16407a | Dimitris Aragiorgis | makes a dhcp request, iptables will mangle the packet and `nfdhcpd` will |
1364 | cc16407a | Dimitris Aragiorgis | create a dhcp response. |
1365 | 2f6143c9 | Constantinos Venetsanopoulos | |
1366 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1367 | 2f6143c9 | Constantinos Venetsanopoulos | |
1368 | cc16407a | Dimitris Aragiorgis | # apt-get install nfqueue-bindings-python=0.3+physindev-1 |
1369 | 2f6143c9 | Constantinos Venetsanopoulos | # apt-get install nfdhcpd |
1370 | 2f6143c9 | Constantinos Venetsanopoulos | |
1371 | 2f6143c9 | Constantinos Venetsanopoulos | Edit ``/etc/nfdhcpd/nfdhcpd.conf`` to reflect your network configuration. At |
1372 | 2f6143c9 | Constantinos Venetsanopoulos | least, set the ``dhcp_queue`` variable to ``42`` and the ``nameservers`` |
1373 | 2f6143c9 | Constantinos Venetsanopoulos | variable to your DNS IP/s. Those IPs will be passed as the DNS IP/s of your new |
1374 | 2f6143c9 | Constantinos Venetsanopoulos | VMs. Once you are finished, restart the server on all nodes: |
1375 | 2f6143c9 | Constantinos Venetsanopoulos | |
1376 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1377 | 2f6143c9 | Constantinos Venetsanopoulos | |
1378 | 2f6143c9 | Constantinos Venetsanopoulos | # /etc/init.d/nfdhcpd restart |
1379 | 2f6143c9 | Constantinos Venetsanopoulos | |
1380 | 2f6143c9 | Constantinos Venetsanopoulos | If you are using ``ferm``, then you need to run the following: |
1381 | 2f6143c9 | Constantinos Venetsanopoulos | |
1382 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1383 | 2f6143c9 | Constantinos Venetsanopoulos | |
1384 | 2f6143c9 | Constantinos Venetsanopoulos | # echo "@include 'nfdhcpd.ferm';" >> /etc/ferm/ferm.conf |
1385 | 2f6143c9 | Constantinos Venetsanopoulos | # /etc/init.d/ferm restart |
1386 | 2f6143c9 | Constantinos Venetsanopoulos | |
1387 | cc16407a | Dimitris Aragiorgis | or make sure to run after boot: |
1388 | cc16407a | Dimitris Aragiorgis | |
1389 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1390 | cc16407a | Dimitris Aragiorgis | |
1391 | cc16407a | Dimitris Aragiorgis | # iptables -t mangle -A PREROUTING -p udp -m udp --dport 67 -j NFQUEUE --queue-num 42 |
1392 | cc16407a | Dimitris Aragiorgis | |
1393 | cc16407a | Dimitris Aragiorgis | and if you have IPv6 enabled: |
1394 | cc16407a | Dimitris Aragiorgis | |
1395 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1396 | cc16407a | Dimitris Aragiorgis | |
1397 | cc16407a | Dimitris Aragiorgis | # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 133 -j NFQUEUE --queue-num 43 |
1398 | cc16407a | Dimitris Aragiorgis | # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 135 -j NFQUEUE --queue-num 44 |
1399 | cc16407a | Dimitris Aragiorgis | |
1400 | cc16407a | Dimitris Aragiorgis | You can check which clients are currently served by nfdhcpd by running: |
1401 | cc16407a | Dimitris Aragiorgis | |
1402 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1403 | cc16407a | Dimitris Aragiorgis | |
1404 | cc16407a | Dimitris Aragiorgis | # kill -SIGUSR1 `cat /var/run/nfdhcpd/nfdhcpd.pid` |
1405 | cc16407a | Dimitris Aragiorgis | |
1406 | cc16407a | Dimitris Aragiorgis | When you run the above, then check ``/var/log/nfdhcpd/nfdhcpd.log``. |
1407 | cc16407a | Dimitris Aragiorgis | |
1408 | cc16407a | Dimitris Aragiorgis | Public Network Setup |
1409 | cc16407a | Dimitris Aragiorgis | -------------------- |
1410 | cc16407a | Dimitris Aragiorgis | |
1411 | cc16407a | Dimitris Aragiorgis | To achieve basic networking the simplest way is to have a common bridge (e.g. |
1412 | d587329c | Konstantinos Tompoulidis | ``br0``, on the same collision domain with the router) where all VMs will |
1413 | d587329c | Konstantinos Tompoulidis | connect to. Packets will be "forwarded" to the router and then to the Internet. |
1414 | d587329c | Konstantinos Tompoulidis | If you want a more advanced setup (ip-less routing and proxy-arp plese refer to |
1415 | cc16407a | Dimitris Aragiorgis | :ref:`Network <networks>` section). |
1416 | cc16407a | Dimitris Aragiorgis | |
1417 | cc16407a | Dimitris Aragiorgis | Physical Host Setup |
1418 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~~~~~~~~~ |
1419 | cc16407a | Dimitris Aragiorgis | |
1420 | cc16407a | Dimitris Aragiorgis | Assuming ``eth0`` on both hosts is the public interface (directly connected |
1421 | cc16407a | Dimitris Aragiorgis | to the router), run on every node: |
1422 | 2f6143c9 | Constantinos Venetsanopoulos | |
1423 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1424 | bc7e4f5f | Stratos Psomadakis | |
1425 | d587329c | Konstantinos Tompoulidis | # apt-get install vlan |
1426 | cc16407a | Dimitris Aragiorgis | # brctl addbr br0 |
1427 | cc16407a | Dimitris Aragiorgis | # ip link set br0 up |
1428 | cc16407a | Dimitris Aragiorgis | # vconfig add eth0 100 |
1429 | cc16407a | Dimitris Aragiorgis | # ip link set eth0.100 up |
1430 | cc16407a | Dimitris Aragiorgis | # brctl addif br0 eth0.100 |
1431 | cc16407a | Dimitris Aragiorgis | |
1432 | cc16407a | Dimitris Aragiorgis | |
1433 | cc16407a | Dimitris Aragiorgis | Testing a Public Network |
1434 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~~~~~~~~~~~~~~ |
1435 | cc16407a | Dimitris Aragiorgis | |
1436 | cc16407a | Dimitris Aragiorgis | Let's assume, that you want to assign IPs from the ``5.6.7.0/27`` range to you |
1437 | cc16407a | Dimitris Aragiorgis | new VMs, with ``5.6.7.1`` as the router's gateway. In Ganeti you can add the |
1438 | cc16407a | Dimitris Aragiorgis | network by running: |
1439 | cc16407a | Dimitris Aragiorgis | |
1440 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1441 | cc16407a | Dimitris Aragiorgis | |
1442 | cc16407a | Dimitris Aragiorgis | # gnt-network add --network=5.6.7.0/27 --gateway=5.6.7.1 --network-type=public --tags=nfdhcpd test-net-public |
1443 | 2f6143c9 | Constantinos Venetsanopoulos | |
1444 | cc16407a | Dimitris Aragiorgis | Then, connect the network to all your nodegroups. We assume that we only have |
1445 | cc16407a | Dimitris Aragiorgis | one nodegroup (``default``) in our Ganeti cluster: |
1446 | cc16407a | Dimitris Aragiorgis | |
1447 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1448 | cc16407a | Dimitris Aragiorgis | |
1449 | cc16407a | Dimitris Aragiorgis | # gnt-network connect test-net-public default bridged br0 |
1450 | 2f6143c9 | Constantinos Venetsanopoulos | |
1451 | 2f6143c9 | Constantinos Venetsanopoulos | Now, it is time to test that the backend infrastracture is correctly setup for |
1452 | cc16407a | Dimitris Aragiorgis | the Public Network. We will add a new VM, the same way we did it on the |
1453 | cc16407a | Dimitris Aragiorgis | previous testing section. However, now will also add one NIC, configured to be |
1454 | cc16407a | Dimitris Aragiorgis | managed from our previously defined network. Run on the GANETI-MASTER (node1): |
1455 | 2f6143c9 | Constantinos Venetsanopoulos | |
1456 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1457 | 2f6143c9 | Constantinos Venetsanopoulos | |
1458 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1459 | d587329c | Konstantinos Tompoulidis | img_passwd=my_vm_example_passw0rd,img_format=diskdump,img_id="pithos://UUID/pithos/debian_base-6.0-7-x86_64.diskdump",img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' \ |
1460 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1461 | cc16407a | Dimitris Aragiorgis | --net 0:ip=pool,network=test-net-public \ |
1462 | 2f6143c9 | Constantinos Venetsanopoulos | testvm2 |
1463 | 2f6143c9 | Constantinos Venetsanopoulos | |
1464 | 2f6143c9 | Constantinos Venetsanopoulos | If the above returns successfully, connect to the new VM and run: |
1465 | 2f6143c9 | Constantinos Venetsanopoulos | |
1466 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1467 | 2f6143c9 | Constantinos Venetsanopoulos | |
1468 | cc16407a | Dimitris Aragiorgis | root@testvm2:~ # ip addr |
1469 | cc16407a | Dimitris Aragiorgis | root@testvm2:~ # ip route |
1470 | cc16407a | Dimitris Aragiorgis | root@testvm2:~ # cat /etc/resolv.conf |
1471 | 2f6143c9 | Constantinos Venetsanopoulos | |
1472 | cc16407a | Dimitris Aragiorgis | to check IP address (5.6.7.2), IP routes (default via 5.6.7.1) and DNS config |
1473 | cc16407a | Dimitris Aragiorgis | (nameserver option in nfdhcpd.conf). This shows correct configuration of |
1474 | cc16407a | Dimitris Aragiorgis | ganeti, snf-network and nfdhcpd. |
1475 | 2f6143c9 | Constantinos Venetsanopoulos | |
1476 | 2f6143c9 | Constantinos Venetsanopoulos | Now ping the outside world. If this works too, then you have also configured |
1477 | cc16407a | Dimitris Aragiorgis | correctly your physical host and router. |
1478 | 547c78f6 | Constantinos Venetsanopoulos | |
1479 | 547c78f6 | Constantinos Venetsanopoulos | Make sure everything works as expected, before proceeding with the Private |
1480 | 2f6143c9 | Constantinos Venetsanopoulos | Networks setup. |
1481 | 2f6143c9 | Constantinos Venetsanopoulos | |
1482 | 04c1254b | Constantinos Venetsanopoulos | .. _private-networks-setup: |
1483 | 04c1254b | Constantinos Venetsanopoulos | |
1484 | cc16407a | Dimitris Aragiorgis | Private Networks Setup |
1485 | 7a8df455 | Constantinos Venetsanopoulos | ---------------------- |
1486 | 2f6143c9 | Constantinos Venetsanopoulos | |
1487 | cc16407a | Dimitris Aragiorgis | Synnefo supports two types of private networks: |
1488 | cc16407a | Dimitris Aragiorgis | |
1489 | cc16407a | Dimitris Aragiorgis | - based on MAC filtering |
1490 | cc16407a | Dimitris Aragiorgis | - based on physical VLANs |
1491 | cc16407a | Dimitris Aragiorgis | |
1492 | cc16407a | Dimitris Aragiorgis | Both types provide Layer 2 isolation to the end-user. |
1493 | 2f6143c9 | Constantinos Venetsanopoulos | |
1494 | d587329c | Konstantinos Tompoulidis | For the first type a common bridge (e.g. ``prv0``) is needed while for the |
1495 | d587329c | Konstantinos Tompoulidis | second a range of bridges (e.g. ``prv1..prv100``) each bridged on a different |
1496 | d587329c | Konstantinos Tompoulidis | physical VLAN. To this end to assure isolation among end-users' private networks |
1497 | d587329c | Konstantinos Tompoulidis | each has to have different MAC prefix (for the filtering to take place) or to be |
1498 | cc16407a | Dimitris Aragiorgis | "connected" to a different bridge (VLAN actually). |
1499 | 547c78f6 | Constantinos Venetsanopoulos | |
1500 | cc16407a | Dimitris Aragiorgis | Physical Host Setup |
1501 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~~~~~~~~~ |
1502 | cc16407a | Dimitris Aragiorgis | |
1503 | cc16407a | Dimitris Aragiorgis | In order to create the necessary VLAN/bridges, one for MAC filtered private |
1504 | cc16407a | Dimitris Aragiorgis | networks and various (e.g. 20) for private networks based on physical VLANs, |
1505 | cc16407a | Dimitris Aragiorgis | run on every node: |
1506 | 547c78f6 | Constantinos Venetsanopoulos | |
1507 | cc16407a | Dimitris Aragiorgis | Assuming ``eth0`` of both hosts are somehow (via cable/switch with VLANs |
1508 | cc16407a | Dimitris Aragiorgis | configured correctly) connected together, run on every node: |
1509 | 547c78f6 | Constantinos Venetsanopoulos | |
1510 | 547c78f6 | Constantinos Venetsanopoulos | .. code-block:: console |
1511 | 547c78f6 | Constantinos Venetsanopoulos | |
1512 | cc16407a | Dimitris Aragiorgis | # modprobe 8021q |
1513 | 547c78f6 | Constantinos Venetsanopoulos | # $iface=eth0 |
1514 | cc16407a | Dimitris Aragiorgis | # for prv in $(seq 0 20); do |
1515 | d587329c | Konstantinos Tompoulidis | vlan=$prv |
1516 | d587329c | Konstantinos Tompoulidis | bridge=prv$prv |
1517 | d587329c | Konstantinos Tompoulidis | vconfig add $iface $vlan |
1518 | d587329c | Konstantinos Tompoulidis | ifconfig $iface.$vlan up |
1519 | d587329c | Konstantinos Tompoulidis | brctl addbr $bridge |
1520 | d587329c | Konstantinos Tompoulidis | brctl setfd $bridge 0 |
1521 | d587329c | Konstantinos Tompoulidis | brctl addif $bridge $iface.$vlan |
1522 | d587329c | Konstantinos Tompoulidis | ifconfig $bridge up |
1523 | 547c78f6 | Constantinos Venetsanopoulos | done |
1524 | 547c78f6 | Constantinos Venetsanopoulos | |
1525 | cc16407a | Dimitris Aragiorgis | The above will do the following : |
1526 | 547c78f6 | Constantinos Venetsanopoulos | |
1527 | cc16407a | Dimitris Aragiorgis | * provision 21 new bridges: ``prv0`` - ``prv20`` |
1528 | cc16407a | Dimitris Aragiorgis | * provision 21 new vlans: ``eth0.0`` - ``eth0.20`` |
1529 | cc16407a | Dimitris Aragiorgis | * add the corresponding vlan to the equivalent bridge |
1530 | 547c78f6 | Constantinos Venetsanopoulos | |
1531 | 547c78f6 | Constantinos Venetsanopoulos | You can run ``brctl show`` on both nodes to see if everything was setup |
1532 | 547c78f6 | Constantinos Venetsanopoulos | correctly. |
1533 | 547c78f6 | Constantinos Venetsanopoulos | |
1534 | 2f6143c9 | Constantinos Venetsanopoulos | Testing the Private Networks |
1535 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1536 | caa6c07d | Constantinos Venetsanopoulos | |
1537 | 547c78f6 | Constantinos Venetsanopoulos | To test the Private Networks, we will create two instances and put them in the |
1538 | cc16407a | Dimitris Aragiorgis | same Private Networks (one MAC Filtered and one Physical VLAN). This means |
1539 | cc16407a | Dimitris Aragiorgis | that the instances will have a second NIC connected to the ``prv0`` |
1540 | cc16407a | Dimitris Aragiorgis | pre-provisioned bridge and a third to ``prv1``. |
1541 | 547c78f6 | Constantinos Venetsanopoulos | |
1542 | 547c78f6 | Constantinos Venetsanopoulos | We run the same command as in the Public Network testing section, but with one |
1543 | 547c78f6 | Constantinos Venetsanopoulos | more argument for the second NIC: |
1544 | 547c78f6 | Constantinos Venetsanopoulos | |
1545 | 547c78f6 | Constantinos Venetsanopoulos | .. code-block:: console |
1546 | 547c78f6 | Constantinos Venetsanopoulos | |
1547 | cc16407a | Dimitris Aragiorgis | # gnt-network add --network=192.168.1.0/24 --mac-prefix=aa:00:55 --network-type=private --tags=nfdhcpd,private-filtered test-net-prv-mac |
1548 | cc16407a | Dimitris Aragiorgis | # gnt-network connect test-net-prv-mac default bridged prv0 |
1549 | cc16407a | Dimitris Aragiorgis | |
1550 | cc16407a | Dimitris Aragiorgis | # gnt-network add --network=10.0.0.0/24 --tags=nfdhcpd --network-type=private test-net-prv-vlan |
1551 | cc16407a | Dimitris Aragiorgis | # gnt-network connect test-net-prv-vlan default bridged prv1 |
1552 | cc16407a | Dimitris Aragiorgis | |
1553 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1554 | d587329c | Konstantinos Tompoulidis | img_passwd=my_vm_example_passw0rd,img_format=diskdump,img_id="pithos://UUID/pithos/debian_base-6.0-7-x86_64.diskdump",img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' \ |
1555 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1556 | cc16407a | Dimitris Aragiorgis | --net 0:ip=pool,network=test-net-public \ |
1557 | cc16407a | Dimitris Aragiorgis | --net 1:ip=pool,network=test-net-prv-mac \ |
1558 | cc16407a | Dimitris Aragiorgis | --net 2:ip=none,network=test-net-prv-vlan \ |
1559 | 547c78f6 | Constantinos Venetsanopoulos | testvm3 |
1560 | 547c78f6 | Constantinos Venetsanopoulos | |
1561 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1562 | d587329c | Konstantinos Tompoulidis | img_passwd=my_vm_example_passw0rd,img_format=diskdump,img_id="pithos://UUID/pithos/debian_base-6.0-7-x86_64.diskdump",img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' \ |
1563 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1564 | cc16407a | Dimitris Aragiorgis | --net 0:ip=pool,network=test-net-public \ |
1565 | cc16407a | Dimitris Aragiorgis | --net 1:ip=pool,network=test-net-prv-mac \ |
1566 | cc16407a | Dimitris Aragiorgis | --net 2:ip=none,network=test-net-prv-vlan \ |
1567 | 547c78f6 | Constantinos Venetsanopoulos | testvm4 |
1568 | 547c78f6 | Constantinos Venetsanopoulos | |
1569 | cc16407a | Dimitris Aragiorgis | Above, we create two instances with first NIC connected to the internet, their |
1570 | cc16407a | Dimitris Aragiorgis | second NIC connected to a MAC filtered private Network and their third NIC |
1571 | cc16407a | Dimitris Aragiorgis | connected to the first Physical VLAN Private Network. Now, connect to the |
1572 | cc16407a | Dimitris Aragiorgis | instances using VNC and make sure everything works as expected: |
1573 | 547c78f6 | Constantinos Venetsanopoulos | |
1574 | cc16407a | Dimitris Aragiorgis | a) The instances have access to the public internet through their first eth |
1575 | cc16407a | Dimitris Aragiorgis | interface (``eth0``), which has been automatically assigned a public IP. |
1576 | 547c78f6 | Constantinos Venetsanopoulos | |
1577 | cc16407a | Dimitris Aragiorgis | b) ``eth1`` will have mac prefix ``aa:00:55``, while ``eth2`` default one (``aa:00:00``) |
1578 | 547c78f6 | Constantinos Venetsanopoulos | |
1579 | cc16407a | Dimitris Aragiorgis | c) ip link set ``eth1``/``eth2`` up |
1580 | 547c78f6 | Constantinos Venetsanopoulos | |
1581 | cc16407a | Dimitris Aragiorgis | d) dhclient ``eth1``/``eth2`` |
1582 | 547c78f6 | Constantinos Venetsanopoulos | |
1583 | cc16407a | Dimitris Aragiorgis | e) On testvm3 ping 192.168.1.2/10.0.0.2 |
1584 | 547c78f6 | Constantinos Venetsanopoulos | |
1585 | 547c78f6 | Constantinos Venetsanopoulos | If everything works as expected, then you have finished the Network Setup at the |
1586 | 547c78f6 | Constantinos Venetsanopoulos | backend for both types of Networks (Public & Private). |
1587 | 547c78f6 | Constantinos Venetsanopoulos | |
1588 | 2c85833e | Constantinos Venetsanopoulos | .. _cyclades-gtools: |
1589 | 2c85833e | Constantinos Venetsanopoulos | |
1590 | 2c85833e | Constantinos Venetsanopoulos | Cyclades Ganeti tools |
1591 | 2c85833e | Constantinos Venetsanopoulos | --------------------- |
1592 | 2c85833e | Constantinos Venetsanopoulos | |
1593 | 2c85833e | Constantinos Venetsanopoulos | In order for Ganeti to be connected with Cyclades later on, we need the |
1594 | 2c85833e | Constantinos Venetsanopoulos | `Cyclades Ganeti tools` available on all Ganeti nodes (node1 & node2 in our |
1595 | 2c85833e | Constantinos Venetsanopoulos | case). You can install them by running in both nodes: |
1596 | 2c85833e | Constantinos Venetsanopoulos | |
1597 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1598 | 2c85833e | Constantinos Venetsanopoulos | |
1599 | 2c85833e | Constantinos Venetsanopoulos | # apt-get install snf-cyclades-gtools |
1600 | 2c85833e | Constantinos Venetsanopoulos | |
1601 | 2c85833e | Constantinos Venetsanopoulos | This will install the following: |
1602 | 2c85833e | Constantinos Venetsanopoulos | |
1603 | 2c85833e | Constantinos Venetsanopoulos | * ``snf-ganeti-eventd`` (daemon to publish Ganeti related messages on RabbitMQ) |
1604 | 2c85833e | Constantinos Venetsanopoulos | * ``snf-ganeti-hook`` (all necessary hooks under ``/etc/ganeti/hooks``) |
1605 | 2c85833e | Constantinos Venetsanopoulos | * ``snf-progress-monitor`` (used by ``snf-image`` to publish progress messages) |
1606 | 2c85833e | Constantinos Venetsanopoulos | |
1607 | 2c85833e | Constantinos Venetsanopoulos | Configure ``snf-cyclades-gtools`` |
1608 | 2c85833e | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1609 | 2c85833e | Constantinos Venetsanopoulos | |
1610 | d587329c | Konstantinos Tompoulidis | The package will install the ``/etc/synnefo/20-snf-cyclades-gtools-backend.conf`` |
1611 | 2c85833e | Constantinos Venetsanopoulos | configuration file. At least we need to set the RabbitMQ endpoint for all tools |
1612 | 2c85833e | Constantinos Venetsanopoulos | that need it: |
1613 | 2c85833e | Constantinos Venetsanopoulos | |
1614 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1615 | 2c85833e | Constantinos Venetsanopoulos | |
1616 | d587329c | Konstantinos Tompoulidis | AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"] |
1617 | 2c85833e | Constantinos Venetsanopoulos | |
1618 | 2c85833e | Constantinos Venetsanopoulos | The above variables should reflect your :ref:`Message Queue setup |
1619 | 2c85833e | Constantinos Venetsanopoulos | <rabbitmq-setup>`. This file should be editted in all Ganeti nodes. |
1620 | 2c85833e | Constantinos Venetsanopoulos | |
1621 | 2c85833e | Constantinos Venetsanopoulos | Connect ``snf-image`` with ``snf-progress-monitor`` |
1622 | 2c85833e | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1623 | 2c85833e | Constantinos Venetsanopoulos | |
1624 | 2c85833e | Constantinos Venetsanopoulos | Finally, we need to configure ``snf-image`` to publish progress messages during |
1625 | 2c85833e | Constantinos Venetsanopoulos | the deployment of each Image. To do this, we edit ``/etc/default/snf-image`` and |
1626 | 2c85833e | Constantinos Venetsanopoulos | set the corresponding variable to ``snf-progress-monitor``: |
1627 | 2c85833e | Constantinos Venetsanopoulos | |
1628 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1629 | 2c85833e | Constantinos Venetsanopoulos | |
1630 | 2c85833e | Constantinos Venetsanopoulos | PROGRESS_MONITOR="snf-progress-monitor" |
1631 | 2c85833e | Constantinos Venetsanopoulos | |
1632 | 2c85833e | Constantinos Venetsanopoulos | This file should be editted in all Ganeti nodes. |
1633 | 2c85833e | Constantinos Venetsanopoulos | |
1634 | 7a8df455 | Constantinos Venetsanopoulos | .. _rapi-user: |
1635 | 7a8df455 | Constantinos Venetsanopoulos | |
1636 | caa6c07d | Constantinos Venetsanopoulos | Synnefo RAPI user |
1637 | 7a8df455 | Constantinos Venetsanopoulos | ----------------- |
1638 | caa6c07d | Constantinos Venetsanopoulos | |
1639 | 7a8df455 | Constantinos Venetsanopoulos | As a last step before installing Cyclades, create a new RAPI user that will |
1640 | caa6c07d | Constantinos Venetsanopoulos | have ``write`` access. Cyclades will use this user to issue commands to Ganeti, |
1641 | 2c85833e | Constantinos Venetsanopoulos | so we will call the user ``cyclades`` with password ``example_rapi_passw0rd``. |
1642 | 2c85833e | Constantinos Venetsanopoulos | You can do this, by first running: |
1643 | 2c85833e | Constantinos Venetsanopoulos | |
1644 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1645 | 2c85833e | Constantinos Venetsanopoulos | |
1646 | 2c85833e | Constantinos Venetsanopoulos | # echo -n 'cyclades:Ganeti Remote API:example_rapi_passw0rd' | openssl md5 |
1647 | 2c85833e | Constantinos Venetsanopoulos | |
1648 | 2c85833e | Constantinos Venetsanopoulos | and then putting the output in ``/var/lib/ganeti/rapi/users`` as follows: |
1649 | caa6c07d | Constantinos Venetsanopoulos | |
1650 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1651 | caa6c07d | Constantinos Venetsanopoulos | |
1652 | 2c85833e | Constantinos Venetsanopoulos | cyclades {HA1}55aec7050aa4e4b111ca43cb505a61a0 write |
1653 | caa6c07d | Constantinos Venetsanopoulos | |
1654 | caa6c07d | Constantinos Venetsanopoulos | More about Ganeti's RAPI users `here. |
1655 | caa6c07d | Constantinos Venetsanopoulos | <http://docs.ganeti.org/ganeti/2.5/html/rapi.html#introduction>`_ |
1656 | bc055d09 | Constantinos Venetsanopoulos | |
1657 | 7a8df455 | Constantinos Venetsanopoulos | You have now finished with all needed Prerequisites for Cyclades (and |
1658 | 7a8df455 | Constantinos Venetsanopoulos | Plankton). Let's move on to the actual Cyclades installation. |
1659 | 7a8df455 | Constantinos Venetsanopoulos | |
1660 | 7a8df455 | Constantinos Venetsanopoulos | |
1661 | 7a8df455 | Constantinos Venetsanopoulos | Installation of Cyclades (and Plankton) on node1 |
1662 | 7a8df455 | Constantinos Venetsanopoulos | ================================================ |
1663 | 7a8df455 | Constantinos Venetsanopoulos | |
1664 | 7a8df455 | Constantinos Venetsanopoulos | This section describes the installation of Cyclades. Cyclades is Synnefo's |
1665 | 7a8df455 | Constantinos Venetsanopoulos | Compute service. Plankton (the Image Registry service) will get installed |
1666 | 7a8df455 | Constantinos Venetsanopoulos | automatically along with Cyclades, because it is contained in the same Synnefo |
1667 | 7a8df455 | Constantinos Venetsanopoulos | component right now. |
1668 | 7a8df455 | Constantinos Venetsanopoulos | |
1669 | 04c1254b | Constantinos Venetsanopoulos | We will install Cyclades (and Plankton) on node1. To do so, we install the |
1670 | 04c1254b | Constantinos Venetsanopoulos | corresponding package by running on node1: |
1671 | 04c1254b | Constantinos Venetsanopoulos | |
1672 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1673 | 04c1254b | Constantinos Venetsanopoulos | |
1674 | d587329c | Konstantinos Tompoulidis | # apt-get install snf-cyclades-app memcached python-memcache |
1675 | 04c1254b | Constantinos Venetsanopoulos | |
1676 | 7d07d924 | Constantinos Venetsanopoulos | If all packages install successfully, then Cyclades and Plankton are installed |
1677 | 04c1254b | Constantinos Venetsanopoulos | and we proceed with their configuration. |
1678 | 04c1254b | Constantinos Venetsanopoulos | |
1679 | d587329c | Konstantinos Tompoulidis | Since version 0.13, Synnefo uses the VMAPI in order to prevent sensitive data |
1680 | d587329c | Konstantinos Tompoulidis | needed by 'snf-image' to be stored in Ganeti configuration (e.g. VM password). |
1681 | d587329c | Konstantinos Tompoulidis | This is achieved by storing all sensitive information to a CACHE backend and |
1682 | d587329c | Konstantinos Tompoulidis | exporting it via VMAPI. The cache entries are invalidated after the first |
1683 | d587329c | Konstantinos Tompoulidis | request. Synnefo uses `memcached <http://memcached.org/>`_ as a |
1684 | d587329c | Konstantinos Tompoulidis | `Django <https://www.djangoproject.com/>`_ cache backend. |
1685 | bc055d09 | Constantinos Venetsanopoulos | |
1686 | a96ec00f | Constantinos Venetsanopoulos | Configuration of Cyclades (and Plankton) |
1687 | a96ec00f | Constantinos Venetsanopoulos | ======================================== |
1688 | 5b6feb88 | Vangelis Koukis | |
1689 | 04c1254b | Constantinos Venetsanopoulos | Conf files |
1690 | 04c1254b | Constantinos Venetsanopoulos | ---------- |
1691 | bc055d09 | Constantinos Venetsanopoulos | |
1692 | 04c1254b | Constantinos Venetsanopoulos | After installing Cyclades, a number of new configuration files will appear under |
1693 | d587329c | Konstantinos Tompoulidis | ``/etc/synnefo/`` prefixed with ``20-snf-cyclades-app-``. We will describe here |
1694 | d587329c | Konstantinos Tompoulidis | only the minimal needed changes to result with a working system. In general, |
1695 | d587329c | Konstantinos Tompoulidis | sane defaults have been chosen for the most of the options, to cover most of the |
1696 | 04c1254b | Constantinos Venetsanopoulos | common scenarios. However, if you want to tweak Cyclades feel free to do so, |
1697 | 04c1254b | Constantinos Venetsanopoulos | once you get familiar with the different options. |
1698 | bc055d09 | Constantinos Venetsanopoulos | |
1699 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-api.conf``: |
1700 | bc055d09 | Constantinos Venetsanopoulos | |
1701 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1702 | 04c1254b | Constantinos Venetsanopoulos | |
1703 | 4ab620b6 | Christos Stavrakakis | ASTAKOS_URL = 'https://node1.example.com/' |
1704 | 04c1254b | Constantinos Venetsanopoulos | |
1705 | d587329c | Konstantinos Tompoulidis | # Set to False if astakos & cyclades are on the same host |
1706 | d587329c | Konstantinos Tompoulidis | CYCLADES_PROXY_USER_SERVICES = False |
1707 | d587329c | Konstantinos Tompoulidis | |
1708 | 04c1254b | Constantinos Venetsanopoulos | The ``ASTAKOS_URL`` denotes the authentication endpoint for Cyclades and is set |
1709 | 04c1254b | Constantinos Venetsanopoulos | to point to Astakos (this should have the same value with Pithos+'s |
1710 | 4ab620b6 | Christos Stavrakakis | ``ASTAKOS_URL``, setup :ref:`previously <conf-pithos>`). |
1711 | 04c1254b | Constantinos Venetsanopoulos | |
1712 | d587329c | Konstantinos Tompoulidis | .. warning:: |
1713 | d587329c | Konstantinos Tompoulidis | |
1714 | d587329c | Konstantinos Tompoulidis | All services must match the quotaholder token and url configured for |
1715 | d587329c | Konstantinos Tompoulidis | quotaholder. |
1716 | d587329c | Konstantinos Tompoulidis | |
1717 | 053d0dfc | Constantinos Venetsanopoulos | TODO: Document the Network Options here |
1718 | 04c1254b | Constantinos Venetsanopoulos | |
1719 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-cloudbar.conf``: |
1720 | 04c1254b | Constantinos Venetsanopoulos | |
1721 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1722 | 04c1254b | Constantinos Venetsanopoulos | |
1723 | bc3a7b5a | Constantinos Venetsanopoulos | CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
1724 | de20a465 | Constantinos Venetsanopoulos | CLOUDBAR_ACTIVE_SERVICE = '2' |
1725 | bc3a7b5a | Constantinos Venetsanopoulos | CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services' |
1726 | 04c1254b | Constantinos Venetsanopoulos | CLOUDBAR_MENU_URL = 'https://account.node1.example.com/im/get_menu' |
1727 | 04c1254b | Constantinos Venetsanopoulos | |
1728 | 04c1254b | Constantinos Venetsanopoulos | ``CLOUDBAR_LOCATION`` tells the client where to find the Astakos common |
1729 | 04c1254b | Constantinos Venetsanopoulos | cloudbar. The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are |
1730 | 04c1254b | Constantinos Venetsanopoulos | used by the Cyclades Web UI to get from Astakos all the information needed to |
1731 | 04c1254b | Constantinos Venetsanopoulos | fill its own cloudbar. So, we put our Astakos deployment urls there. All the |
1732 | 04c1254b | Constantinos Venetsanopoulos | above should have the same values we put in the corresponding variables in |
1733 | 04c1254b | Constantinos Venetsanopoulos | ``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf`` on the previous |
1734 | 04c1254b | Constantinos Venetsanopoulos | :ref:`Pithos configuration <conf-pithos>` section. |
1735 | 04c1254b | Constantinos Venetsanopoulos | |
1736 | de20a465 | Constantinos Venetsanopoulos | The ``CLOUDBAR_ACTIVE_SERVICE`` points to an already registered Astakos |
1737 | de20a465 | Constantinos Venetsanopoulos | service. You can see all :ref:`registered services <services-reg>` by running |
1738 | de20a465 | Constantinos Venetsanopoulos | on the Astakos node (node1): |
1739 | de20a465 | Constantinos Venetsanopoulos | |
1740 | de20a465 | Constantinos Venetsanopoulos | .. code-block:: console |
1741 | de20a465 | Constantinos Venetsanopoulos | |
1742 | 62b10e3f | Constantinos Venetsanopoulos | # snf-manage service-list |
1743 | de20a465 | Constantinos Venetsanopoulos | |
1744 | de20a465 | Constantinos Venetsanopoulos | The value of ``CLOUDBAR_ACTIVE_SERVICE`` should be the cyclades service's |
1745 | de20a465 | Constantinos Venetsanopoulos | ``id`` as shown by the above command, in our case ``2``. |
1746 | 04c1254b | Constantinos Venetsanopoulos | |
1747 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``: |
1748 | 04c1254b | Constantinos Venetsanopoulos | |
1749 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1750 | 04c1254b | Constantinos Venetsanopoulos | |
1751 | 04c1254b | Constantinos Venetsanopoulos | BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos' |
1752 | 04c1254b | Constantinos Venetsanopoulos | BACKEND_BLOCK_PATH = '/srv/pithos/data/' |
1753 | 04c1254b | Constantinos Venetsanopoulos | |
1754 | 04c1254b | Constantinos Venetsanopoulos | In this file we configure the Plankton Service. ``BACKEND_DB_CONNECTION`` |
1755 | 04c1254b | Constantinos Venetsanopoulos | denotes the Pithos+ database (where the Image files are stored). So we set that |
1756 | 04c1254b | Constantinos Venetsanopoulos | to point to our Pithos+ database. ``BACKEND_BLOCK_PATH`` denotes the actual |
1757 | 04c1254b | Constantinos Venetsanopoulos | Pithos+ data location. |
1758 | 04c1254b | Constantinos Venetsanopoulos | |
1759 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-queues.conf``: |
1760 | 04c1254b | Constantinos Venetsanopoulos | |
1761 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1762 | 04c1254b | Constantinos Venetsanopoulos | |
1763 | ad003186 | Constantinos Venetsanopoulos | AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"] |
1764 | 04c1254b | Constantinos Venetsanopoulos | |
1765 | 04c1254b | Constantinos Venetsanopoulos | The above settings denote the Message Queue. Those settings should have the same |
1766 | 04c1254b | Constantinos Venetsanopoulos | values as in ``/etc/synnefo/10-snf-cyclades-gtools-backend.conf`` file, and |
1767 | 04c1254b | Constantinos Venetsanopoulos | reflect our :ref:`Message Queue setup <rabbitmq-setup>`. |
1768 | 04c1254b | Constantinos Venetsanopoulos | |
1769 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-ui.conf``: |
1770 | 04c1254b | Constantinos Venetsanopoulos | |
1771 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1772 | 04c1254b | Constantinos Venetsanopoulos | |
1773 | bc3a7b5a | Constantinos Venetsanopoulos | UI_LOGIN_URL = "https://node1.example.com/im/login" |
1774 | bc3a7b5a | Constantinos Venetsanopoulos | UI_LOGOUT_URL = "https://node1.example.com/im/logout" |
1775 | 04c1254b | Constantinos Venetsanopoulos | |
1776 | 04c1254b | Constantinos Venetsanopoulos | The ``UI_LOGIN_URL`` option tells the Cyclades Web UI where to redirect users, |
1777 | 04c1254b | Constantinos Venetsanopoulos | if they are not logged in. We point that to Astakos. |
1778 | 04c1254b | Constantinos Venetsanopoulos | |
1779 | 04c1254b | Constantinos Venetsanopoulos | The ``UI_LOGOUT_URL`` option tells the Cyclades Web UI where to redirect the |
1780 | 04c1254b | Constantinos Venetsanopoulos | user when he/she logs out. We point that to Astakos, too. |
1781 | 04c1254b | Constantinos Venetsanopoulos | |
1782 | d587329c | Konstantinos Tompoulidis | Edit ``/etc/synnefo/20-snf-cyclades-app-quotas.conf``: |
1783 | d587329c | Konstantinos Tompoulidis | |
1784 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
1785 | d587329c | Konstantinos Tompoulidis | |
1786 | d587329c | Konstantinos Tompoulidis | CYCLADES_USE_QUOTAHOLDER = True |
1787 | d587329c | Konstantinos Tompoulidis | CYCLADES_QUOTAHOLDER_URL = 'https://node1.example.com/quotaholder/v' |
1788 | d587329c | Konstantinos Tompoulidis | CYCLADES_QUOTAHOLDER_TOKEN = 'aExampleTokenJbFm12w' |
1789 | d587329c | Konstantinos Tompoulidis | |
1790 | d587329c | Konstantinos Tompoulidis | Edit ``/etc/synnefo/20-snf-cyclades-app-vmapi.conf``: |
1791 | d587329c | Konstantinos Tompoulidis | |
1792 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
1793 | d587329c | Konstantinos Tompoulidis | |
1794 | d587329c | Konstantinos Tompoulidis | VMAPI_CACHE_BACKEND = "memcached://127.0.0.1:11211/?timeout=3600" |
1795 | d587329c | Konstantinos Tompoulidis | VMAPI_BASE_URL = "https://node1.example.com" |
1796 | d587329c | Konstantinos Tompoulidis | |
1797 | 053d0dfc | Constantinos Venetsanopoulos | Edit ``/etc/default/vncauthproxy``: |
1798 | 053d0dfc | Constantinos Venetsanopoulos | |
1799 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1800 | 053d0dfc | Constantinos Venetsanopoulos | |
1801 | d5426b9b | Stratos Psomadakis | CHUID="nobody:www-data" |
1802 | 053d0dfc | Constantinos Venetsanopoulos | |
1803 | 04c1254b | Constantinos Venetsanopoulos | We have now finished with the basic Cyclades and Plankton configuration. |
1804 | 04c1254b | Constantinos Venetsanopoulos | |
1805 | 04c1254b | Constantinos Venetsanopoulos | Database Initialization |
1806 | 04c1254b | Constantinos Venetsanopoulos | ----------------------- |
1807 | 04c1254b | Constantinos Venetsanopoulos | |
1808 | 04c1254b | Constantinos Venetsanopoulos | Once Cyclades is configured, we sync the database: |
1809 | bc055d09 | Constantinos Venetsanopoulos | |
1810 | bc055d09 | Constantinos Venetsanopoulos | .. code-block:: console |
1811 | bc055d09 | Constantinos Venetsanopoulos | |
1812 | bc055d09 | Constantinos Venetsanopoulos | $ snf-manage syncdb |
1813 | bc055d09 | Constantinos Venetsanopoulos | $ snf-manage migrate |
1814 | bc055d09 | Constantinos Venetsanopoulos | |
1815 | 04c1254b | Constantinos Venetsanopoulos | and load the initial server flavors: |
1816 | bc055d09 | Constantinos Venetsanopoulos | |
1817 | bc055d09 | Constantinos Venetsanopoulos | .. code-block:: console |
1818 | bc055d09 | Constantinos Venetsanopoulos | |
1819 | bc055d09 | Constantinos Venetsanopoulos | $ snf-manage loaddata flavors |
1820 | bc055d09 | Constantinos Venetsanopoulos | |
1821 | 04c1254b | Constantinos Venetsanopoulos | If everything returns successfully, our database is ready. |
1822 | 04c1254b | Constantinos Venetsanopoulos | |
1823 | 053d0dfc | Constantinos Venetsanopoulos | Add the Ganeti backend |
1824 | 053d0dfc | Constantinos Venetsanopoulos | ---------------------- |
1825 | 053d0dfc | Constantinos Venetsanopoulos | |
1826 | 7a3439cf | Constantinos Venetsanopoulos | In our installation we assume that we only have one Ganeti cluster, the one we |
1827 | b2764de1 | Dimitris Aragiorgis | setup earlier. At this point you have to add this backend (Ganeti cluster) to |
1828 | b2764de1 | Dimitris Aragiorgis | cyclades assuming that you have setup the :ref:`Rapi User <rapi-user>` |
1829 | b2764de1 | Dimitris Aragiorgis | correctly. |
1830 | b2764de1 | Dimitris Aragiorgis | |
1831 | b2764de1 | Dimitris Aragiorgis | .. code-block:: console |
1832 | b2764de1 | Dimitris Aragiorgis | |
1833 | 69aa7f21 | Ilias Tsitsimpis | $ snf-manage backend-add --clustername=ganeti.node1.example.com --user=cyclades --pass=example_rapi_passw0rd |
1834 | b2764de1 | Dimitris Aragiorgis | |
1835 | b2764de1 | Dimitris Aragiorgis | You can see everything has been setup correctly by running: |
1836 | 053d0dfc | Constantinos Venetsanopoulos | |
1837 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1838 | 053d0dfc | Constantinos Venetsanopoulos | |
1839 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage backend-list |
1840 | 053d0dfc | Constantinos Venetsanopoulos | |
1841 | d587329c | Konstantinos Tompoulidis | Enable the new backend by running: |
1842 | d587329c | Konstantinos Tompoulidis | |
1843 | d587329c | Konstantinos Tompoulidis | .. code-block:: |
1844 | d587329c | Konstantinos Tompoulidis | |
1845 | d587329c | Konstantinos Tompoulidis | $ snf-manage backend-modify --drained False 1 |
1846 | d587329c | Konstantinos Tompoulidis | |
1847 | d587329c | Konstantinos Tompoulidis | .. warning:: Since version 0.13, the backend is set to "drained" by default. |
1848 | d587329c | Konstantinos Tompoulidis | This means that you cannot add VMs to it. The reason for this is that the |
1849 | d587329c | Konstantinos Tompoulidis | nodes should be unavailable to Synnefo until the Administrator explicitly |
1850 | d587329c | Konstantinos Tompoulidis | releases them. To change this setting, use ``snf-manage backend-modify |
1851 | d587329c | Konstantinos Tompoulidis | --drained False <backend-id>``. |
1852 | d587329c | Konstantinos Tompoulidis | |
1853 | 7a3439cf | Constantinos Venetsanopoulos | If something is not set correctly, you can modify the backend with the |
1854 | 7a3439cf | Constantinos Venetsanopoulos | ``snf-manage backend-modify`` command. If something has gone wrong, you could |
1855 | 7a3439cf | Constantinos Venetsanopoulos | modify the backend to reflect the Ganeti installation by running: |
1856 | 053d0dfc | Constantinos Venetsanopoulos | |
1857 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1858 | 053d0dfc | Constantinos Venetsanopoulos | |
1859 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage backend-modify --clustername "ganeti.node1.example.com" |
1860 | 7a3439cf | Constantinos Venetsanopoulos | --user=cyclades |
1861 | 7a3439cf | Constantinos Venetsanopoulos | --pass=example_rapi_passw0rd |
1862 | 053d0dfc | Constantinos Venetsanopoulos | 1 |
1863 | 053d0dfc | Constantinos Venetsanopoulos | |
1864 | 053d0dfc | Constantinos Venetsanopoulos | ``clustername`` denotes the Ganeti-cluster's name. We provide the corresponding |
1865 | 053d0dfc | Constantinos Venetsanopoulos | domain that resolves to the master IP, than the IP itself, to ensure Cyclades |
1866 | 053d0dfc | Constantinos Venetsanopoulos | can talk to Ganeti even after a Ganeti master-failover. |
1867 | 053d0dfc | Constantinos Venetsanopoulos | |
1868 | 7a3439cf | Constantinos Venetsanopoulos | ``user`` and ``pass`` denote the RAPI user's username and the RAPI user's |
1869 | b2764de1 | Dimitris Aragiorgis | password. Once we setup the first backend to point at our Ganeti cluster, we |
1870 | b2764de1 | Dimitris Aragiorgis | update the Cyclades backends status by running: |
1871 | 053d0dfc | Constantinos Venetsanopoulos | |
1872 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1873 | 053d0dfc | Constantinos Venetsanopoulos | |
1874 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage backend-update-status |
1875 | 053d0dfc | Constantinos Venetsanopoulos | |
1876 | 7a3439cf | Constantinos Venetsanopoulos | Cyclades can manage multiple Ganeti backends, but for the purpose of this |
1877 | 7a3439cf | Constantinos Venetsanopoulos | guide,we won't get into more detail regarding mulitple backends. If you want to |
1878 | 7a3439cf | Constantinos Venetsanopoulos | learn more please see /*TODO*/. |
1879 | 7a3439cf | Constantinos Venetsanopoulos | |
1880 | 7a3439cf | Constantinos Venetsanopoulos | Add a Public Network |
1881 | 053d0dfc | Constantinos Venetsanopoulos | ---------------------- |
1882 | 053d0dfc | Constantinos Venetsanopoulos | |
1883 | 7a3439cf | Constantinos Venetsanopoulos | Cyclades supports different Public Networks on different Ganeti backends. |
1884 | cc16407a | Dimitris Aragiorgis | After connecting Cyclades with our Ganeti cluster, we need to setup a Public |
1885 | cc16407a | Dimitris Aragiorgis | Network for this Ganeti backend (`id = 1`). The basic setup is to bridge every |
1886 | cc16407a | Dimitris Aragiorgis | created NIC on a bridge. After having a bridge (e.g. br0) created in every |
1887 | cc16407a | Dimitris Aragiorgis | backend node edit Synnefo setting CUSTOM_BRIDGED_BRIDGE to 'br0': |
1888 | 053d0dfc | Constantinos Venetsanopoulos | |
1889 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1890 | 053d0dfc | Constantinos Venetsanopoulos | |
1891 | 69aa7f21 | Ilias Tsitsimpis | $ snf-manage network-create --subnet=5.6.7.0/27 \ |
1892 | 69aa7f21 | Ilias Tsitsimpis | --gateway=5.6.7.1 \ |
1893 | 69aa7f21 | Ilias Tsitsimpis | --subnet6=2001:648:2FFC:1322::/64 \ |
1894 | 69aa7f21 | Ilias Tsitsimpis | --gateway6=2001:648:2FFC:1322::1 \ |
1895 | 18e300b2 | Christos Stavrakakis | --public --dhcp --flavor=CUSTOM \ |
1896 | 92e4d1c6 | Dimitris Aragiorgis | --link=br0 --mode=bridged \ |
1897 | 69aa7f21 | Ilias Tsitsimpis | --name=public_network \ |
1898 | 7a3439cf | Constantinos Venetsanopoulos | --backend-id=1 |
1899 | 053d0dfc | Constantinos Venetsanopoulos | |
1900 | 053d0dfc | Constantinos Venetsanopoulos | This will create the Public Network on both Cyclades and the Ganeti backend. To |
1901 | 053d0dfc | Constantinos Venetsanopoulos | make sure everything was setup correctly, also run: |
1902 | 053d0dfc | Constantinos Venetsanopoulos | |
1903 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1904 | 053d0dfc | Constantinos Venetsanopoulos | |
1905 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage reconcile-networks |
1906 | 053d0dfc | Constantinos Venetsanopoulos | |
1907 | 053d0dfc | Constantinos Venetsanopoulos | You can see all available networks by running: |
1908 | 053d0dfc | Constantinos Venetsanopoulos | |
1909 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1910 | 053d0dfc | Constantinos Venetsanopoulos | |
1911 | 7a3439cf | Constantinos Venetsanopoulos | $ snf-manage network-list |
1912 | 053d0dfc | Constantinos Venetsanopoulos | |
1913 | 053d0dfc | Constantinos Venetsanopoulos | and inspect each network's state by running: |
1914 | 053d0dfc | Constantinos Venetsanopoulos | |
1915 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1916 | 053d0dfc | Constantinos Venetsanopoulos | |
1917 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage network-inspect <net_id> |
1918 | 053d0dfc | Constantinos Venetsanopoulos | |
1919 | 053d0dfc | Constantinos Venetsanopoulos | Finally, you can see the networks from the Ganeti perspective by running on the |
1920 | 053d0dfc | Constantinos Venetsanopoulos | Ganeti MASTER: |
1921 | 053d0dfc | Constantinos Venetsanopoulos | |
1922 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1923 | 053d0dfc | Constantinos Venetsanopoulos | |
1924 | 053d0dfc | Constantinos Venetsanopoulos | $ gnt-network list |
1925 | 053d0dfc | Constantinos Venetsanopoulos | $ gnt-network info <network_name> |
1926 | 053d0dfc | Constantinos Venetsanopoulos | |
1927 | 19425707 | Christos Stavrakakis | Create pools for Private Networks |
1928 | d587329c | Konstantinos Tompoulidis | --------------------------------- |
1929 | 19425707 | Christos Stavrakakis | |
1930 | 19425707 | Christos Stavrakakis | To prevent duplicate assignment of resources to different private networks, |
1931 | 19425707 | Christos Stavrakakis | Cyclades supports two types of pools: |
1932 | 19425707 | Christos Stavrakakis | |
1933 | 19425707 | Christos Stavrakakis | - MAC prefix Pool |
1934 | 19425707 | Christos Stavrakakis | - Bridge Pool |
1935 | 19425707 | Christos Stavrakakis | |
1936 | 19425707 | Christos Stavrakakis | As long as those resourses have been provisioned, admin has to define two |
1937 | 19425707 | Christos Stavrakakis | these pools in Synnefo: |
1938 | 19425707 | Christos Stavrakakis | |
1939 | 19425707 | Christos Stavrakakis | |
1940 | 19425707 | Christos Stavrakakis | .. code-block:: console |
1941 | 19425707 | Christos Stavrakakis | |
1942 | 19425707 | Christos Stavrakakis | root@testvm1:~ # snf-manage pool-create --type=mac-prefix --base=aa:00:0 --size=65536 |
1943 | 19425707 | Christos Stavrakakis | |
1944 | 19425707 | Christos Stavrakakis | root@testvm1:~ # snf-manage pool-create --type=bridge --base=prv --size=20 |
1945 | 19425707 | Christos Stavrakakis | |
1946 | 19425707 | Christos Stavrakakis | Also, change the Synnefo setting in :file:`20-snf-cyclades-app-api.conf`: |
1947 | 19425707 | Christos Stavrakakis | |
1948 | 19425707 | Christos Stavrakakis | .. code-block:: console |
1949 | 19425707 | Christos Stavrakakis | |
1950 | 18e300b2 | Christos Stavrakakis | DEFAULT_MAC_FILTERED_BRIDGE = 'prv0' |
1951 | 19425707 | Christos Stavrakakis | |
1952 | 04c1254b | Constantinos Venetsanopoulos | Servers restart |
1953 | 04c1254b | Constantinos Venetsanopoulos | --------------- |
1954 | 04c1254b | Constantinos Venetsanopoulos | |
1955 | 053d0dfc | Constantinos Venetsanopoulos | Restart gunicorn on node1: |
1956 | 04c1254b | Constantinos Venetsanopoulos | |
1957 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1958 | bc055d09 | Constantinos Venetsanopoulos | |
1959 | 04c1254b | Constantinos Venetsanopoulos | # /etc/init.d/gunicorn restart |
1960 | bc055d09 | Constantinos Venetsanopoulos | |
1961 | 04c1254b | Constantinos Venetsanopoulos | Now let's do the final connections of Cyclades with Ganeti. |
1962 | bc055d09 | Constantinos Venetsanopoulos | |
1963 | 04c1254b | Constantinos Venetsanopoulos | ``snf-dispatcher`` initialization |
1964 | 04c1254b | Constantinos Venetsanopoulos | --------------------------------- |
1965 | 04c1254b | Constantinos Venetsanopoulos | |
1966 | 04c1254b | Constantinos Venetsanopoulos | ``snf-dispatcher`` dispatches all messages published to the Message Queue and |
1967 | 04c1254b | Constantinos Venetsanopoulos | manages the Cyclades database accordingly. It also initializes all exchanges. By |
1968 | 04c1254b | Constantinos Venetsanopoulos | default it is not enabled during installation of Cyclades, so let's enable it in |
1969 | 04c1254b | Constantinos Venetsanopoulos | its configuration file ``/etc/default/snf-dispatcher``: |
1970 | 04c1254b | Constantinos Venetsanopoulos | |
1971 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1972 | 04c1254b | Constantinos Venetsanopoulos | |
1973 | 04c1254b | Constantinos Venetsanopoulos | SNF_DSPTCH_ENABLE=true |
1974 | 04c1254b | Constantinos Venetsanopoulos | |
1975 | 04c1254b | Constantinos Venetsanopoulos | and start the daemon: |
1976 | 04c1254b | Constantinos Venetsanopoulos | |
1977 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1978 | 04c1254b | Constantinos Venetsanopoulos | |
1979 | 04c1254b | Constantinos Venetsanopoulos | # /etc/init.d/snf-dispatcher start |
1980 | 04c1254b | Constantinos Venetsanopoulos | |
1981 | 04c1254b | Constantinos Venetsanopoulos | You can see that everything works correctly by tailing its log file |
1982 | 04c1254b | Constantinos Venetsanopoulos | ``/var/log/synnefo/dispatcher.log``. |
1983 | 04c1254b | Constantinos Venetsanopoulos | |
1984 | 04c1254b | Constantinos Venetsanopoulos | ``snf-ganeti-eventd`` on GANETI MASTER |
1985 | 04c1254b | Constantinos Venetsanopoulos | -------------------------------------- |
1986 | 04c1254b | Constantinos Venetsanopoulos | |
1987 | 04c1254b | Constantinos Venetsanopoulos | The last step of the Cyclades setup is enabling the ``snf-ganeti-eventd`` |
1988 | 04c1254b | Constantinos Venetsanopoulos | daemon (part of the :ref:`Cyclades Ganeti tools <cyclades-gtools>` package). |
1989 | 04c1254b | Constantinos Venetsanopoulos | The daemon is already installed on the GANETI MASTER (node1 in our case). |
1990 | 04c1254b | Constantinos Venetsanopoulos | ``snf-ganeti-eventd`` is disabled by default during the ``snf-cyclades-gtools`` |
1991 | 04c1254b | Constantinos Venetsanopoulos | installation, so we enable it in its configuration file |
1992 | 04c1254b | Constantinos Venetsanopoulos | ``/etc/default/snf-ganeti-eventd``: |
1993 | 04c1254b | Constantinos Venetsanopoulos | |
1994 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1995 | 04c1254b | Constantinos Venetsanopoulos | |
1996 | 04c1254b | Constantinos Venetsanopoulos | SNF_EVENTD_ENABLE=true |
1997 | 04c1254b | Constantinos Venetsanopoulos | |
1998 | 04c1254b | Constantinos Venetsanopoulos | and start the daemon: |
1999 | 04c1254b | Constantinos Venetsanopoulos | |
2000 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
2001 | bc055d09 | Constantinos Venetsanopoulos | |
2002 | 04c1254b | Constantinos Venetsanopoulos | # /etc/init.d/snf-ganeti-eventd start |
2003 | bc055d09 | Constantinos Venetsanopoulos | |
2004 | 04c1254b | Constantinos Venetsanopoulos | .. warning:: Make sure you start ``snf-ganeti-eventd`` *ONLY* on GANETI MASTER |
2005 | bc055d09 | Constantinos Venetsanopoulos | |
2006 | d587329c | Konstantinos Tompoulidis | Apply Quotas |
2007 | d587329c | Konstantinos Tompoulidis | ------------ |
2008 | d587329c | Konstantinos Tompoulidis | |
2009 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
2010 | d587329c | Konstantinos Tompoulidis | |
2011 | d587329c | Konstantinos Tompoulidis | node1 # snf-manage astakos-init --load-service-resources |
2012 | d587329c | Konstantinos Tompoulidis | node1 # snf-manage astakos-quota --verify |
2013 | d587329c | Konstantinos Tompoulidis | node1 # snf-manage astakos-quota --sync |
2014 | d587329c | Konstantinos Tompoulidis | node2 # snf-manage pithos-reset-usage |
2015 | d587329c | Konstantinos Tompoulidis | node1 # snf-manage cyclades-reset-usage |
2016 | d587329c | Konstantinos Tompoulidis | |
2017 | 04c1254b | Constantinos Venetsanopoulos | If all the above return successfully, then you have finished with the Cyclades |
2018 | d587329c | Konstantinos Tompoulidis | and Plankton installation and setup. |
2019 | d587329c | Konstantinos Tompoulidis | |
2020 | d587329c | Konstantinos Tompoulidis | Let's test our installation now. |
2021 | bc055d09 | Constantinos Venetsanopoulos | |
2022 | 5b6feb88 | Vangelis Koukis | |
2023 | a96ec00f | Constantinos Venetsanopoulos | Testing of Cyclades (and Plankton) |
2024 | a96ec00f | Constantinos Venetsanopoulos | ================================== |
2025 | 5b6feb88 | Vangelis Koukis | |
2026 | 8a4cd31b | Constantinos Venetsanopoulos | Cyclades Web UI |
2027 | 8a4cd31b | Constantinos Venetsanopoulos | --------------- |
2028 | 8a4cd31b | Constantinos Venetsanopoulos | |
2029 | 8a4cd31b | Constantinos Venetsanopoulos | First of all we need to test that our Cyclades Web UI works correctly. Open your |
2030 | 8a4cd31b | Constantinos Venetsanopoulos | browser and go to the Astakos home page. Login and then click 'cyclades' on the |
2031 | 8a4cd31b | Constantinos Venetsanopoulos | top cloud bar. This should redirect you to: |
2032 | 8a4cd31b | Constantinos Venetsanopoulos | |
2033 | 8a4cd31b | Constantinos Venetsanopoulos | `http://node1.example.com/ui/` |
2034 | 8a4cd31b | Constantinos Venetsanopoulos | |
2035 | 8a4cd31b | Constantinos Venetsanopoulos | and the Cyclades home page should appear. If not, please go back and find what |
2036 | 8a4cd31b | Constantinos Venetsanopoulos | went wrong. Do not proceed if you don't see the Cyclades home page. |
2037 | 8a4cd31b | Constantinos Venetsanopoulos | |
2038 | 8a4cd31b | Constantinos Venetsanopoulos | If the Cyclades home page appears, click on the orange button 'New machine'. The |
2039 | 8a4cd31b | Constantinos Venetsanopoulos | first step of the 'New machine wizard' will appear. This step shows all the |
2040 | 8a4cd31b | Constantinos Venetsanopoulos | available Images from which you can spawn new VMs. The list should be currently |
2041 | 8a4cd31b | Constantinos Venetsanopoulos | empty, as we haven't registered any Images yet. Close the wizard and browse the |
2042 | 8a4cd31b | Constantinos Venetsanopoulos | interface (not many things to see yet). If everything seems to work, let's |
2043 | 8a4cd31b | Constantinos Venetsanopoulos | register our first Image file. |
2044 | 8a4cd31b | Constantinos Venetsanopoulos | |
2045 | 8a4cd31b | Constantinos Venetsanopoulos | Cyclades Images |
2046 | 8a4cd31b | Constantinos Venetsanopoulos | --------------- |
2047 | 8a4cd31b | Constantinos Venetsanopoulos | |
2048 | 8a4cd31b | Constantinos Venetsanopoulos | To test our Cyclades (and Plankton) installation, we will use an Image stored on |
2049 | 8a4cd31b | Constantinos Venetsanopoulos | Pithos+ to spawn a new VM from the Cyclades interface. We will describe all |
2050 | 8a4cd31b | Constantinos Venetsanopoulos | steps, even though you may already have uploaded an Image on Pithos+ from a |
2051 | 8a4cd31b | Constantinos Venetsanopoulos | :ref:`previous <snf-image-images>` section: |
2052 | 8a4cd31b | Constantinos Venetsanopoulos | |
2053 | 8a4cd31b | Constantinos Venetsanopoulos | * Upload an Image file to Pithos+ |
2054 | 8a4cd31b | Constantinos Venetsanopoulos | * Register that Image file to Plankton |
2055 | 8a4cd31b | Constantinos Venetsanopoulos | * Spawn a new VM from that Image from the Cyclades Web UI |
2056 | 8a4cd31b | Constantinos Venetsanopoulos | |
2057 | 34e79416 | Constantinos Venetsanopoulos | We will use the `kamaki <http://www.synnefo.org/docs/kamaki/latest/index.html>`_ |
2058 | 8a4cd31b | Constantinos Venetsanopoulos | command line client to do the uploading and registering of the Image. |
2059 | 8a4cd31b | Constantinos Venetsanopoulos | |
2060 | 8a4cd31b | Constantinos Venetsanopoulos | Installation of `kamaki` |
2061 | 8a4cd31b | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~ |
2062 | 8a4cd31b | Constantinos Venetsanopoulos | |
2063 | 8a4cd31b | Constantinos Venetsanopoulos | You can install `kamaki` anywhere you like, since it is a standalone client of |
2064 | 8a4cd31b | Constantinos Venetsanopoulos | the APIs and talks to the installation over `http`. For the purpose of this |
2065 | 8a4cd31b | Constantinos Venetsanopoulos | guide we will assume that we have downloaded the `Debian Squeeze Base Image |
2066 | 8a4cd31b | Constantinos Venetsanopoulos | <https://pithos.okeanos.grnet.gr/public/9epgb>`_ and stored it under node1's |
2067 | 8a4cd31b | Constantinos Venetsanopoulos | ``/srv/images`` directory. For that reason we will install `kamaki` on node1, |
2068 | 8a4cd31b | Constantinos Venetsanopoulos | too. We do this by running: |
2069 | 8a4cd31b | Constantinos Venetsanopoulos | |
2070 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2071 | 8a4cd31b | Constantinos Venetsanopoulos | |
2072 | 8a4cd31b | Constantinos Venetsanopoulos | # apt-get install kamaki |
2073 | 8a4cd31b | Constantinos Venetsanopoulos | |
2074 | 8a4cd31b | Constantinos Venetsanopoulos | Configuration of kamaki |
2075 | 8a4cd31b | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~ |
2076 | 8a4cd31b | Constantinos Venetsanopoulos | |
2077 | 8a4cd31b | Constantinos Venetsanopoulos | Now we need to setup kamaki, by adding the appropriate URLs and tokens of our |
2078 | 8a4cd31b | Constantinos Venetsanopoulos | installation. We do this by running: |
2079 | 8a4cd31b | Constantinos Venetsanopoulos | |
2080 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2081 | 8a4cd31b | Constantinos Venetsanopoulos | |
2082 | ebf463a5 | Stavros Sachtouris | $ kamaki config set user.url "https://node1.example.com" |
2083 | 69aa7f21 | Ilias Tsitsimpis | $ kamaki config set compute.url "https://node1.example.com/api/v1.1" |
2084 | 69aa7f21 | Ilias Tsitsimpis | $ kamaki config set image.url "https://node1.example.com/plankton" |
2085 | ebf463a5 | Stavros Sachtouris | $ kamaki config set file.url "https://node2.example.com/v1" |
2086 | ebf463a5 | Stavros Sachtouris | $ kamaki config set token USER_TOKEN |
2087 | 8a4cd31b | Constantinos Venetsanopoulos | |
2088 | ebf463a5 | Stavros Sachtouris | The USER_TOKEN appears on the user's `Profile` web page on the Astakos Web UI. |
2089 | 8a4cd31b | Constantinos Venetsanopoulos | |
2090 | c0d88cf3 | Constantinos Venetsanopoulos | You can see that the new configuration options have been applied correctly, |
2091 | c0d88cf3 | Constantinos Venetsanopoulos | either by checking the editable file ``~/.kamakirc`` or by running: |
2092 | 8a4cd31b | Constantinos Venetsanopoulos | |
2093 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2094 | 8a4cd31b | Constantinos Venetsanopoulos | |
2095 | 8a4cd31b | Constantinos Venetsanopoulos | $ kamaki config list |
2096 | 8a4cd31b | Constantinos Venetsanopoulos | |
2097 | c0d88cf3 | Constantinos Venetsanopoulos | A quick test to check that kamaki is configured correctly, is to try to |
2098 | c0d88cf3 | Constantinos Venetsanopoulos | authenticate a user based on his/her token (in this case the user is you): |
2099 | ebf463a5 | Stavros Sachtouris | |
2100 | ebf463a5 | Stavros Sachtouris | .. code-block:: console |
2101 | ebf463a5 | Stavros Sachtouris | |
2102 | ebf463a5 | Stavros Sachtouris | $ kamaki user authenticate |
2103 | ebf463a5 | Stavros Sachtouris | |
2104 | c0d88cf3 | Constantinos Venetsanopoulos | The above operation provides various user information, e.g. UUID (the unique |
2105 | c0d88cf3 | Constantinos Venetsanopoulos | user id) which might prove useful in some operations. |
2106 | ebf463a5 | Stavros Sachtouris | |
2107 | 8a4cd31b | Constantinos Venetsanopoulos | Upload an Image file to Pithos+ |
2108 | 8a4cd31b | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
2109 | 8a4cd31b | Constantinos Venetsanopoulos | |
2110 | 8a4cd31b | Constantinos Venetsanopoulos | Now, that we have set up `kamaki` we will upload the Image that we have |
2111 | 8a4cd31b | Constantinos Venetsanopoulos | downloaded and stored under ``/srv/images/``. Although we can upload the Image |
2112 | 8a4cd31b | Constantinos Venetsanopoulos | under the root ``Pithos`` container (as you may have done when uploading the |
2113 | 8a4cd31b | Constantinos Venetsanopoulos | Image from the Pithos+ Web UI), we will create a new container called ``images`` |
2114 | 8a4cd31b | Constantinos Venetsanopoulos | and store the Image under that container. We do this for two reasons: |
2115 | 8a4cd31b | Constantinos Venetsanopoulos | |
2116 | 8a4cd31b | Constantinos Venetsanopoulos | a) To demonstrate how to create containers other than the default ``Pithos``. |
2117 | 8a4cd31b | Constantinos Venetsanopoulos | This can be done only with the `kamaki` client and not through the Web UI. |
2118 | 8a4cd31b | Constantinos Venetsanopoulos | |
2119 | 8a4cd31b | Constantinos Venetsanopoulos | b) As a best organization practise, so that you won't have your Image files |
2120 | 8a4cd31b | Constantinos Venetsanopoulos | tangled along with all your other Pithos+ files and directory structures. |
2121 | 8a4cd31b | Constantinos Venetsanopoulos | |
2122 | 8a4cd31b | Constantinos Venetsanopoulos | We create the new ``images`` container by running: |
2123 | 8a4cd31b | Constantinos Venetsanopoulos | |
2124 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2125 | 8a4cd31b | Constantinos Venetsanopoulos | |
2126 | ebf463a5 | Stavros Sachtouris | $ kamaki file create images |
2127 | ebf463a5 | Stavros Sachtouris | |
2128 | c0d88cf3 | Constantinos Venetsanopoulos | To check if the container has been created, list all containers of your |
2129 | c0d88cf3 | Constantinos Venetsanopoulos | account: |
2130 | ebf463a5 | Stavros Sachtouris | |
2131 | ebf463a5 | Stavros Sachtouris | .. code-block:: console |
2132 | ebf463a5 | Stavros Sachtouris | |
2133 | ebf463a5 | Stavros Sachtouris | $ kamaki file list |
2134 | 8a4cd31b | Constantinos Venetsanopoulos | |
2135 | 8a4cd31b | Constantinos Venetsanopoulos | Then, we upload the Image file to that container: |
2136 | 8a4cd31b | Constantinos Venetsanopoulos | |
2137 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2138 | 8a4cd31b | Constantinos Venetsanopoulos | |
2139 | ebf463a5 | Stavros Sachtouris | $ kamaki file upload /srv/images/debian_base-6.0-7-x86_64.diskdump images |
2140 | 8a4cd31b | Constantinos Venetsanopoulos | |
2141 | c0d88cf3 | Constantinos Venetsanopoulos | The first is the local path and the second is the remote container on Pithos+. |
2142 | c0d88cf3 | Constantinos Venetsanopoulos | Check if the file has been uploaded, by listing the container contents: |
2143 | ebf463a5 | Stavros Sachtouris | |
2144 | ebf463a5 | Stavros Sachtouris | .. code-block:: console |
2145 | ebf463a5 | Stavros Sachtouris | |
2146 | ebf463a5 | Stavros Sachtouris | $ kamaki file list images |
2147 | ebf463a5 | Stavros Sachtouris | |
2148 | ebf463a5 | Stavros Sachtouris | Alternatively check if the new container and file appear on the Pithos+ Web UI. |
2149 | 8a4cd31b | Constantinos Venetsanopoulos | |
2150 | 8a4cd31b | Constantinos Venetsanopoulos | Register an existing Image file to Plankton |
2151 | 8a4cd31b | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
2152 | 8a4cd31b | Constantinos Venetsanopoulos | |
2153 | c0d88cf3 | Constantinos Venetsanopoulos | For the purposes of the following example, we assume that the user UUID is |
2154 | c0d88cf3 | Constantinos Venetsanopoulos | ``u53r-un1qu3-1d``. |
2155 | ebf463a5 | Stavros Sachtouris | |
2156 | ebf463a5 | Stavros Sachtouris | Once the Image file has been successfully uploaded on Pithos+ then we register |
2157 | 8a4cd31b | Constantinos Venetsanopoulos | it to Plankton (so that it becomes visible to Cyclades), by running: |
2158 | 8a4cd31b | Constantinos Venetsanopoulos | |
2159 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2160 | 8a4cd31b | Constantinos Venetsanopoulos | |
2161 | 69aa7f21 | Ilias Tsitsimpis | $ kamaki image register "Debian Base" \ |
2162 | c0d88cf3 | Constantinos Venetsanopoulos | pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump \ |
2163 | 69aa7f21 | Ilias Tsitsimpis | --public \ |
2164 | 69aa7f21 | Ilias Tsitsimpis | --disk-format=diskdump \ |
2165 | 69aa7f21 | Ilias Tsitsimpis | --property OSFAMILY=linux --property ROOT_PARTITION=1 \ |
2166 | 69aa7f21 | Ilias Tsitsimpis | --property description="Debian Squeeze Base System" \ |
2167 | 69aa7f21 | Ilias Tsitsimpis | --property size=451 --property kernel=2.6.32 --property GUI="No GUI" \ |
2168 | 8a4cd31b | Constantinos Venetsanopoulos | --property sortorder=1 --property USERS=root --property OS=debian |
2169 | 8a4cd31b | Constantinos Venetsanopoulos | |
2170 | 8a4cd31b | Constantinos Venetsanopoulos | This command registers the Pithos+ file |
2171 | ebf463a5 | Stavros Sachtouris | ``pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump`` as an |
2172 | 8a4cd31b | Constantinos Venetsanopoulos | Image in Plankton. This Image will be public (``--public``), so all users will |
2173 | 8a4cd31b | Constantinos Venetsanopoulos | be able to spawn VMs from it and is of type ``diskdump``. The first two |
2174 | 8a4cd31b | Constantinos Venetsanopoulos | properties (``OSFAMILY`` and ``ROOT_PARTITION``) are mandatory. All the rest |
2175 | 8a4cd31b | Constantinos Venetsanopoulos | properties are optional, but recommended, so that the Images appear nicely on |
2176 | 8a4cd31b | Constantinos Venetsanopoulos | the Cyclades Web UI. ``Debian Base`` will appear as the name of this Image. The |
2177 | 8a4cd31b | Constantinos Venetsanopoulos | ``OS`` property's valid values may be found in the ``IMAGE_ICONS`` variable |
2178 | 8a4cd31b | Constantinos Venetsanopoulos | inside the ``20-snf-cyclades-app-ui.conf`` configuration file. |
2179 | 8a4cd31b | Constantinos Venetsanopoulos | |
2180 | 8a4cd31b | Constantinos Venetsanopoulos | ``OSFAMILY`` and ``ROOT_PARTITION`` are mandatory because they will be passed |
2181 | 8a4cd31b | Constantinos Venetsanopoulos | from Plankton to Cyclades and then to Ganeti and `snf-image` (also see |
2182 | 8a4cd31b | Constantinos Venetsanopoulos | :ref:`previous section <ganeti-with-pithos-images>`). All other properties are |
2183 | 8a4cd31b | Constantinos Venetsanopoulos | used to show information on the Cyclades UI. |
2184 | 8a4cd31b | Constantinos Venetsanopoulos | |
2185 | 8a4cd31b | Constantinos Venetsanopoulos | Spawn a VM from the Cyclades Web UI |
2186 | 8a4cd31b | Constantinos Venetsanopoulos | ----------------------------------- |
2187 | 8a4cd31b | Constantinos Venetsanopoulos | |
2188 | 8a4cd31b | Constantinos Venetsanopoulos | If the registration completes successfully, then go to the Cyclades Web UI from |
2189 | 8a4cd31b | Constantinos Venetsanopoulos | your browser at: |
2190 | 8a4cd31b | Constantinos Venetsanopoulos | |
2191 | 8a4cd31b | Constantinos Venetsanopoulos | `https://node1.example.com/ui/` |
2192 | 8a4cd31b | Constantinos Venetsanopoulos | |
2193 | 8a4cd31b | Constantinos Venetsanopoulos | Click on the 'New Machine' button and the first step of the wizard will appear. |
2194 | 8a4cd31b | Constantinos Venetsanopoulos | Click on 'My Images' (right after 'System' Images) on the left pane of the |
2195 | 8a4cd31b | Constantinos Venetsanopoulos | wizard. Your previously registered Image "Debian Base" should appear under |
2196 | 8a4cd31b | Constantinos Venetsanopoulos | 'Available Images'. If not, something has gone wrong with the registration. Make |
2197 | 8a4cd31b | Constantinos Venetsanopoulos | sure you can see your Image file on the Pithos+ Web UI and ``kamaki image |
2198 | 8a4cd31b | Constantinos Venetsanopoulos | register`` returns successfully with all options and properties as shown above. |
2199 | 8a4cd31b | Constantinos Venetsanopoulos | |
2200 | 8a4cd31b | Constantinos Venetsanopoulos | If the Image appears on the list, select it and complete the wizard by selecting |
2201 | 8a4cd31b | Constantinos Venetsanopoulos | a flavor and a name for your VM. Then finish by clicking 'Create'. Make sure you |
2202 | 8a4cd31b | Constantinos Venetsanopoulos | write down your password, because you *WON'T* be able to retrieve it later. |
2203 | 8a4cd31b | Constantinos Venetsanopoulos | |
2204 | 8a4cd31b | Constantinos Venetsanopoulos | If everything was setup correctly, after a few minutes your new machine will go |
2205 | 8a4cd31b | Constantinos Venetsanopoulos | to state 'Running' and you will be able to use it. Click 'Console' to connect |
2206 | 8a4cd31b | Constantinos Venetsanopoulos | through VNC out of band, or click on the machine's icon to connect directly via |
2207 | 8a4cd31b | Constantinos Venetsanopoulos | SSH or RDP (for windows machines). |
2208 | 8a4cd31b | Constantinos Venetsanopoulos | |
2209 | 8a4cd31b | Constantinos Venetsanopoulos | Congratulations. You have successfully installed the whole Synnefo stack and |
2210 | 8a4cd31b | Constantinos Venetsanopoulos | connected all components. Go ahead in the next section to test the Network |
2211 | 8a4cd31b | Constantinos Venetsanopoulos | functionality from inside Cyclades and discover even more features. |
2212 | 8a4cd31b | Constantinos Venetsanopoulos | |
2213 | a96ec00f | Constantinos Venetsanopoulos | General Testing |
2214 | a96ec00f | Constantinos Venetsanopoulos | =============== |
2215 | 5b6feb88 | Vangelis Koukis | |
2216 | a96ec00f | Constantinos Venetsanopoulos | Notes |
2217 | a96ec00f | Constantinos Venetsanopoulos | ===== |