root / docs / quick-install-admin-guide.rst @ 169f7d38
History | View | Annotate | Download (63.8 kB)
1 |
.. _quick-install-admin-guide: |
---|---|
2 |
|
3 |
Administrator's Quick Installation Guide |
4 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
5 |
|
6 |
This is the Administrator's quick installation guide. |
7 |
|
8 |
It describes how to install the whole synnefo stack on two (2) physical nodes, |
9 |
with minimum configuration. It installs synnefo from Debian packages, and |
10 |
assumes the nodes run Debian Squeeze. After successful installation, you will |
11 |
have the following services running: |
12 |
|
13 |
* Identity Management (Astakos) |
14 |
* Object Storage Service (Pithos+) |
15 |
* Compute Service (Cyclades) |
16 |
* Image Registry Service (Plankton) |
17 |
|
18 |
and a single unified Web UI to manage them all. |
19 |
|
20 |
The Volume Storage Service (Archipelago) and the Billing Service (Aquarium) are |
21 |
not released yet. |
22 |
|
23 |
If you just want to install the Object Storage Service (Pithos+), follow the guide |
24 |
and just stop after the "Testing of Pithos+" section. |
25 |
|
26 |
|
27 |
Installation of Synnefo / Introduction |
28 |
====================================== |
29 |
|
30 |
We will install the services with the above list's order. Cyclades and Plankton |
31 |
will be installed in a single step (at the end), because at the moment they are |
32 |
contained in the same software component. Furthermore, we will install all |
33 |
services in the first physical node, except Pithos+ which will be installed in |
34 |
the second, due to a conflict between the snf-pithos-app and snf-cyclades-app |
35 |
component (scheduled to be fixed in the next version). |
36 |
|
37 |
For the rest of the documentation we will refer to the first physical node as |
38 |
"node1" and the second as "node2". We will also assume that their domain names |
39 |
are "node1.example.com" and "node2.example.com" and their IPs are "4.3.2.1" and |
40 |
"4.3.2.2" respectively. |
41 |
|
42 |
|
43 |
General Prerequisites |
44 |
===================== |
45 |
|
46 |
These are the general synnefo prerequisites, that you need on node1 and node2 |
47 |
and are related to all the services (Astakos, Pithos+, Cyclades, Plankton). |
48 |
|
49 |
To be able to download all synnefo components you need to add the following |
50 |
lines in your ``/etc/apt/sources.list`` file: |
51 |
|
52 |
| ``deb http://apt.dev.grnet.gr squeeze main`` |
53 |
| ``deb-src http://apt.dev.grnet.gr squeeze main`` |
54 |
|
55 |
Also add the following line to enable the ``squeeze-backports`` repository, |
56 |
which may provide more recent versions of certain packages. The repository |
57 |
is deactivated by default and must be specified expicitly in ``apt-get`` |
58 |
operations: |
59 |
|
60 |
| ``deb http://backports.debian.org/debian-backports squeeze-backports main`` |
61 |
|
62 |
You also need a shared directory visible by both nodes. Pithos+ will save all |
63 |
data inside this directory. By 'all data', we mean files, images, and pithos |
64 |
specific mapping data. If you plan to upload more than one basic image, this |
65 |
directory should have at least 50GB of free space. During this guide, we will |
66 |
assume that node1 acts as an NFS server and serves the directory ``/srv/pithos`` |
67 |
to node2. Node2 has this directory mounted under ``/srv/pithos``, too. |
68 |
|
69 |
Before starting the synnefo installation, you will need basic third party |
70 |
software to be installed and configured on the physical nodes. We will describe |
71 |
each node's general prerequisites separately. Any additional configuration, |
72 |
specific to a synnefo service for each node, will be described at the service's |
73 |
section. |
74 |
|
75 |
Node1 |
76 |
----- |
77 |
|
78 |
General Synnefo dependencies |
79 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
80 |
|
81 |
* apache (http server) |
82 |
* gunicorn (WSGI http server) |
83 |
* postgresql (database) |
84 |
* rabbitmq (message queue) |
85 |
|
86 |
You can install the above by running: |
87 |
|
88 |
.. code-block:: console |
89 |
|
90 |
# apt-get install apache2 postgresql rabbitmq-server |
91 |
|
92 |
Make sure to install gunicorn >= v0.12.2. You can do this by installing from |
93 |
the official debian backports: |
94 |
|
95 |
.. code-block:: console |
96 |
|
97 |
# apt-get -t squeeze-backports install gunicorn |
98 |
|
99 |
On node1, we will create our databases, so you will also need the |
100 |
python-psycopg2 package: |
101 |
|
102 |
.. code-block:: console |
103 |
|
104 |
# apt-get install python-psycopg2 |
105 |
|
106 |
Database setup |
107 |
~~~~~~~~~~~~~~ |
108 |
|
109 |
On node1, we create a database called ``snf_apps``, that will host all django |
110 |
apps related tables. We also create the user ``synnefo`` and grant him all |
111 |
privileges on the database. We do this by running: |
112 |
|
113 |
.. code-block:: console |
114 |
|
115 |
root@node1:~ # su - postgres |
116 |
postgres@node1:~ $ psql |
117 |
postgres=# CREATE DATABASE snf_apps WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0; |
118 |
postgres=# CREATE USER synnefo WITH PASSWORD 'example_passw0rd'; |
119 |
postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_apps TO synnefo; |
120 |
|
121 |
We also create the database ``snf_pithos`` needed by the pithos+ backend and |
122 |
grant the ``synnefo`` user all privileges on the database. This database could |
123 |
be created on node2 instead, but we do it on node1 for simplicity. We will |
124 |
create all needed databases on node1 and then node2 will connect to them. |
125 |
|
126 |
.. code-block:: console |
127 |
|
128 |
postgres=# CREATE DATABASE snf_pithos WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0; |
129 |
postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_pithos TO synnefo; |
130 |
|
131 |
Configure the database to listen to all network interfaces. You can do this by |
132 |
editting the file ``/etc/postgresql/8.4/main/postgresql.conf`` and change |
133 |
``listen_addresses`` to ``'*'`` : |
134 |
|
135 |
.. code-block:: console |
136 |
|
137 |
listen_addresses = '*' |
138 |
|
139 |
Furthermore, edit ``/etc/postgresql/8.4/main/pg_hba.conf`` to allow node1 and |
140 |
node2 to connect to the database. Add the following lines under ``#IPv4 local |
141 |
connections:`` : |
142 |
|
143 |
.. code-block:: console |
144 |
|
145 |
host all all 4.3.2.1/32 md5 |
146 |
host all all 4.3.2.2/32 md5 |
147 |
|
148 |
Make sure to substitute "4.3.2.1" and "4.3.2.2" with node1's and node2's |
149 |
actual IPs. Now, restart the server to apply the changes: |
150 |
|
151 |
.. code-block:: console |
152 |
|
153 |
# /etc/init.d/postgresql restart |
154 |
|
155 |
Gunicorn setup |
156 |
~~~~~~~~~~~~~~ |
157 |
|
158 |
Create the file ``synnefo`` under ``/etc/gunicorn.d/`` containing the following: |
159 |
|
160 |
.. code-block:: console |
161 |
|
162 |
CONFIG = { |
163 |
'mode': 'django', |
164 |
'environment': { |
165 |
'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
166 |
}, |
167 |
'working_dir': '/etc/synnefo', |
168 |
'user': 'www-data', |
169 |
'group': 'www-data', |
170 |
'args': ( |
171 |
'--bind=127.0.0.1:8080', |
172 |
'--workers=4', |
173 |
'--log-level=debug', |
174 |
), |
175 |
} |
176 |
|
177 |
.. warning:: Do NOT start the server yet, because it won't find the |
178 |
``synnefo.settings`` module. We will start the server after successful |
179 |
installation of astakos. If the server is running:: |
180 |
|
181 |
# /etc/init.d/gunicorn stop |
182 |
|
183 |
Apache2 setup |
184 |
~~~~~~~~~~~~~ |
185 |
|
186 |
Create the file ``synnefo`` under ``/etc/apache2/sites-available/`` containing |
187 |
the following: |
188 |
|
189 |
.. code-block:: console |
190 |
|
191 |
<VirtualHost *:80> |
192 |
ServerName node1.example.com |
193 |
|
194 |
RewriteEngine On |
195 |
RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
196 |
RewriteRule ^(.*)$ - [F,L] |
197 |
RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
198 |
</VirtualHost> |
199 |
|
200 |
Create the file ``synnefo-ssl`` under ``/etc/apache2/sites-available/`` |
201 |
containing the following: |
202 |
|
203 |
.. code-block:: console |
204 |
|
205 |
<IfModule mod_ssl.c> |
206 |
<VirtualHost _default_:443> |
207 |
ServerName node1.example.com |
208 |
|
209 |
Alias /static "/usr/share/synnefo/static" |
210 |
|
211 |
# SetEnv no-gzip |
212 |
# SetEnv dont-vary |
213 |
|
214 |
AllowEncodedSlashes On |
215 |
|
216 |
RequestHeader set X-Forwarded-Protocol "https" |
217 |
|
218 |
<Proxy * > |
219 |
Order allow,deny |
220 |
Allow from all |
221 |
</Proxy> |
222 |
|
223 |
SetEnv proxy-sendchunked |
224 |
SSLProxyEngine off |
225 |
ProxyErrorOverride off |
226 |
|
227 |
ProxyPass /static ! |
228 |
ProxyPass / http://localhost:8080/ retry=0 |
229 |
ProxyPassReverse / http://localhost:8080/ |
230 |
|
231 |
RewriteEngine On |
232 |
RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
233 |
RewriteRule ^(.*)$ - [F,L] |
234 |
RewriteRule ^/login(.*) /im/login/redirect$1 [PT,NE] |
235 |
|
236 |
SSLEngine on |
237 |
SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem |
238 |
SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key |
239 |
</VirtualHost> |
240 |
</IfModule> |
241 |
|
242 |
Now enable sites and modules by running: |
243 |
|
244 |
.. code-block:: console |
245 |
|
246 |
# a2enmod ssl |
247 |
# a2enmod rewrite |
248 |
# a2dissite default |
249 |
# a2ensite synnefo |
250 |
# a2ensite synnefo-ssl |
251 |
# a2enmod headers |
252 |
# a2enmod proxy_http |
253 |
|
254 |
.. warning:: Do NOT start/restart the server yet. If the server is running:: |
255 |
|
256 |
# /etc/init.d/apache2 stop |
257 |
|
258 |
.. _rabbitmq-setup: |
259 |
|
260 |
Message Queue setup |
261 |
~~~~~~~~~~~~~~~~~~~ |
262 |
|
263 |
The message queue will run on node1, so we need to create the appropriate |
264 |
rabbitmq user. The user is named ``synnefo`` and gets full privileges on all |
265 |
exchanges: |
266 |
|
267 |
.. code-block:: console |
268 |
|
269 |
# rabbitmqctl add_user synnefo "examle_rabbitmq_passw0rd" |
270 |
# rabbitmqctl set_permissions synnefo ".*" ".*" ".*" |
271 |
|
272 |
We do not need to initialize the exchanges. This will be done automatically, |
273 |
during the Cyclades setup. |
274 |
|
275 |
Pithos+ data directory setup |
276 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
277 |
|
278 |
As mentioned in the General Prerequisites section, there is a directory called |
279 |
``/srv/pithos`` visible by both nodes. We create and setup the ``data`` |
280 |
directory inside it: |
281 |
|
282 |
.. code-block:: console |
283 |
|
284 |
# cd /srv/pithos |
285 |
# mkdir data |
286 |
# chown www-data:www-data data |
287 |
# chmod g+ws data |
288 |
|
289 |
You are now ready with all general prerequisites concerning node1. Let's go to |
290 |
node2. |
291 |
|
292 |
Node2 |
293 |
----- |
294 |
|
295 |
General Synnefo dependencies |
296 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
297 |
|
298 |
* apache (http server) |
299 |
* gunicorn (WSGI http server) |
300 |
* postgresql (database) |
301 |
|
302 |
You can install the above by running: |
303 |
|
304 |
.. code-block:: console |
305 |
|
306 |
# apt-get install apache2 postgresql |
307 |
|
308 |
Make sure to install gunicorn >= v0.12.2. You can do this by installing from |
309 |
the official debian backports: |
310 |
|
311 |
.. code-block:: console |
312 |
|
313 |
# apt-get -t squeeze-backports install gunicorn |
314 |
|
315 |
Node2 will connect to the databases on node1, so you will also need the |
316 |
python-psycopg2 package: |
317 |
|
318 |
.. code-block:: console |
319 |
|
320 |
# apt-get install python-psycopg2 |
321 |
|
322 |
Database setup |
323 |
~~~~~~~~~~~~~~ |
324 |
|
325 |
All databases have been created and setup on node1, so we do not need to take |
326 |
any action here. From node2, we will just connect to them. When you get familiar |
327 |
with the software you may choose to run different databases on different nodes, |
328 |
for performance/scalability/redundancy reasons, but those kind of setups are out |
329 |
of the purpose of this guide. |
330 |
|
331 |
Gunicorn setup |
332 |
~~~~~~~~~~~~~~ |
333 |
|
334 |
Create the file ``synnefo`` under ``/etc/gunicorn.d/`` containing the following |
335 |
(same contents as in node1; you can just copy/paste the file): |
336 |
|
337 |
.. code-block:: console |
338 |
|
339 |
CONFIG = { |
340 |
'mode': 'django', |
341 |
'environment': { |
342 |
'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
343 |
}, |
344 |
'working_dir': '/etc/synnefo', |
345 |
'user': 'www-data', |
346 |
'group': 'www-data', |
347 |
'args': ( |
348 |
'--bind=127.0.0.1:8080', |
349 |
'--workers=4', |
350 |
'--log-level=debug', |
351 |
'--timeout=43200' |
352 |
), |
353 |
} |
354 |
|
355 |
.. warning:: Do NOT start the server yet, because it won't find the |
356 |
``synnefo.settings`` module. We will start the server after successful |
357 |
installation of astakos. If the server is running:: |
358 |
|
359 |
# /etc/init.d/gunicorn stop |
360 |
|
361 |
Apache2 setup |
362 |
~~~~~~~~~~~~~ |
363 |
|
364 |
Create the file ``synnefo`` under ``/etc/apache2/sites-available/`` containing |
365 |
the following: |
366 |
|
367 |
.. code-block:: console |
368 |
|
369 |
<VirtualHost *:80> |
370 |
ServerName node2.example.com |
371 |
|
372 |
RewriteEngine On |
373 |
RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
374 |
RewriteRule ^(.*)$ - [F,L] |
375 |
RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
376 |
</VirtualHost> |
377 |
|
378 |
Create the file ``synnefo-ssl`` under ``/etc/apache2/sites-available/`` |
379 |
containing the following: |
380 |
|
381 |
.. code-block:: console |
382 |
|
383 |
<IfModule mod_ssl.c> |
384 |
<VirtualHost _default_:443> |
385 |
ServerName node2.example.com |
386 |
|
387 |
Alias /static "/usr/share/synnefo/static" |
388 |
|
389 |
SetEnv no-gzip |
390 |
SetEnv dont-vary |
391 |
AllowEncodedSlashes On |
392 |
|
393 |
RequestHeader set X-Forwarded-Protocol "https" |
394 |
|
395 |
<Proxy * > |
396 |
Order allow,deny |
397 |
Allow from all |
398 |
</Proxy> |
399 |
|
400 |
SetEnv proxy-sendchunked |
401 |
SSLProxyEngine off |
402 |
ProxyErrorOverride off |
403 |
|
404 |
ProxyPass /static ! |
405 |
ProxyPass / http://localhost:8080/ retry=0 |
406 |
ProxyPassReverse / http://localhost:8080/ |
407 |
|
408 |
SSLEngine on |
409 |
SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem |
410 |
SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key |
411 |
</VirtualHost> |
412 |
</IfModule> |
413 |
|
414 |
As in node1, enable sites and modules by running: |
415 |
|
416 |
.. code-block:: console |
417 |
|
418 |
# a2enmod ssl |
419 |
# a2enmod rewrite |
420 |
# a2dissite default |
421 |
# a2ensite synnefo |
422 |
# a2ensite synnefo-ssl |
423 |
# a2enmod headers |
424 |
# a2enmod proxy_http |
425 |
|
426 |
.. warning:: Do NOT start/restart the server yet. If the server is running:: |
427 |
|
428 |
# /etc/init.d/apache2 stop |
429 |
|
430 |
We are now ready with all general prerequisites for node2. Now that we have |
431 |
finished with all general prerequisites for both nodes, we can start installing |
432 |
the services. First, let's install Astakos on node1. |
433 |
|
434 |
|
435 |
Installation of Astakos on node1 |
436 |
================================ |
437 |
|
438 |
To install astakos, grab the package from our repository (make sure you made |
439 |
the additions needed in your ``/etc/apt/sources.list`` file, as described |
440 |
previously), by running: |
441 |
|
442 |
.. code-block:: console |
443 |
|
444 |
# apt-get install snf-astakos-app |
445 |
|
446 |
After successful installation of snf-astakos-app, make sure that also |
447 |
snf-webproject has been installed (marked as "Recommended" package). By default |
448 |
Debian installs "Recommended" packages, but if you have changed your |
449 |
configuration and the package didn't install automatically, you should |
450 |
explicitly install it manually running: |
451 |
|
452 |
.. code-block:: console |
453 |
|
454 |
# apt-get install snf-webproject |
455 |
|
456 |
The reason snf-webproject is "Recommended" and not a hard dependency, is to give |
457 |
the experienced administrator the ability to install synnefo in a custom made |
458 |
django project. This corner case concerns only very advanced users that know |
459 |
what they are doing and want to experiment with synnefo. |
460 |
|
461 |
|
462 |
.. _conf-astakos: |
463 |
|
464 |
Configuration of Astakos |
465 |
======================== |
466 |
|
467 |
Conf Files |
468 |
---------- |
469 |
|
470 |
After astakos is successfully installed, you will find the directory |
471 |
``/etc/synnefo`` and some configuration files inside it. The files contain |
472 |
commented configuration options, which are the default options. While installing |
473 |
new snf-* components, new configuration files will appear inside the directory. |
474 |
In this guide (and for all services), we will edit only the minimum necessary |
475 |
configuration options, to reflect our setup. Everything else will remain as is. |
476 |
|
477 |
After getting familiar with synnefo, you will be able to customize the software |
478 |
as you wish and fits your needs. Many options are available, to empower the |
479 |
administrator with extensively customizable setups. |
480 |
|
481 |
For the snf-webproject component (installed as an astakos dependency), we |
482 |
need the following: |
483 |
|
484 |
Edit ``/etc/synnefo/10-snf-webproject-database.conf``. You will need to |
485 |
uncomment and edit the ``DATABASES`` block to reflect our database: |
486 |
|
487 |
.. code-block:: console |
488 |
|
489 |
DATABASES = { |
490 |
'default': { |
491 |
# 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle' |
492 |
'ENGINE': 'postgresql_psycopg2', |
493 |
# ATTENTION: This *must* be the absolute path if using sqlite3. |
494 |
# See: http://docs.djangoproject.com/en/dev/ref/settings/#name |
495 |
'NAME': 'snf_apps', |
496 |
'USER': 'synnefo', # Not used with sqlite3. |
497 |
'PASSWORD': 'examle_passw0rd', # Not used with sqlite3. |
498 |
# Set to empty string for localhost. Not used with sqlite3. |
499 |
'HOST': '4.3.2.1', |
500 |
# Set to empty string for default. Not used with sqlite3. |
501 |
'PORT': '5432', |
502 |
} |
503 |
} |
504 |
|
505 |
Edit ``/etc/synnefo/10-snf-webproject-deploy.conf``. Uncomment and edit |
506 |
``SECRET_KEY``. This is a django specific setting which is used to provide a |
507 |
seed in secret-key hashing algorithms. Set this to a random string of your |
508 |
choise and keep it private: |
509 |
|
510 |
.. code-block:: console |
511 |
|
512 |
SECRET_KEY = 'sy6)mw6a7x%n)-example_secret_key#zzk4jo6f2=uqu!1o%)' |
513 |
|
514 |
For astakos specific configuration, edit the following options in |
515 |
``/etc/synnefo/20-snf-astakos-app-settings.conf`` : |
516 |
|
517 |
.. code-block:: console |
518 |
|
519 |
ASTAKOS_IM_MODULES = ['local'] |
520 |
|
521 |
ASTAKOS_COOKIE_DOMAIN = '.example.com' |
522 |
|
523 |
ASTAKOS_BASEURL = 'https://node1.example.com' |
524 |
|
525 |
ASTAKOS_SITENAME = '~okeanos demo example' |
526 |
|
527 |
ASTAKOS_RECAPTCHA_PUBLIC_KEY = 'example_recaptcha_public_key!@#$%^&*(' |
528 |
ASTAKOS_RECAPTCHA_PRIVATE_KEY = 'example_recaptcha_private_key!@#$%^&*(' |
529 |
|
530 |
ASTAKOS_RECAPTCHA_USE_SSL = True |
531 |
|
532 |
``ASTAKOS_IM_MODULES`` refers to the astakos login methods. For now only local |
533 |
is supported. The ``ASTAKOS_COOKIE_DOMAIN`` should be the base url of our |
534 |
domain (for all services). ``ASTAKOS_BASEURL`` is the astakos home page. |
535 |
|
536 |
For the ``ASTAKOS_RECAPTCHA_PUBLIC_KEY`` and ``ASTAKOS_RECAPTCHA_PRIVATE_KEY`` |
537 |
go to https://www.google.com/recaptcha/admin/create and create your own pair. |
538 |
|
539 |
Then edit ``/etc/synnefo/20-snf-astakos-app-cloudbar.conf`` : |
540 |
|
541 |
.. code-block:: console |
542 |
|
543 |
CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
544 |
|
545 |
CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services' |
546 |
|
547 |
CLOUDBAR_MENU_URL = 'https://node1.example.com/im/get_menu' |
548 |
|
549 |
Those settings have to do with the black cloudbar endpoints and will be described |
550 |
in more detail later on in this guide. For now, just edit the domain to point at |
551 |
node1 which is where we have installed Astakos. |
552 |
|
553 |
If you are an advanced user and want to use the Shibboleth Authentication method, |
554 |
read the relative :ref:`section <shibboleth-auth>`. |
555 |
|
556 |
Database Initialization |
557 |
----------------------- |
558 |
|
559 |
After configuration is done, we initialize the database by running: |
560 |
|
561 |
.. code-block:: console |
562 |
|
563 |
# snf-manage syncdb |
564 |
|
565 |
At this example we don't need to create a django superuser, so we select |
566 |
``[no]`` to the question. After a successful sync, we run the migration needed |
567 |
for astakos: |
568 |
|
569 |
.. code-block:: console |
570 |
|
571 |
# snf-manage migrate im |
572 |
|
573 |
Then, we load the pre-defined user groups |
574 |
|
575 |
.. code-block:: console |
576 |
|
577 |
# snf-manage loaddata groups |
578 |
|
579 |
.. _services-reg: |
580 |
|
581 |
Services Registration |
582 |
--------------------- |
583 |
|
584 |
When the database is ready, we configure the elements of the Astakos cloudbar, |
585 |
to point to our future services: |
586 |
|
587 |
.. code-block:: console |
588 |
|
589 |
# snf-manage service_add "~okeanos home" https://node1.example.com/im/ home-icon.png |
590 |
# snf-manage service_add "cyclades" https://node1.example.com/ui/ |
591 |
# snf-manage service_add "pithos+" https://node2.example.com/ui/ |
592 |
|
593 |
Servers Initialization |
594 |
---------------------- |
595 |
|
596 |
Finally, we initialize the servers on node1: |
597 |
|
598 |
.. code-block:: console |
599 |
|
600 |
root@node1:~ # /etc/init.d/gunicorn restart |
601 |
root@node1:~ # /etc/init.d/apache2 restart |
602 |
|
603 |
We have now finished the Astakos setup. Let's test it now. |
604 |
|
605 |
|
606 |
Testing of Astakos |
607 |
================== |
608 |
|
609 |
Open your favorite browser and go to: |
610 |
|
611 |
``http://node1.example.com/im`` |
612 |
|
613 |
If this redirects you to ``https://node1.example.com/im`` and you can see |
614 |
the "welcome" door of Astakos, then you have successfully setup Astakos. |
615 |
|
616 |
Let's create our first user. At the homepage click the "CREATE ACCOUNT" button |
617 |
and fill all your data at the sign up form. Then click "SUBMIT". You should now |
618 |
see a green box on the top, which informs you that you made a successful request |
619 |
and the request has been sent to the administrators. So far so good, let's assume |
620 |
that you created the user with username ``user@example.com``. |
621 |
|
622 |
Now we need to activate that user. Return to a command prompt at node1 and run: |
623 |
|
624 |
.. code-block:: console |
625 |
|
626 |
root@node1:~ # snf-manage user_list |
627 |
|
628 |
This command should show you a list with only one user; the one we just created. |
629 |
This user should have an id with a value of ``1``. It should also have an |
630 |
"active" status with the value of ``0`` (inactive). Now run: |
631 |
|
632 |
.. code-block:: console |
633 |
|
634 |
root@node1:~ # snf-manage user_update --set-active 1 |
635 |
|
636 |
This modifies the active value to ``1``, and actually activates the user. |
637 |
When running in production, the activation is done automatically with different |
638 |
types of moderation, that Astakos supports. You can see the moderation methods |
639 |
(by invitation, whitelists, matching regexp, etc.) at the Astakos specific |
640 |
documentation. In production, you can also manually activate a user, by sending |
641 |
him/her an activation email. See how to do this at the :ref:`User |
642 |
activation <user_activation>` section. |
643 |
|
644 |
Now let's go back to the homepage. Open ``http://node1.example.com/im`` with |
645 |
your browser again. Try to sign in using your new credentials. If the astakos |
646 |
menu appears and you can see your profile, then you have successfully setup |
647 |
Astakos. |
648 |
|
649 |
Let's continue to install Pithos+ now. |
650 |
|
651 |
|
652 |
Installation of Pithos+ on node2 |
653 |
================================ |
654 |
|
655 |
To install pithos+, grab the packages from our repository (make sure you made |
656 |
the additions needed in your ``/etc/apt/sources.list`` file, as described |
657 |
previously), by running: |
658 |
|
659 |
.. code-block:: console |
660 |
|
661 |
# apt-get install snf-pithos-app |
662 |
|
663 |
After successful installation of snf-pithos-app, make sure that also |
664 |
snf-webproject has been installed (marked as "Recommended" package). Refer to |
665 |
the "Installation of Astakos on node1" section, if you don't remember why this |
666 |
should happen. Now, install the pithos web interface: |
667 |
|
668 |
.. code-block:: console |
669 |
|
670 |
# apt-get install snf-pithos-webclient |
671 |
|
672 |
This package provides the standalone pithos web client. The web client is the |
673 |
web UI for pithos+ and will be accessible by clicking "pithos+" on the Astakos |
674 |
interface's cloudbar, at the top of the Astakos homepage. |
675 |
|
676 |
|
677 |
.. _conf-pithos: |
678 |
|
679 |
Configuration of Pithos+ |
680 |
======================== |
681 |
|
682 |
Conf Files |
683 |
---------- |
684 |
|
685 |
After pithos+ is successfully installed, you will find the directory |
686 |
``/etc/synnefo`` and some configuration files inside it, as you did in node1 |
687 |
after installation of astakos. Here, you will not have to change anything that |
688 |
has to do with snf-common or snf-webproject. Everything is set at node1. You |
689 |
only need to change settings that have to do with pithos+. Specifically: |
690 |
|
691 |
Edit ``/etc/synnefo/20-snf-pithos-app-settings.conf``. There you need to set |
692 |
only the two options: |
693 |
|
694 |
.. code-block:: console |
695 |
|
696 |
PITHOS_BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos' |
697 |
|
698 |
PITHOS_BACKEND_BLOCK_PATH = '/srv/pithos/data' |
699 |
|
700 |
PITHOS_AUTHENTICATION_URL = 'https://node1.example.com/im/authenticate' |
701 |
PITHOS_AUTHENTICATION_USERS = None |
702 |
|
703 |
PITHOS_SERVICE_TOKEN = 'pithos_service_token22w==' |
704 |
|
705 |
The ``PITHOS_BACKEND_DB_CONNECTION`` option tells to the pithos+ app where to |
706 |
find the pithos+ backend database. Above we tell pithos+ that its database is |
707 |
``snf_pithos`` at node1 and to connect as user ``synnefo`` with password |
708 |
``example_passw0rd``. All those settings where setup during node1's "Database |
709 |
setup" section. |
710 |
|
711 |
The ``PITHOS_BACKEND_BLOCK_PATH`` option tells to the pithos+ app where to find |
712 |
the pithos+ backend data. Above we tell pithos+ to store its data under |
713 |
``/srv/pithos/data``, which is visible by both nodes. We have already setup this |
714 |
directory at node1's "Pithos+ data directory setup" section. |
715 |
|
716 |
The ``PITHOS_AUTHENTICATION_URL`` option tells to the pithos+ app in which URI |
717 |
is available the astakos authentication api. If not set, pithos+ tries to |
718 |
authenticate using the ``PITHOS_AUTHENTICATION_USERS`` user pool. |
719 |
|
720 |
The ``PITHOS_SERVICE_TOKEN`` should be the Pithos+ token returned by running on |
721 |
the Astakos node (node1 in our case): |
722 |
|
723 |
.. code-block:: console |
724 |
|
725 |
# snf-manage service_list |
726 |
|
727 |
The token has been generated automatically during the :ref:`Pithos+ service |
728 |
registration <services-reg>`. |
729 |
|
730 |
Then we need to setup the web UI and connect it to astakos. To do so, edit |
731 |
``/etc/synnefo/20-snf-pithos-webclient-settings.conf``: |
732 |
|
733 |
.. code-block:: console |
734 |
|
735 |
PITHOS_UI_LOGIN_URL = "https://node1.example.com/im/login?next=" |
736 |
PITHOS_UI_FEEDBACK_URL = "https://node1.example.com/im/feedback" |
737 |
|
738 |
The ``PITHOS_UI_LOGIN_URL`` option tells the client where to redirect you, if |
739 |
you are not logged in. The ``PITHOS_UI_FEEDBACK_URL`` option points at the |
740 |
pithos+ feedback form. Astakos already provides a generic feedback form for all |
741 |
services, so we use this one. |
742 |
|
743 |
Then edit ``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf``, to connect the |
744 |
pithos+ web UI with the astakos web UI (through the top cloudbar): |
745 |
|
746 |
.. code-block:: console |
747 |
|
748 |
CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
749 |
PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE = '3' |
750 |
CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services' |
751 |
CLOUDBAR_MENU_URL = 'https://node1.example.com/im/get_menu' |
752 |
|
753 |
The ``CLOUDBAR_LOCATION`` tells the client where to find the astakos common |
754 |
cloudbar. |
755 |
|
756 |
The ``PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE`` points to an already registered |
757 |
Astakos service. You can see all :ref:`registered services <services-reg>` by |
758 |
running on the Astakos node (node1): |
759 |
|
760 |
.. code-block:: console |
761 |
|
762 |
# snf-manage service_list |
763 |
|
764 |
The value of ``PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE`` should be the pithos service's |
765 |
``id`` as shown by the above command, in our case ``3``. |
766 |
|
767 |
The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are used by the |
768 |
pithos+ web client to get from astakos all the information needed to fill its |
769 |
own cloudbar. So we put our astakos deployment urls there. |
770 |
|
771 |
Servers Initialization |
772 |
---------------------- |
773 |
|
774 |
After configuration is done, we initialize the servers on node2: |
775 |
|
776 |
.. code-block:: console |
777 |
|
778 |
root@node2:~ # /etc/init.d/gunicorn restart |
779 |
root@node2:~ # /etc/init.d/apache2 restart |
780 |
|
781 |
You have now finished the Pithos+ setup. Let's test it now. |
782 |
|
783 |
|
784 |
Testing of Pithos+ |
785 |
================== |
786 |
|
787 |
Open your browser and go to the Astakos homepage: |
788 |
|
789 |
``http://node1.example.com/im`` |
790 |
|
791 |
Login, and you will see your profile page. Now, click the "pithos+" link on the |
792 |
top black cloudbar. If everything was setup correctly, this will redirect you |
793 |
to: |
794 |
|
795 |
``https://node2.example.com/ui`` |
796 |
|
797 |
and you will see the blue interface of the Pithos+ application. Click the |
798 |
orange "Upload" button and upload your first file. If the file gets uploaded |
799 |
successfully, then this is your first sign of a successful Pithos+ installation. |
800 |
Go ahead and experiment with the interface to make sure everything works |
801 |
correctly. |
802 |
|
803 |
You can also use the Pithos+ clients to sync data from your Windows PC or MAC. |
804 |
|
805 |
If you don't stumble on any problems, then you have successfully installed |
806 |
Pithos+, which you can use as a standalone File Storage Service. |
807 |
|
808 |
If you would like to do more, such as: |
809 |
|
810 |
* Spawning VMs |
811 |
* Spawning VMs from Images stored on Pithos+ |
812 |
* Uploading your custom Images to Pithos+ |
813 |
* Spawning VMs from those custom Images |
814 |
* Registering existing Pithos+ files as Images |
815 |
* Connect VMs to the Internet |
816 |
* Create Private Networks |
817 |
* Add VMs to Private Networks |
818 |
|
819 |
please continue with the rest of the guide. |
820 |
|
821 |
|
822 |
Cyclades (and Plankton) Prerequisites |
823 |
===================================== |
824 |
|
825 |
Before proceeding with the Cyclades (and Plankton) installation, make sure you |
826 |
have successfully set up Astakos and Pithos+ first, because Cyclades depends |
827 |
on them. If you don't have a working Astakos and Pithos+ installation yet, |
828 |
please return to the :ref:`top <quick-install-admin-guide>` of this guide. |
829 |
|
830 |
Besides Astakos and Pithos+, you will also need a number of additional working |
831 |
prerequisites, before you start the Cyclades installation. |
832 |
|
833 |
Ganeti |
834 |
------ |
835 |
|
836 |
`Ganeti <http://code.google.com/p/ganeti/>`_ handles the low level VM management |
837 |
for Cyclades, so Cyclades requires a working Ganeti installation at the backend. |
838 |
Please refer to the |
839 |
`ganeti documentation <http://docs.ganeti.org/ganeti/2.5/html>`_ for all the |
840 |
gory details. A successful Ganeti installation concludes with a working |
841 |
:ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs |
842 |
<GANETI_NODES>`. |
843 |
|
844 |
The above Ganeti cluster can run on different physical machines than node1 and |
845 |
node2 and can scale independently, according to your needs. |
846 |
|
847 |
For the purpose of this guide, we will assume that the :ref:`GANETI-MASTER |
848 |
<GANETI_NODES>` runs on node1 and is VM-capable. Also, node2 is a |
849 |
:ref:`GANETI-NODE <GANETI_NODES>` and is Master-capable and VM-capable too. |
850 |
|
851 |
We highly recommend that you read the official Ganeti documentation, if you are |
852 |
not familiar with Ganeti. If you are extremely impatient, you can result with |
853 |
the above assumed setup by running: |
854 |
|
855 |
.. code-block:: console |
856 |
|
857 |
root@node1:~ # apt-get install ganeti2 |
858 |
root@node1:~ # apt-get install ganeti-htools |
859 |
root@node2:~ # apt-get install ganeti2 |
860 |
root@node2:~ # apt-get install ganeti-htools |
861 |
|
862 |
We assume that Ganeti will use the KVM hypervisor. After installing Ganeti on |
863 |
both nodes, choose a domain name that resolves to a valid floating IP (let's say |
864 |
it's ``ganeti.node1.example.com``). Make sure node1 and node2 have root access |
865 |
between each other using ssh keys and not passwords. Also, make sure there is an |
866 |
lvm volume group named ``ganeti`` that will host your VMs' disks. Finally, setup |
867 |
a bridge interface on the host machines (e.g:: br0). Then run on node1: |
868 |
|
869 |
.. code-block:: console |
870 |
|
871 |
root@node1:~ # gnt-cluster init --enabled-hypervisors=kvm --no-ssh-init |
872 |
--no-etc-hosts --vg-name=ganeti |
873 |
--nic-parameters link=br0 --master-netdev eth0 |
874 |
ganeti.node1.example.com |
875 |
root@node1:~ # gnt-cluster modify --default-iallocator hail |
876 |
root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:kernel_path= |
877 |
root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:vnc_bind_address=0.0.0.0 |
878 |
|
879 |
root@node1:~ # gnt-node add --no-node-setup --master-capable=yes |
880 |
--vm-capable=yes node2.example.com |
881 |
|
882 |
For any problems you may stumble upon installing Ganeti, please refer to the |
883 |
`official documentation <http://docs.ganeti.org/ganeti/2.5/html>`_. Installation |
884 |
of Ganeti is out of the scope of this guide. |
885 |
|
886 |
.. _cyclades-install-snfimage: |
887 |
|
888 |
snf-image |
889 |
--------- |
890 |
|
891 |
Installation |
892 |
~~~~~~~~~~~~ |
893 |
For :ref:`Cyclades <cyclades>` to be able to launch VMs from specified Images, |
894 |
you need the :ref:`snf-image <snf-image>` OS Definition installed on *all* |
895 |
VM-capable Ganeti nodes. This means we need :ref:`snf-image <snf-image>` on |
896 |
node1 and node2. You can do this by running on *both* nodes: |
897 |
|
898 |
.. code-block:: console |
899 |
|
900 |
# apt-get install snf-image-host snf-pithos-backend |
901 |
|
902 |
snf-image also needs the `snf-pithos-backend <snf-pithos-backend>`, to be able to |
903 |
handle image files stored on Pithos+. This is why, we also install it on *all* |
904 |
VM-capable Ganeti nodes. |
905 |
|
906 |
Now, you need to download and save the corresponding helper package. Please see |
907 |
`here <https://code.grnet.gr/projects/snf-image/files>`_ for the latest package. Let's |
908 |
assume that you installed snf-image-host version 0.3.5-1. Then, you need |
909 |
snf-image-helper v0.3.5-1 on *both* nodes: |
910 |
|
911 |
.. code-block:: console |
912 |
|
913 |
# cd /var/lib/snf-image/helper/ |
914 |
# wget https://code.grnet.gr/attachments/download/1058/snf-image-helper_0.3.5-1_all.deb |
915 |
|
916 |
.. warning:: Be careful: Do NOT install the snf-image-helper debian package. |
917 |
Just put it under /var/lib/snf-image/helper/ |
918 |
|
919 |
Once, you have downloaded the snf-image-helper package, create the helper VM by |
920 |
running on *both* nodes: |
921 |
|
922 |
.. code-block:: console |
923 |
|
924 |
# ln -s snf-image-helper_0.3.5-1_all.deb snf-image-helper.deb |
925 |
# snf-image-update-helper |
926 |
|
927 |
This will create all the needed files under ``/var/lib/snf-image/helper/`` for |
928 |
snf-image-host to run successfully. |
929 |
|
930 |
Configuration |
931 |
~~~~~~~~~~~~~ |
932 |
snf-image supports native access to Images stored on Pithos+. This means that |
933 |
snf-image can talk directly to the Pithos+ backend, without the need of providing |
934 |
a public URL. More details, are described in the next section. For now, the only |
935 |
thing we need to do, is configure snf-image to access our Pithos+ backend. |
936 |
|
937 |
To do this, we need to set the corresponding variables in |
938 |
``/etc/default/snf-image``, to reflect our Pithos+ setup: |
939 |
|
940 |
.. code-block:: console |
941 |
|
942 |
PITHOS_DB="postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos" |
943 |
|
944 |
PITHOS_DATA="/srv/pithos/data" |
945 |
|
946 |
If you have installed your Ganeti cluster on different nodes than node1 and node2 make |
947 |
sure that ``/srv/pithos/data`` is visible by all of them. |
948 |
|
949 |
If you would like to use Images that are also/only stored locally, you need to |
950 |
save them under ``IMAGE_DIR``, however this guide targets Images stored only on |
951 |
Pithos+. |
952 |
|
953 |
Testing |
954 |
~~~~~~~ |
955 |
You can test that snf-image is successfully installed by running on the |
956 |
:ref:`GANETI-MASTER <GANETI_NODES>` (in our case node1): |
957 |
|
958 |
.. code-block:: console |
959 |
|
960 |
# gnt-os diagnose |
961 |
|
962 |
This should return ``valid`` for snf-image. |
963 |
|
964 |
If you are interested to learn more about snf-image's internals (and even use |
965 |
it alongside Ganeti without Synnefo), please see |
966 |
`here <https://code.grnet.gr/projects/snf-image/wiki>`_ for information concerning |
967 |
installation instructions, documentation on the design and implementation, and |
968 |
supported Image formats. |
969 |
|
970 |
.. _snf-image-images: |
971 |
|
972 |
snf-image's actual Images |
973 |
------------------------- |
974 |
|
975 |
Now that snf-image is installed successfully we need to provide it with some |
976 |
Images. :ref:`snf-image <snf-image>` supports Images stored in ``extdump``, |
977 |
``ntfsdump`` or ``diskdump`` format. We recommend the use of the ``diskdump`` |
978 |
format. For more information about snf-image's Image formats see `here |
979 |
<https://code.grnet.gr/projects/snf-image/wiki/Image_Format>`_. |
980 |
|
981 |
:ref:`snf-image <snf-image>` also supports three (3) different locations for the |
982 |
above Images to be stored: |
983 |
|
984 |
* Under a local folder (usually an NFS mount, configurable as ``IMAGE_DIR`` in |
985 |
:file:`/etc/default/snf-image`) |
986 |
* On a remote host (accessible via a public URL e.g: http://... or ftp://...) |
987 |
* On Pithos+ (accessible natively, not only by its public URL) |
988 |
|
989 |
For the purpose of this guide, we will use the `Debian Squeeze Base Image |
990 |
<https://pithos.okeanos.grnet.gr/public/9epgb>`_ found on the official |
991 |
`snf-image page |
992 |
<https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_. The image is |
993 |
of type ``diskdump``. We will store it in our new Pithos+ installation. |
994 |
|
995 |
To do so, do the following: |
996 |
|
997 |
a) Download the Image from the official snf-image page (`image link |
998 |
<https://pithos.okeanos.grnet.gr/public/9epgb>`_). |
999 |
|
1000 |
b) Upload the Image to your Pithos+ installation, either using the Pithos+ Web UI |
1001 |
or the command line client `kamaki |
1002 |
<http://docs.dev.grnet.gr/kamaki/latest/index.html>`_. |
1003 |
|
1004 |
Once the Image is uploaded successfully, download the Image's metadata file |
1005 |
from the official snf-image page (`image_metadata link |
1006 |
<https://pithos.okeanos.grnet.gr/public/gwqcv>`_). You will need it, for |
1007 |
spawning a VM from Ganeti, in the next section. |
1008 |
|
1009 |
Of course, you can repeat the procedure to upload more Images, available from the |
1010 |
`official snf-image page |
1011 |
<https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_. |
1012 |
|
1013 |
.. _ganeti-with-pithos-images: |
1014 |
|
1015 |
Spawning a VM from a Pithos+ Image, using Ganeti |
1016 |
------------------------------------------------ |
1017 |
|
1018 |
Now, it is time to test our installation so far. So, we have Astakos and |
1019 |
Pithos+ installed, we have a working Ganeti installation, the snf-image |
1020 |
definition installed on all VM-capable nodes and a Debian Squeeze Image on |
1021 |
Pithos+. Make sure you also have the `metadata file |
1022 |
<https://pithos.okeanos.grnet.gr/public/gwqcv>`_ for this image. |
1023 |
|
1024 |
Run on the :ref:`GANETI-MASTER's <GANETI_NODES>` (node1) command line: |
1025 |
|
1026 |
.. code-block:: console |
1027 |
|
1028 |
# gnt-instance add -o snf-image+default --os-parameters |
1029 |
img_passwd=my_vm_example_passw0rd, |
1030 |
img_format=diskdump, |
1031 |
img_id="pithos://user@example.com/pithos/debian_base-6.0-7-x86_64.diskdump", |
1032 |
img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' |
1033 |
-t plain --disk 0:size=2G --no-name-check --no-ip-check |
1034 |
testvm1 |
1035 |
|
1036 |
In the above command: |
1037 |
|
1038 |
* ``img_passwd``: the arbitrary root password of your new instance |
1039 |
* ``img_format``: set to ``diskdump`` to reflect the type of the uploaded Image |
1040 |
* ``img_id``: If you want to deploy an Image stored on Pithos+ (our case), this |
1041 |
should have the format |
1042 |
``pithos://<username>/<container>/<filename>``: |
1043 |
* ``username``: ``user@example.com`` (defined during Astakos sign up) |
1044 |
* ``container``: ``pithos`` (default, if the Web UI was used) |
1045 |
* ``filename``: the name of file (visible also from the Web UI) |
1046 |
* ``img_properties``: taken from the metadata file. Used only the two mandatory |
1047 |
properties ``OSFAMILY`` and ``ROOT_PARTITION``. `Learn more |
1048 |
<https://code.grnet.gr/projects/snf-image/wiki/Image_Format#Image-Properties>`_ |
1049 |
|
1050 |
If the ``gnt-instance add`` command returns successfully, then run: |
1051 |
|
1052 |
.. code-block:: console |
1053 |
|
1054 |
# gnt-instance info testvm1 | grep "console connection" |
1055 |
|
1056 |
to find out where to connect using VNC. If you can connect successfully and can |
1057 |
login to your new instance using the root password ``my_vm_example_passw0rd``, |
1058 |
then everything works as expected and you have your new Debian Base VM up and |
1059 |
running. |
1060 |
|
1061 |
If ``gnt-instance add`` fails, make sure that snf-image is correctly configured |
1062 |
to access the Pithos+ database and the Pithos+ backend data. Also, make sure |
1063 |
you gave the correct ``img_id`` and ``img_properties``. If ``gnt-instance add`` |
1064 |
succeeds but you cannot connect, again find out what went wrong. Do *NOT* |
1065 |
proceed to the next steps unless you are sure everything works till this point. |
1066 |
|
1067 |
If everything works, you have successfully connected Ganeti with Pithos+. Let's |
1068 |
move on to networking now. |
1069 |
|
1070 |
.. warning:: |
1071 |
You can bypass the networking sections and go straight to |
1072 |
:ref:`Cyclades Ganeti tools <cyclades-gtools>`, if you do not want to setup |
1073 |
the Cyclades Network Service, but only the Cyclades Compute Service |
1074 |
(recommended for now). |
1075 |
|
1076 |
Network setup overview |
1077 |
---------------------- |
1078 |
|
1079 |
This part is deployment-specific and must be customized based on the specific |
1080 |
needs of the system administrator. However, to do so, the administrator needs |
1081 |
to understand how each level handles Virtual Networks, to be able to setup the |
1082 |
backend appropriately, before installing Cyclades. To do so, please read the |
1083 |
:ref:`Network <networks>` section before proceeding. |
1084 |
|
1085 |
Public Network setup |
1086 |
-------------------- |
1087 |
|
1088 |
Physical hosts' public network setup |
1089 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1090 |
|
1091 |
The physical hosts' setup is out of the scope of this guide. |
1092 |
|
1093 |
However, two common cases that you may want to consider (and choose from) are: |
1094 |
|
1095 |
a) One public bridge, where all VMs' public tap interfaces will connect. |
1096 |
b) IP-less routing over the same vlan on every host. |
1097 |
|
1098 |
When you setup your physical hosts (node1 and node2) for the Public Network, |
1099 |
then you need to inform Ganeti about the Network's IP range. |
1100 |
|
1101 |
Add the public network to Ganeti |
1102 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1103 |
|
1104 |
Once you have Ganeti with IP pool management up and running, you need to choose |
1105 |
the public network for your VMs and add it to Ganeti. Let's assume, that you |
1106 |
want to assign IPs from the ``5.6.7.0/27`` range to your new VMs, with |
1107 |
``5.6.7.1`` as their gateway. You can add the network by running: |
1108 |
|
1109 |
.. code-block:: console |
1110 |
|
1111 |
# gnt-network add --network=5.6.7.0/27 --gateway=5.6.7.1 public_network |
1112 |
|
1113 |
Then, connect the network to all your nodegroups. We assume that we only have |
1114 |
one nodegroup (``default``) in our Ganeti cluster: |
1115 |
|
1116 |
.. code-block:: console |
1117 |
|
1118 |
# gnt-network connect public_network default public_link |
1119 |
|
1120 |
Your new network is now ready from the Ganeti perspective. Now, we need to setup |
1121 |
`NFDHCPD` to actually reply with the correct IPs (that Ganeti will choose for |
1122 |
each NIC). |
1123 |
|
1124 |
NFDHCPD |
1125 |
~~~~~~~ |
1126 |
|
1127 |
At this point, Ganeti knows about your preferred network, it can manage the IP |
1128 |
pool and choose a specific IP for each new VM's NIC. However, the actual |
1129 |
assignment of the IP to the NIC is not done by Ganeti. It is done after the VM |
1130 |
boots and its dhcp client makes a request. When this is done, `NFDHCPD` will |
1131 |
reply to the request with Ganeti's chosen IP. So, we need to install `NFDHCPD` |
1132 |
on all VM-capable nodes of the Ganeti cluster (node1 and node2 in our case) and |
1133 |
connect it to Ganeti: |
1134 |
|
1135 |
.. code-block:: console |
1136 |
|
1137 |
# apt-get install nfdhcpd |
1138 |
|
1139 |
Edit ``/etc/nfdhcpd/nfdhcpd.conf`` to reflect your network configuration. At |
1140 |
least, set the ``dhcp_queue`` variable to ``42`` and the ``nameservers`` |
1141 |
variable to your DNS IP/s. Those IPs will be passed as the DNS IP/s of your new |
1142 |
VMs. Once you are finished, restart the server on all nodes: |
1143 |
|
1144 |
.. code-block:: console |
1145 |
|
1146 |
# /etc/init.d/nfdhcpd restart |
1147 |
|
1148 |
If you are using ``ferm``, then you need to run the following: |
1149 |
|
1150 |
.. code-block:: console |
1151 |
|
1152 |
# echo "@include 'nfdhcpd.ferm';" >> /etc/ferm/ferm.conf |
1153 |
# /etc/init.d/ferm restart |
1154 |
|
1155 |
Now, you need to connect `NFDHCPD` with Ganeti. To do that, you need to install |
1156 |
a custom KVM ifup script for use by Ganeti, as ``/etc/ganeti/kvm-vif-bridge``, |
1157 |
on all VM-capable GANETI-NODEs (node1 and node2). A sample implementation is |
1158 |
provided along with `snf-cyclades-gtools <snf-cyclades-gtools>`, that will |
1159 |
be installed in the next sections, however you will probably need to write your |
1160 |
own, according to your underlying network configuration. |
1161 |
|
1162 |
Testing the Public Network |
1163 |
~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1164 |
|
1165 |
So, we have setup the bridges/vlans on the physical hosts appropriately, we have |
1166 |
added the desired network to Ganeti, we have installed nfdhcpd and installed the |
1167 |
appropriate ``kvm-vif-bridge`` script under ``/etc/ganeti``. |
1168 |
|
1169 |
Now, it is time to test that the backend infrastracture is correctly setup for |
1170 |
the Public Network. We assume to have used the (b) method on setting up the |
1171 |
physical hosts. We will add a new VM, the same way we did it on the previous |
1172 |
testing section. However, now will also add one NIC, configured to be managed |
1173 |
from our previously defined network. Run on the GANETI-MASTER (node1): |
1174 |
|
1175 |
.. code-block:: console |
1176 |
|
1177 |
# gnt-instance add -o snf-image+default --os-parameters |
1178 |
img_passwd=my_vm_example_passw0rd, |
1179 |
img_format=diskdump, |
1180 |
img_id="pithos://user@example.com/pithos/debian_base-6.0-7-x86_64.diskdump", |
1181 |
img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' |
1182 |
-t plain --disk 0:size=2G --no-name-check --no-ip-check |
1183 |
--net 0:ip=pool,mode=routed,link=public_link |
1184 |
testvm2 |
1185 |
|
1186 |
If the above returns successfully, connect to the new VM and run: |
1187 |
|
1188 |
.. code-block:: console |
1189 |
|
1190 |
root@testvm2:~ # ifconfig -a |
1191 |
|
1192 |
If a network interface appears with an IP from you Public Network's range |
1193 |
(``5.6.7.0/27``) and the corresponding gateway, then you have successfully |
1194 |
connected Ganeti with `NFDHCPD` (and ``kvm-vif-bridge`` works correctly). |
1195 |
|
1196 |
Now ping the outside world. If this works too, then you have also configured |
1197 |
correctly your physical hosts' networking. |
1198 |
|
1199 |
Later, Cyclades will create the first NIC of every new VM by issuing an |
1200 |
analogous command. The first NIC of the instance will be the NIC connected to |
1201 |
the Public Network. The ``link`` variable will be set accordingly in the |
1202 |
Cyclades conf files later on the guide. |
1203 |
|
1204 |
Make sure everything works as expected, before proceeding with the Private |
1205 |
Networks setup. |
1206 |
|
1207 |
.. _private-networks-setup: |
1208 |
|
1209 |
Private Networks setup |
1210 |
---------------------- |
1211 |
|
1212 |
Physical hosts' private networks setup |
1213 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1214 |
|
1215 |
At the physical host's level, it is the administrator's responsibility to |
1216 |
configure the network appropriately, according to his/her needs (as for the |
1217 |
Public Network). |
1218 |
|
1219 |
However we propose the following setup: |
1220 |
|
1221 |
For every possible Private Network we assume a pre-provisioned bridge interface |
1222 |
exists on every host with the same name. Every Private Network will be |
1223 |
associated with one of the pre-provisioned bridges. Then the instance's new NIC |
1224 |
(while connecting to the Private Network) will be connected to that bridge. All |
1225 |
instances' tap interfaces that reside in the same Private Network will be |
1226 |
connected in the corresponding bridge of that network. Furthermore, every |
1227 |
bridge will be connected to a corresponding vlan. So, lets assume that our |
1228 |
Cyclades installation allows for 20 Private Networks to be setup. We should |
1229 |
pre-provision the corresponding bridges and vlans to all the hosts. We can do |
1230 |
this by running on all VM-capable Ganeti nodes (in our case node1 and node2): |
1231 |
|
1232 |
.. code-block:: console |
1233 |
|
1234 |
# $iface=eth0 |
1235 |
# for prv in $(seq 1 20); do |
1236 |
vlan=$prv |
1237 |
bridge=prv$prv |
1238 |
vconfig add $iface $vlan |
1239 |
ifconfig $iface.$vlan up |
1240 |
brctl addbr $bridge |
1241 |
brctl setfd $bridge 0 |
1242 |
brctl addif $bridge $iface.$vlan |
1243 |
ifconfig $bridge up |
1244 |
done |
1245 |
|
1246 |
The above will do the following (assuming ``eth0`` exists on both hosts): |
1247 |
|
1248 |
* provision 20 new bridges: ``prv1`` - ``prv20`` |
1249 |
* provision 20 new vlans: ``eth0.1`` - ``eth0.20`` |
1250 |
* add the corresponding vlan to the equivelant bridge |
1251 |
|
1252 |
You can run ``brctl show`` on both nodes to see if everything was setup |
1253 |
correctly. |
1254 |
|
1255 |
Everything is now setup to support the 20 Cyclades Private Networks. Later, |
1256 |
we will configure Cyclades to talk to those 20 pre-provisioned bridges. |
1257 |
|
1258 |
Testing the Private Networks |
1259 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1260 |
|
1261 |
To test the Private Networks, we will create two instances and put them in the |
1262 |
same Private Network (``prv1``). This means that the instances will have a |
1263 |
second NIC connected to the ``prv1`` pre-provisioned bridge. |
1264 |
|
1265 |
We run the same command as in the Public Network testing section, but with one |
1266 |
more argument for the second NIC: |
1267 |
|
1268 |
.. code-block:: console |
1269 |
|
1270 |
# gnt-instance add -o snf-image+default --os-parameters |
1271 |
img_passwd=my_vm_example_passw0rd, |
1272 |
img_format=diskdump, |
1273 |
img_id="pithos://user@example.com/pithos/debian_base-6.0-7-x86_64.diskdump", |
1274 |
img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' |
1275 |
-t plain --disk 0:size=2G --no-name-check --no-ip-check |
1276 |
--net 0:ip=pool,mode=routed,link=public_link |
1277 |
--net 1:ip=none,mode=bridged,link=prv1 |
1278 |
testvm3 |
1279 |
|
1280 |
# gnt-instance add -o snf-image+default --os-parameters |
1281 |
img_passwd=my_vm_example_passw0rd, |
1282 |
img_format=diskdump, |
1283 |
img_id="pithos://user@example.com/pithos/debian_base-6.0-7-x86_64.diskdump", |
1284 |
img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' |
1285 |
-t plain --disk 0:size=2G --no-name-check --no-ip-check |
1286 |
--net 0:ip=pool,mode=routed,link=public_link |
1287 |
--net 1:ip=none,mode=bridged,link=prv1 |
1288 |
testvm4 |
1289 |
|
1290 |
Above, we create two instances with their first NIC connected to the Public |
1291 |
Network and their second NIC connected to the first Private Network (``prv1``). |
1292 |
Now, connect to the instances using VNC and make sure everything works as |
1293 |
expected: |
1294 |
|
1295 |
a) The instances have access to the public internet through their first eth |
1296 |
interface (``eth0``), which has been automatically assigned a public IP. |
1297 |
|
1298 |
b) Setup the second eth interface of the instances (``eth1``), by assigning two |
1299 |
different private IPs (e.g.: ``10.0.0.1`` and ``10.0.0.2``) and the |
1300 |
corresponding netmask. If they ``ping`` each other successfully, then |
1301 |
the Private Network works. |
1302 |
|
1303 |
Repeat the procedure with more instances connected in different Private Networks |
1304 |
(``prv{1-20}``), by adding more NICs on each instance. e.g.: We add an instance |
1305 |
connected to the Public Network and Private Networks 1, 3 and 19: |
1306 |
|
1307 |
.. code-block:: console |
1308 |
|
1309 |
# gnt-instance add -o snf-image+default --os-parameters |
1310 |
img_passwd=my_vm_example_passw0rd, |
1311 |
img_format=diskdump, |
1312 |
img_id="pithos://user@example.com/pithos/debian_base-6.0-7-x86_64.diskdump", |
1313 |
img_properties='{"OSFAMILY":"linux"\,"ROOT_PARTITION":"1"}' |
1314 |
-t plain --disk 0:size=2G --no-name-check --no-ip-check |
1315 |
--net 0:ip=pool,mode=routed,link=public_link |
1316 |
--net 1:ip=none,mode=bridged,link=prv1 |
1317 |
--net 2:ip=none,mode=bridged,link=prv3 |
1318 |
--net 3:ip=none,mode=bridged,link=prv19 |
1319 |
testvm5 |
1320 |
|
1321 |
If everything works as expected, then you have finished the Network Setup at the |
1322 |
backend for both types of Networks (Public & Private). |
1323 |
|
1324 |
.. _cyclades-gtools: |
1325 |
|
1326 |
Cyclades Ganeti tools |
1327 |
--------------------- |
1328 |
|
1329 |
In order for Ganeti to be connected with Cyclades later on, we need the |
1330 |
`Cyclades Ganeti tools` available on all Ganeti nodes (node1 & node2 in our |
1331 |
case). You can install them by running in both nodes: |
1332 |
|
1333 |
.. code-block:: console |
1334 |
|
1335 |
# apt-get install snf-cyclades-gtools |
1336 |
|
1337 |
This will install the following: |
1338 |
|
1339 |
* ``snf-ganeti-eventd`` (daemon to publish Ganeti related messages on RabbitMQ) |
1340 |
* ``snf-ganeti-hook`` (all necessary hooks under ``/etc/ganeti/hooks``) |
1341 |
* ``snf-progress-monitor`` (used by ``snf-image`` to publish progress messages) |
1342 |
|
1343 |
Configure ``snf-cyclades-gtools`` |
1344 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1345 |
|
1346 |
The package will install the ``/etc/synnefo/10-snf-cyclades-gtools-backend.conf`` |
1347 |
configuration file. At least we need to set the RabbitMQ endpoint for all tools |
1348 |
that need it: |
1349 |
|
1350 |
.. code-block:: console |
1351 |
|
1352 |
AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"] |
1353 |
|
1354 |
The above variables should reflect your :ref:`Message Queue setup |
1355 |
<rabbitmq-setup>`. This file should be editted in all Ganeti nodes. |
1356 |
|
1357 |
Connect ``snf-image`` with ``snf-progress-monitor`` |
1358 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1359 |
|
1360 |
Finally, we need to configure ``snf-image`` to publish progress messages during |
1361 |
the deployment of each Image. To do this, we edit ``/etc/default/snf-image`` and |
1362 |
set the corresponding variable to ``snf-progress-monitor``: |
1363 |
|
1364 |
.. code-block:: console |
1365 |
|
1366 |
PROGRESS_MONITOR="snf-progress-monitor" |
1367 |
|
1368 |
This file should be editted in all Ganeti nodes. |
1369 |
|
1370 |
.. _rapi-user: |
1371 |
|
1372 |
Synnefo RAPI user |
1373 |
----------------- |
1374 |
|
1375 |
As a last step before installing Cyclades, create a new RAPI user that will |
1376 |
have ``write`` access. Cyclades will use this user to issue commands to Ganeti, |
1377 |
so we will call the user ``cyclades`` with password ``example_rapi_passw0rd``. |
1378 |
You can do this, by first running: |
1379 |
|
1380 |
.. code-block:: console |
1381 |
|
1382 |
# echo -n 'cyclades:Ganeti Remote API:example_rapi_passw0rd' | openssl md5 |
1383 |
|
1384 |
and then putting the output in ``/var/lib/ganeti/rapi/users`` as follows: |
1385 |
|
1386 |
.. code-block:: console |
1387 |
|
1388 |
cyclades {HA1}55aec7050aa4e4b111ca43cb505a61a0 write |
1389 |
|
1390 |
More about Ganeti's RAPI users `here. |
1391 |
<http://docs.ganeti.org/ganeti/2.5/html/rapi.html#introduction>`_ |
1392 |
|
1393 |
You have now finished with all needed Prerequisites for Cyclades (and |
1394 |
Plankton). Let's move on to the actual Cyclades installation. |
1395 |
|
1396 |
|
1397 |
Installation of Cyclades (and Plankton) on node1 |
1398 |
================================================ |
1399 |
|
1400 |
This section describes the installation of Cyclades. Cyclades is Synnefo's |
1401 |
Compute service. Plankton (the Image Registry service) will get installed |
1402 |
automatically along with Cyclades, because it is contained in the same Synnefo |
1403 |
component right now. |
1404 |
|
1405 |
We will install Cyclades (and Plankton) on node1. To do so, we install the |
1406 |
corresponding package by running on node1: |
1407 |
|
1408 |
.. code-block:: console |
1409 |
|
1410 |
# apt-get install snf-cyclades-app |
1411 |
|
1412 |
.. warning:: Make sure you have installed ``python-gevent`` version >= 0.13.6. |
1413 |
This version is available at squeeze-backports and can be installed by |
1414 |
running: ``apt-get install -t squeeze-backports python-gevent`` |
1415 |
|
1416 |
If all packages install successfully, then Cyclades and Plankton are installed |
1417 |
and we proceed with their configuration. |
1418 |
|
1419 |
|
1420 |
Configuration of Cyclades (and Plankton) |
1421 |
======================================== |
1422 |
|
1423 |
Conf files |
1424 |
---------- |
1425 |
|
1426 |
After installing Cyclades, a number of new configuration files will appear under |
1427 |
``/etc/synnefo/`` prefixed with ``20-snf-cyclades-app-``. We will descibe here |
1428 |
only the minimal needed changes to result with a working system. In general, sane |
1429 |
defaults have been chosen for the most of the options, to cover most of the |
1430 |
common scenarios. However, if you want to tweak Cyclades feel free to do so, |
1431 |
once you get familiar with the different options. |
1432 |
|
1433 |
Edit ``/etc/synnefo/20-snf-cyclades-app-api.conf``: |
1434 |
|
1435 |
.. code-block:: console |
1436 |
|
1437 |
GANETI_MAX_LINK_NUMBER = 20 |
1438 |
ASTAKOS_URL = 'https://node1.example.com/im/authenticate' |
1439 |
|
1440 |
The ``GANETI_MAX_LINK_NUMBER`` is used to construct the names of the bridges |
1441 |
already pre-provisioned for the Private Networks. Thus we set it to ``20``, to |
1442 |
reflect our :ref:`Private Networks setup in the host machines |
1443 |
<private-networks-setup>`. These numbers will suffix the |
1444 |
``GANETI_LINK_PREFIX``, which is already set to ``prv`` and doesn't need to be |
1445 |
changed. With those two variables Cyclades will construct the names of the |
1446 |
available bridges ``prv1`` to ``prv20``, which are the real pre-provisioned |
1447 |
bridges in the backend. |
1448 |
|
1449 |
The ``ASTAKOS_URL`` denotes the authentication endpoint for Cyclades and is set |
1450 |
to point to Astakos (this should have the same value with Pithos+'s |
1451 |
``PITHOS_AUTHENTICATION_URL``, setup :ref:`previously <conf-pithos>`). |
1452 |
|
1453 |
Edit ``/etc/synnefo/20-snf-cyclades-app-backend.conf``: |
1454 |
|
1455 |
.. code-block:: console |
1456 |
|
1457 |
GANETI_MASTER_IP = "ganeti.node1.example.com" |
1458 |
GANETI_CLUSTER_INFO = (GANETI_MASTER_IP, 5080, "cyclades", "example_rapi_passw0rd") |
1459 |
|
1460 |
``GANETI_MASTER_IP`` denotes the Ganeti-master's floating IP. We provide the |
1461 |
corresponding domain that resolves to that IP, than the IP itself, to ensure |
1462 |
Cyclades can talk to Ganeti even after a Ganeti master-failover. |
1463 |
|
1464 |
``GANETI_CLUSTER_INFO`` is a tuple containing the ``GANETI_MASTER_IP``, the RAPI |
1465 |
port, the RAPI user's username and the RAPI user's password. We set the above to |
1466 |
reflect our :ref:`RAPI User setup <rapi-user>`. |
1467 |
|
1468 |
Edit ``/etc/synnefo/20-snf-cyclades-app-cloudbar.conf``: |
1469 |
|
1470 |
.. code-block:: console |
1471 |
|
1472 |
CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
1473 |
CLOUDBAR_ACTIVE_SERVICE = '2' |
1474 |
CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services' |
1475 |
CLOUDBAR_MENU_URL = 'https://account.node1.example.com/im/get_menu' |
1476 |
|
1477 |
``CLOUDBAR_LOCATION`` tells the client where to find the Astakos common |
1478 |
cloudbar. The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are |
1479 |
used by the Cyclades Web UI to get from Astakos all the information needed to |
1480 |
fill its own cloudbar. So, we put our Astakos deployment urls there. All the |
1481 |
above should have the same values we put in the corresponding variables in |
1482 |
``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf`` on the previous |
1483 |
:ref:`Pithos configuration <conf-pithos>` section. |
1484 |
|
1485 |
The ``CLOUDBAR_ACTIVE_SERVICE`` points to an already registered Astakos |
1486 |
service. You can see all :ref:`registered services <services-reg>` by running |
1487 |
on the Astakos node (node1): |
1488 |
|
1489 |
.. code-block:: console |
1490 |
|
1491 |
# snf-manage service_list |
1492 |
|
1493 |
The value of ``CLOUDBAR_ACTIVE_SERVICE`` should be the cyclades service's |
1494 |
``id`` as shown by the above command, in our case ``2``. |
1495 |
|
1496 |
Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``: |
1497 |
|
1498 |
.. code-block:: console |
1499 |
|
1500 |
BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos' |
1501 |
BACKEND_BLOCK_PATH = '/srv/pithos/data/' |
1502 |
|
1503 |
In this file we configure the Plankton Service. ``BACKEND_DB_CONNECTION`` |
1504 |
denotes the Pithos+ database (where the Image files are stored). So we set that |
1505 |
to point to our Pithos+ database. ``BACKEND_BLOCK_PATH`` denotes the actual |
1506 |
Pithos+ data location. |
1507 |
|
1508 |
Edit ``/etc/synnefo/20-snf-cyclades-app-queues.conf``: |
1509 |
|
1510 |
.. code-block:: console |
1511 |
|
1512 |
AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"] |
1513 |
|
1514 |
The above settings denote the Message Queue. Those settings should have the same |
1515 |
values as in ``/etc/synnefo/10-snf-cyclades-gtools-backend.conf`` file, and |
1516 |
reflect our :ref:`Message Queue setup <rabbitmq-setup>`. |
1517 |
|
1518 |
Edit ``/etc/synnefo/20-snf-cyclades-app-ui.conf``: |
1519 |
|
1520 |
.. code-block:: console |
1521 |
|
1522 |
UI_MEDIA_URL = '/static/ui/static/snf/' |
1523 |
UI_LOGIN_URL = "https://node1.example.com/im/login" |
1524 |
UI_LOGOUT_URL = "https://node1.example.com/im/logout" |
1525 |
|
1526 |
``UI_MEDIA_URL`` denotes the location of the UI's static files. |
1527 |
|
1528 |
The ``UI_LOGIN_URL`` option tells the Cyclades Web UI where to redirect users, |
1529 |
if they are not logged in. We point that to Astakos. |
1530 |
|
1531 |
The ``UI_LOGOUT_URL`` option tells the Cyclades Web UI where to redirect the |
1532 |
user when he/she logs out. We point that to Astakos, too. |
1533 |
|
1534 |
We have now finished with the basic Cyclades and Plankton configuration. |
1535 |
|
1536 |
Database Initialization |
1537 |
----------------------- |
1538 |
|
1539 |
Once Cyclades is configured, we sync the database: |
1540 |
|
1541 |
.. code-block:: console |
1542 |
|
1543 |
$ snf-manage syncdb |
1544 |
$ snf-manage migrate |
1545 |
|
1546 |
and load the initial server flavors: |
1547 |
|
1548 |
.. code-block:: console |
1549 |
|
1550 |
$ snf-manage loaddata flavors |
1551 |
|
1552 |
If everything returns successfully, our database is ready. |
1553 |
|
1554 |
Servers restart |
1555 |
--------------- |
1556 |
|
1557 |
We also need to restart gunicorn on node1: |
1558 |
|
1559 |
.. code-block:: console |
1560 |
|
1561 |
# /etc/init.d/gunicorn restart |
1562 |
|
1563 |
Now let's do the final connections of Cyclades with Ganeti. |
1564 |
|
1565 |
``snf-dispatcher`` initialization |
1566 |
--------------------------------- |
1567 |
|
1568 |
``snf-dispatcher`` dispatches all messages published to the Message Queue and |
1569 |
manages the Cyclades database accordingly. It also initializes all exchanges. By |
1570 |
default it is not enabled during installation of Cyclades, so let's enable it in |
1571 |
its configuration file ``/etc/default/snf-dispatcher``: |
1572 |
|
1573 |
.. code-block:: console |
1574 |
|
1575 |
SNF_DSPTCH_ENABLE=true |
1576 |
|
1577 |
and start the daemon: |
1578 |
|
1579 |
.. code-block:: console |
1580 |
|
1581 |
# /etc/init.d/snf-dispatcher start |
1582 |
|
1583 |
You can see that everything works correctly by tailing its log file |
1584 |
``/var/log/synnefo/dispatcher.log``. |
1585 |
|
1586 |
``snf-ganeti-eventd`` on GANETI MASTER |
1587 |
-------------------------------------- |
1588 |
|
1589 |
The last step of the Cyclades setup is enabling the ``snf-ganeti-eventd`` |
1590 |
daemon (part of the :ref:`Cyclades Ganeti tools <cyclades-gtools>` package). |
1591 |
The daemon is already installed on the GANETI MASTER (node1 in our case). |
1592 |
``snf-ganeti-eventd`` is disabled by default during the ``snf-cyclades-gtools`` |
1593 |
installation, so we enable it in its configuration file |
1594 |
``/etc/default/snf-ganeti-eventd``: |
1595 |
|
1596 |
.. code-block:: console |
1597 |
|
1598 |
SNF_EVENTD_ENABLE=true |
1599 |
|
1600 |
and start the daemon: |
1601 |
|
1602 |
.. code-block:: console |
1603 |
|
1604 |
# /etc/init.d/snf-ganeti-eventd start |
1605 |
|
1606 |
.. warning:: Make sure you start ``snf-ganeti-eventd`` *ONLY* on GANETI MASTER |
1607 |
|
1608 |
If all the above return successfully, then you have finished with the Cyclades |
1609 |
and Plankton installation and setup. Let's test our installation now. |
1610 |
|
1611 |
|
1612 |
Testing of Cyclades (and Plankton) |
1613 |
================================== |
1614 |
|
1615 |
Cyclades Web UI |
1616 |
--------------- |
1617 |
|
1618 |
First of all we need to test that our Cyclades Web UI works correctly. Open your |
1619 |
browser and go to the Astakos home page. Login and then click 'cyclades' on the |
1620 |
top cloud bar. This should redirect you to: |
1621 |
|
1622 |
`http://node1.example.com/ui/` |
1623 |
|
1624 |
and the Cyclades home page should appear. If not, please go back and find what |
1625 |
went wrong. Do not proceed if you don't see the Cyclades home page. |
1626 |
|
1627 |
If the Cyclades home page appears, click on the orange button 'New machine'. The |
1628 |
first step of the 'New machine wizard' will appear. This step shows all the |
1629 |
available Images from which you can spawn new VMs. The list should be currently |
1630 |
empty, as we haven't registered any Images yet. Close the wizard and browse the |
1631 |
interface (not many things to see yet). If everything seems to work, let's |
1632 |
register our first Image file. |
1633 |
|
1634 |
Cyclades Images |
1635 |
--------------- |
1636 |
|
1637 |
To test our Cyclades (and Plankton) installation, we will use an Image stored on |
1638 |
Pithos+ to spawn a new VM from the Cyclades interface. We will describe all |
1639 |
steps, even though you may already have uploaded an Image on Pithos+ from a |
1640 |
:ref:`previous <snf-image-images>` section: |
1641 |
|
1642 |
* Upload an Image file to Pithos+ |
1643 |
* Register that Image file to Plankton |
1644 |
* Spawn a new VM from that Image from the Cyclades Web UI |
1645 |
|
1646 |
We will use the `kamaki <http://docs.dev.grnet.gr/kamaki/latest/index.html>`_ |
1647 |
command line client to do the uploading and registering of the Image. |
1648 |
|
1649 |
Installation of `kamaki` |
1650 |
~~~~~~~~~~~~~~~~~~~~~~~~ |
1651 |
|
1652 |
You can install `kamaki` anywhere you like, since it is a standalone client of |
1653 |
the APIs and talks to the installation over `http`. For the purpose of this |
1654 |
guide we will assume that we have downloaded the `Debian Squeeze Base Image |
1655 |
<https://pithos.okeanos.grnet.gr/public/9epgb>`_ and stored it under node1's |
1656 |
``/srv/images`` directory. For that reason we will install `kamaki` on node1, |
1657 |
too. We do this by running: |
1658 |
|
1659 |
.. code-block:: console |
1660 |
|
1661 |
# apt-get install kamaki |
1662 |
|
1663 |
Configuration of kamaki |
1664 |
~~~~~~~~~~~~~~~~~~~~~~~ |
1665 |
|
1666 |
Now we need to setup kamaki, by adding the appropriate URLs and tokens of our |
1667 |
installation. We do this by running: |
1668 |
|
1669 |
.. code-block:: console |
1670 |
|
1671 |
$ kamaki config set astakos.url "https://node1.example.com" |
1672 |
$ kamaki config set compute.url="https://node1.example.com/api/v1.1" |
1673 |
$ kamaki config set image.url "https://node1.examle.com/plankton" |
1674 |
$ kamaki config set storage.url "https://node2.example.com/v1" |
1675 |
$ kamaki config set storage.account "user@example.com" |
1676 |
$ kamaki config set global.token "bdY_example_user_tokenYUff==" |
1677 |
|
1678 |
The token at the last kamaki command is our user's (``user@example.com``) token, |
1679 |
as it appears on the user's `Profile` web page on the Astakos Web UI. |
1680 |
|
1681 |
You can see that the new configuration options have been applied correctly, by |
1682 |
running: |
1683 |
|
1684 |
.. code-block:: console |
1685 |
|
1686 |
$ kamaki config list |
1687 |
|
1688 |
Upload an Image file to Pithos+ |
1689 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1690 |
|
1691 |
Now, that we have set up `kamaki` we will upload the Image that we have |
1692 |
downloaded and stored under ``/srv/images/``. Although we can upload the Image |
1693 |
under the root ``Pithos`` container (as you may have done when uploading the |
1694 |
Image from the Pithos+ Web UI), we will create a new container called ``images`` |
1695 |
and store the Image under that container. We do this for two reasons: |
1696 |
|
1697 |
a) To demonstrate how to create containers other than the default ``Pithos``. |
1698 |
This can be done only with the `kamaki` client and not through the Web UI. |
1699 |
|
1700 |
b) As a best organization practise, so that you won't have your Image files |
1701 |
tangled along with all your other Pithos+ files and directory structures. |
1702 |
|
1703 |
We create the new ``images`` container by running: |
1704 |
|
1705 |
.. code-block:: console |
1706 |
|
1707 |
$ kamaki store create images |
1708 |
|
1709 |
Then, we upload the Image file to that container: |
1710 |
|
1711 |
.. code-block:: console |
1712 |
|
1713 |
$ kamaki store upload --container images \ |
1714 |
/srv/images/debian_base-6.0-7-x86_64.diskdump \ |
1715 |
debian_base-6.0-7-x86_64.diskdump |
1716 |
|
1717 |
The first is the local path and the second is the remote path on Pithos+. If |
1718 |
the new container and the file appears on the Pithos+ Web UI, then you have |
1719 |
successfully created the container and uploaded the Image file. |
1720 |
|
1721 |
Register an existing Image file to Plankton |
1722 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1723 |
|
1724 |
Once the Image file has been successfully uploaded on Pithos+, then we register |
1725 |
it to Plankton (so that it becomes visible to Cyclades), by running: |
1726 |
|
1727 |
.. code-block:: console |
1728 |
|
1729 |
$ kamaki image register "Debian Base" |
1730 |
pithos://user@examle.com/images/debian_base-6.0-7-x86_64.diskdump |
1731 |
--public |
1732 |
--disk-format=diskdump |
1733 |
--property OSFAMILY=linux --property ROOT_PARTITION=1 |
1734 |
--property description="Debian Squeeze Base System" |
1735 |
--property size=451 --property kernel=2.6.32 --property GUI="No GUI" |
1736 |
--property sortorder=1 --property USERS=root --property OS=debian |
1737 |
|
1738 |
This command registers the Pithos+ file |
1739 |
``pithos://user@examle.com/images/debian_base-6.0-7-x86_64.diskdump`` as an |
1740 |
Image in Plankton. This Image will be public (``--public``), so all users will |
1741 |
be able to spawn VMs from it and is of type ``diskdump``. The first two |
1742 |
properties (``OSFAMILY`` and ``ROOT_PARTITION``) are mandatory. All the rest |
1743 |
properties are optional, but recommended, so that the Images appear nicely on |
1744 |
the Cyclades Web UI. ``Debian Base`` will appear as the name of this Image. The |
1745 |
``OS`` property's valid values may be found in the ``IMAGE_ICONS`` variable |
1746 |
inside the ``20-snf-cyclades-app-ui.conf`` configuration file. |
1747 |
|
1748 |
``OSFAMILY`` and ``ROOT_PARTITION`` are mandatory because they will be passed |
1749 |
from Plankton to Cyclades and then to Ganeti and `snf-image` (also see |
1750 |
:ref:`previous section <ganeti-with-pithos-images>`). All other properties are |
1751 |
used to show information on the Cyclades UI. |
1752 |
|
1753 |
Spawn a VM from the Cyclades Web UI |
1754 |
----------------------------------- |
1755 |
|
1756 |
If the registration completes successfully, then go to the Cyclades Web UI from |
1757 |
your browser at: |
1758 |
|
1759 |
`https://node1.example.com/ui/` |
1760 |
|
1761 |
Click on the 'New Machine' button and the first step of the wizard will appear. |
1762 |
Click on 'My Images' (right after 'System' Images) on the left pane of the |
1763 |
wizard. Your previously registered Image "Debian Base" should appear under |
1764 |
'Available Images'. If not, something has gone wrong with the registration. Make |
1765 |
sure you can see your Image file on the Pithos+ Web UI and ``kamaki image |
1766 |
register`` returns successfully with all options and properties as shown above. |
1767 |
|
1768 |
If the Image appears on the list, select it and complete the wizard by selecting |
1769 |
a flavor and a name for your VM. Then finish by clicking 'Create'. Make sure you |
1770 |
write down your password, because you *WON'T* be able to retrieve it later. |
1771 |
|
1772 |
If everything was setup correctly, after a few minutes your new machine will go |
1773 |
to state 'Running' and you will be able to use it. Click 'Console' to connect |
1774 |
through VNC out of band, or click on the machine's icon to connect directly via |
1775 |
SSH or RDP (for windows machines). |
1776 |
|
1777 |
Congratulations. You have successfully installed the whole Synnefo stack and |
1778 |
connected all components. Go ahead in the next section to test the Network |
1779 |
functionality from inside Cyclades and discover even more features. |
1780 |
|
1781 |
|
1782 |
General Testing |
1783 |
=============== |
1784 |
|
1785 |
|
1786 |
Notes |
1787 |
===== |