Statistics
| Branch: | Tag: | Revision:

root / docs / quick-install-admin-guide.rst @ 0c068fc6

History | View | Annotate | Download (80.1 kB)

1
.. _quick-install-admin-guide:
2

    
3
Administrator's Installation Guide
4
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5

    
6
This is the Administrator's 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 Service (part of Cyclades)
17
    * Network Service (part of Cyclades)
18

    
19
and a single unified Web UI to manage them all.
20

    
21
The Volume Storage Service (Archipelago) and the Billing Service (Aquarium) are
22
not released yet.
23

    
24
If you just want to install the Object Storage Service (Pithos), follow the
25
guide and just stop after the "Testing of Pithos" section.
26

    
27

    
28
Installation of Synnefo / Introduction
29
======================================
30

    
31
We will install the services with the above list's order. The last three
32
services will be installed in a single step (at the end), because at the moment
33
they are contained in the same software component (Cyclades). Furthermore, we
34
will install all services in the first physical node, except Pithos which will
35
be installed in the second, due to a conflict between the snf-pithos-app and
36
snf-cyclades-app component (scheduled to be fixed in the next version).
37

    
38
For the rest of the documentation we will refer to the first physical node as
39
"node1" and the second as "node2". We will also assume that their domain names
40
are "node1.example.com" and "node2.example.com" and their public IPs are "4.3.2.1" and
41
"4.3.2.2" respectively. It is important that the two machines are under the same domain name.
42
In case you choose to follow a private installation you will need to
43
set up a private dns server, using dnsmasq for example. See node1 below for more.
44

    
45
General Prerequisites
46
=====================
47

    
48
These are the general synnefo prerequisites, that you need on node1 and node2
49
and are related to all the services (Astakos, Pithos, Cyclades).
50

    
51
To be able to download all synnefo components you need to add the following
52
lines in your ``/etc/apt/sources.list`` file:
53

    
54
| ``deb http://apt.dev.grnet.gr squeeze/``
55
| ``deb-src http://apt.dev.grnet.gr squeeze/``
56

    
57
and import the repo's GPG key:
58

    
59
| ``curl https://dev.grnet.gr/files/apt-grnetdev.pub | apt-key add -``
60

    
61
Also add the following line to enable the ``squeeze-backports`` repository,
62
which may provide more recent versions of certain packages. The repository
63
is deactivated by default and must be specified expicitly in ``apt-get``
64
operations:
65

    
66
| ``deb http://backports.debian.org/debian-backports squeeze-backports main``
67

    
68
You also need a shared directory visible by both nodes. Pithos will save all
69
data inside this directory. By 'all data', we mean files, images, and pithos
70
specific mapping data. If you plan to upload more than one basic image, this
71
directory should have at least 50GB of free space. During this guide, we will
72
assume that node1 acts as an NFS server and serves the directory ``/srv/pithos``
73
to node2 (be sure to set no_root_squash flag). Node2 has this directory
74
mounted under ``/srv/pithos``, too.
75

    
76
Before starting the synnefo installation, you will need basic third party
77
software to be installed and configured on the physical nodes. We will describe
78
each node's general prerequisites separately. Any additional configuration,
79
specific to a synnefo service for each node, will be described at the service's
80
section.
81

    
82
Finally, it is required for Cyclades and Ganeti nodes to have synchronized
83
system clocks (e.g. by running ntpd).
84

    
85
Node1
86
-----
87

    
88

    
89
General Synnefo dependencies
90
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91

    
92
		* apache (http server)
93
		* public certificate
94
		* gunicorn (WSGI http server)
95
		* postgresql (database)
96
		* rabbitmq (message queue)
97
		* ntp (NTP daemon)
98
		* gevent
99
		* dns server
100

    
101
You can install apache2, progresql and ntp by running:
102

    
103
.. code-block:: console
104

    
105
   # apt-get install apache2 postgresql ntp
106

    
107
Make sure to install gunicorn >= v0.12.2. You can do this by installing from
108
the official debian backports:
109

    
110
.. code-block:: console
111

    
112
   # apt-get -t squeeze-backports install gunicorn
113

    
114
Also, make sure to install gevent >= 0.13.6. Again from the debian backports:
115

    
116
.. code-block:: console
117

    
118
   # apt-get -t squeeze-backports install python-gevent
119

    
120
On node1, we will create our databases, so you will also need the
121
python-psycopg2 package:
122

    
123
.. code-block:: console
124

    
125
   # apt-get install python-psycopg2
126

    
127
To install RabbitMQ>=2.8.4, use the RabbitMQ APT repository by adding the
128
following line to ``/etc/apt/sources.list``:
129

    
130
.. code-block:: console
131

    
132
    deb http://www.rabbitmq.com/debian testing main
133

    
134
Add RabbitMQ public key, to trusted key list:
135

    
136
.. code-block:: console
137

    
138
  # wget http://www.rabbitmq.com/rabbitmq-signing-key-public.asc
139
  # apt-key add rabbitmq-signing-key-public.asc
140

    
141
Finally, to install the package run:
142

    
143
.. code-block:: console
144

    
145
  # apt-get update
146
  # apt-get install rabbitmq-server
147

    
148
Database setup
149
~~~~~~~~~~~~~~
150

    
151
On node1, we create a database called ``snf_apps``, that will host all django
152
apps related tables. We also create the user ``synnefo`` and grant him all
153
privileges on the database. We do this by running:
154

    
155
.. code-block:: console
156

    
157
    root@node1:~ # su - postgres
158
    postgres@node1:~ $ psql
159
    postgres=# CREATE DATABASE snf_apps WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0;
160
    postgres=# CREATE USER synnefo WITH PASSWORD 'example_passw0rd';
161
    postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_apps TO synnefo;
162

    
163
We also create the database ``snf_pithos`` needed by the Pithos backend and
164
grant the ``synnefo`` user all privileges on the database. This database could
165
be created on node2 instead, but we do it on node1 for simplicity. We will
166
create all needed databases on node1 and then node2 will connect to them.
167

    
168
.. code-block:: console
169

    
170
    postgres=# CREATE DATABASE snf_pithos WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0;
171
    postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_pithos TO synnefo;
172

    
173
Configure the database to listen to all network interfaces. You can do this by
174
editting the file ``/etc/postgresql/8.4/main/postgresql.conf`` and change
175
``listen_addresses`` to ``'*'`` :
176

    
177
.. code-block:: console
178

    
179
    listen_addresses = '*'
180

    
181
Furthermore, edit ``/etc/postgresql/8.4/main/pg_hba.conf`` to allow node1 and
182
node2 to connect to the database. Add the following lines under ``#IPv4 local
183
connections:`` :
184

    
185
.. code-block:: console
186

    
187
    host		all	all	4.3.2.1/32	md5
188
    host		all	all	4.3.2.2/32	md5
189

    
190
Make sure to substitute "4.3.2.1" and "4.3.2.2" with node1's and node2's
191
actual IPs. Now, restart the server to apply the changes:
192

    
193
.. code-block:: console
194

    
195
   # /etc/init.d/postgresql restart
196

    
197
Gunicorn setup
198
~~~~~~~~~~~~~~
199

    
200
Create the file ``/etc/gunicorn.d/synnefo`` containing the following:
201

    
202
.. code-block:: console
203

    
204
    CONFIG = {
205
     'mode': 'django',
206
     'environment': {
207
       'DJANGO_SETTINGS_MODULE': 'synnefo.settings',
208
     },
209
     'working_dir': '/etc/synnefo',
210
     'user': 'www-data',
211
     'group': 'www-data',
212
     'args': (
213
       '--bind=127.0.0.1:8080',
214
       '--worker-class=gevent',
215
       '--workers=8',
216
       '--log-level=debug',
217
     ),
218
    }
219

    
220
.. warning:: Do NOT start the server yet, because it won't find the
221
    ``synnefo.settings`` module. Also, in case you are using ``/etc/hosts``
222
    instead of a DNS to get the hostnames, change ``--worker-class=gevent`` to
223
    ``--worker-class=sync``. We will start the server after successful
224
    installation of astakos. If the server is running::
225

    
226
       # /etc/init.d/gunicorn stop
227

    
228
Certificate Creation
229
~~~~~~~~~~~~~~~~~~~~~
230

    
231
Node1 will host Cyclades. Cyclades should communicate with the other snf tools over a trusted connection.
232
In order for the connection to be trusted, the keys provided to apache below should be signed with a certificate.
233
This certificate should be added to all nodes. In case you don't have signed keys you can create a self-signed certificate
234
and sign your keys with this. To do so on node1 run
235

    
236
.. code-block:: console
237

    
238
		# aptitude install openvpn
239
		# mkdir /etc/openvpn/easy-rsa
240
		# cp -ai /usr/share/doc/openvpn/examples/easy-rsa/2.0/ /etc/openvpn/easy-rsa
241
		# cd /etc/openvpn/easy-rsa/2.0
242
		# vim vars
243

    
244
In vars you can set your own parameters such as KEY_COUNTRY
245

    
246
.. code-block:: console
247

    
248
	# . ./vars
249
	# ./clean-all
250

    
251
Now you can create the certificate
252

    
253
.. code-block:: console 
254
		
255
		# ./build-ca
256

    
257
The previous will create a ``ca.crt`` file. Copy this file under
258
``/usr/local/share/ca-certificates/`` directory and run :
259

    
260
.. code-block:: console
261

    
262
		# update-ca-certificates
263

    
264
to update the records. You will have to do the following on node2 as well.
265

    
266
Now you can create the keys and sign them with the certificate
267

    
268
.. code-block:: console
269
		
270
		# ./build-key-server node1.example.com
271

    
272
This will create a .pem and a .key file in your current folder. Copy these in
273
``/etc/ssl/certs/`` and ``/etc/ssl/private/`` respectively and 
274
use them in the apache2 configuration file below instead of the defaults.
275

    
276
Apache2 setup
277
~~~~~~~~~~~~~
278

    
279
Create the file ``/etc/apache2/sites-available/synnefo`` containing the
280
following:
281

    
282
.. code-block:: console
283

    
284
    <VirtualHost *:80>
285
        ServerName node1.example.com
286

    
287
        RewriteEngine On
288
        RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC]
289
        RewriteRule ^(.*)$ - [F,L]
290
        RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
291
    </VirtualHost>
292

    
293

    
294
Create the file ``/etc/apache2/sites-available/synnefo-ssl`` containing the
295
following:
296

    
297
.. code-block:: console
298

    
299
    <IfModule mod_ssl.c>
300
    <VirtualHost _default_:443>
301
        ServerName node1.example.com
302

    
303
        Alias /static "/usr/share/synnefo/static"
304

    
305
        #  SetEnv no-gzip
306
        #  SetEnv dont-vary
307

    
308
       AllowEncodedSlashes On
309

    
310
       RequestHeader set X-Forwarded-Protocol "https"
311

    
312
    <Proxy * >
313
        Order allow,deny
314
        Allow from all
315
    </Proxy>
316

    
317
        SetEnv                proxy-sendchunked
318
        SSLProxyEngine        off
319
        ProxyErrorOverride    off
320

    
321
        ProxyPass        /static !
322
        ProxyPass        / http://localhost:8080/ retry=0
323
        ProxyPassReverse / http://localhost:8080/
324

    
325
        RewriteEngine On
326
        RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC]
327
        RewriteRule ^(.*)$ - [F,L]
328

    
329
        SSLEngine on
330
        SSLCertificateFile    /etc/ssl/certs/ssl-cert-snakeoil.pem
331
        SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
332
    </VirtualHost>
333
    </IfModule>
334

    
335
Now enable sites and modules by running:
336

    
337
.. code-block:: console
338

    
339
   # a2enmod ssl
340
   # a2enmod rewrite
341
   # a2dissite default
342
   # a2ensite synnefo
343
   # a2ensite synnefo-ssl
344
   # a2enmod headers
345
   # a2enmod proxy_http
346

    
347
.. warning:: Do NOT start/restart the server yet. If the server is running::
348

    
349
       # /etc/init.d/apache2 stop
350

    
351

    
352
.. _rabbitmq-setup:
353

    
354
Message Queue setup
355
~~~~~~~~~~~~~~~~~~~
356

    
357
The message queue will run on node1, so we need to create the appropriate
358
rabbitmq user. The user is named ``synnefo`` and gets full privileges on all
359
exchanges:
360

    
361
.. code-block:: console
362

    
363
   # rabbitmqctl add_user synnefo "example_rabbitmq_passw0rd"
364
   # rabbitmqctl set_permissions synnefo ".*" ".*" ".*"
365

    
366
We do not need to initialize the exchanges. This will be done automatically,
367
during the Cyclades setup.
368

    
369
Pithos data directory setup
370
~~~~~~~~~~~~~~~~~~~~~~~~~~~
371

    
372
As mentioned in the General Prerequisites section, there is a directory called
373
``/srv/pithos`` visible by both nodes. We create and setup the ``data``
374
directory inside it:
375

    
376
.. code-block:: console
377

    
378
   # cd /srv/pithos
379
   # mkdir data
380
   # chown www-data:www-data data
381
   # chmod g+ws data
382

    
383
DNS server setup
384
~~~~~~~~~~~~~~~~
385

    
386
If your machines are not under the same domain nameyou have to set up a dns server.
387
In order to set up a dns server using dnsmasq do the following
388

    
389
.. code-block:: console
390
			
391
				# apt-get install dnsmasq
392

    
393
Then edit you ``/etc/hosts/`` as follows
394

    
395
.. code-block:: console
396

    
397
		4.3.2.1     node1.example.com
398
		4.3.2.2     node2.example.com
399

    
400
Finally edit the ``/etc/dnsmasq.conf`` file and specify the ``listen-address`` and
401
the ``interface`` you would like to listen to.
402

    
403
Also add the following in your ``/etc/resolv.conf`` file 
404

    
405
.. code-block:: console
406

    
407
		nameserver 4.3.2.1
408

    
409
You are now ready with all general prerequisites concerning node1. Let's go to
410
node2.
411

    
412
Node2
413
-----
414

    
415
General Synnefo dependencies
416
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
417

    
418
    * apache (http server)
419
    * gunicorn (WSGI http server)
420
    * postgresql (database)
421
    * ntp (NTP daemon)
422
    * gevent
423
    * certificates
424
    * dns setup
425

    
426
You can install the above by running:
427

    
428
.. code-block:: console
429

    
430
   # apt-get install apache2 postgresql ntp
431

    
432
Make sure to install gunicorn >= v0.12.2. You can do this by installing from
433
the official debian backports:
434

    
435
.. code-block:: console
436

    
437
   # apt-get -t squeeze-backports install gunicorn
438

    
439
Also, make sure to install gevent >= 0.13.6. Again from the debian backports:
440

    
441
.. code-block:: console
442

    
443
   # apt-get -t squeeze-backports install python-gevent
444

    
445
Node2 will connect to the databases on node1, so you will also need the
446
python-psycopg2 package:
447

    
448
.. code-block:: console
449

    
450
   # apt-get install python-psycopg2
451

    
452
Database setup
453
~~~~~~~~~~~~~~
454

    
455
All databases have been created and setup on node1, so we do not need to take
456
any action here. From node2, we will just connect to them. When you get familiar
457
with the software you may choose to run different databases on different nodes,
458
for performance/scalability/redundancy reasons, but those kind of setups are out
459
of the purpose of this guide.
460

    
461
Gunicorn setup
462
~~~~~~~~~~~~~~
463

    
464
Create the file ``/etc/gunicorn.d/synnefo`` containing the following
465
(same contents as in node1; you can just copy/paste the file):
466

    
467
.. code-block:: console
468

    
469
    CONFIG = {
470
     'mode': 'django',
471
     'environment': {
472
      'DJANGO_SETTINGS_MODULE': 'synnefo.settings',
473
     },
474
     'working_dir': '/etc/synnefo',
475
     'user': 'www-data',
476
     'group': 'www-data',
477
     'args': (
478
       '--bind=127.0.0.1:8080',
479
       '--worker-class=gevent',
480
       '--workers=4',
481
       '--log-level=debug',
482
       '--timeout=43200'
483
     ),
484
    }
485

    
486
.. warning:: Do NOT start the server yet, because it won't find the
487
    ``synnefo.settings`` module. Also, in case you are using ``/etc/hosts``
488
    instead of a DNS to get the hostnames, change ``--worker-class=gevent`` to
489
    ``--worker-class=sync``. We will start the server after successful
490
    installation of astakos. If the server is running::
491

    
492
       # /etc/init.d/gunicorn stop
493

    
494
Apache2 setup
495
~~~~~~~~~~~~~
496

    
497
Create the file ``/etc/apache2/sites-available/synnefo`` containing the
498
following:
499

    
500
.. code-block:: console
501

    
502
    <VirtualHost *:80>
503
        ServerName node2.example.com
504

    
505
        RewriteEngine On
506
        RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC]
507
        RewriteRule ^(.*)$ - [F,L]
508
        RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
509
    </VirtualHost>
510

    
511
Create the file ``synnefo-ssl`` under ``/etc/apache2/sites-available/``
512
containing the following:
513

    
514
.. code-block:: console
515

    
516
    <IfModule mod_ssl.c>
517
    <VirtualHost _default_:443>
518
        ServerName node2.example.com
519

    
520
        Alias /static "/usr/share/synnefo/static"
521

    
522
        SetEnv no-gzip
523
        SetEnv dont-vary
524
        AllowEncodedSlashes On
525

    
526
        RequestHeader set X-Forwarded-Protocol "https"
527

    
528
        <Proxy * >
529
            Order allow,deny
530
            Allow from all
531
        </Proxy>
532

    
533
        SetEnv                proxy-sendchunked
534
        SSLProxyEngine        off
535
        ProxyErrorOverride    off
536

    
537
        ProxyPass        /static !
538
        ProxyPass        / http://localhost:8080/ retry=0
539
        ProxyPassReverse / http://localhost:8080/
540

    
541
        SSLEngine on
542
        SSLCertificateFile    /etc/ssl/certs/ssl-cert-snakeoil.pem
543
        SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
544
    </VirtualHost>
545
    </IfModule>
546

    
547
As in node1, enable sites and modules by running:
548

    
549
.. code-block:: console
550

    
551
   # a2enmod ssl
552
   # a2enmod rewrite
553
   # a2dissite default
554
   # a2ensite synnefo
555
   # a2ensite synnefo-ssl
556
   # a2enmod headers
557
   # a2enmod proxy_http
558

    
559
.. warning:: Do NOT start/restart the server yet. If the server is running::
560

    
561
       # /etc/init.d/apache2 stop
562

    
563

    
564
Acquire certificate
565
~~~~~~~~~~~~~~~~~~~
566

    
567
Copy the certificate you created before on node1 (`ca.crt`) under the directory
568
``/usr/local/share/ca-certificate``
569

    
570
and run:
571

    
572
.. code-block:: console
573

    
574
		# update-ca-certificates
575

    
576
to update the records.
577

    
578

    
579
DNS Setup
580
~~~~~~~~~
581

    
582
Add the following line in ``/etc/resolv.conf`` file
583

    
584
.. code-block:: console
585
		
586
		nameserver 4.3.2.1
587

    
588
to inform the node about the new dns server.
589

    
590
We are now ready with all general prerequisites for node2. Now that we have
591
finished with all general prerequisites for both nodes, we can start installing
592
the services. First, let's install Astakos on node1.
593

    
594
Installation of Astakos on node1
595
================================
596

    
597
To install astakos, grab the package from our repository (make sure  you made
598
the additions needed in your ``/etc/apt/sources.list`` file, as described
599
previously), by running:
600

    
601
.. code-block:: console
602

    
603
   # apt-get install snf-astakos-app snf-pithos-backend
604

    
605
.. _conf-astakos:
606

    
607
Configuration of Astakos
608
========================
609

    
610
Conf Files
611
----------
612

    
613
After astakos is successfully installed, you will find the directory
614
``/etc/synnefo`` and some configuration files inside it. The files contain
615
commented configuration options, which are the default options. While installing
616
new snf-* components, new configuration files will appear inside the directory.
617
In this guide (and for all services), we will edit only the minimum necessary
618
configuration options, to reflect our setup. Everything else will remain as is.
619

    
620
After getting familiar with synnefo, you will be able to customize the software
621
as you wish and fits your needs. Many options are available, to empower the
622
administrator with extensively customizable setups.
623

    
624
For the snf-webproject component (installed as an astakos dependency), we
625
need the following:
626

    
627
Edit ``/etc/synnefo/10-snf-webproject-database.conf``. You will need to
628
uncomment and edit the ``DATABASES`` block to reflect our database:
629

    
630
.. code-block:: console
631

    
632
    DATABASES = {
633
     'default': {
634
         # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle'
635
         'ENGINE': 'postgresql_psycopg2',
636
         # ATTENTION: This *must* be the absolute path if using sqlite3.
637
         # See: http://docs.djangoproject.com/en/dev/ref/settings/#name
638
         'NAME': 'snf_apps',
639
         'USER': 'synnefo',                      # Not used with sqlite3.
640
         'PASSWORD': 'example_passw0rd',         # Not used with sqlite3.
641
         # Set to empty string for localhost. Not used with sqlite3.
642
         'HOST': '4.3.2.1',
643
         # Set to empty string for default. Not used with sqlite3.
644
         'PORT': '5432',
645
     }
646
    }
647

    
648
Edit ``/etc/synnefo/10-snf-webproject-deploy.conf``. Uncomment and edit
649
``SECRET_KEY``. This is a Django specific setting which is used to provide a
650
seed in secret-key hashing algorithms. Set this to a random string of your
651
choice and keep it private:
652

    
653
.. code-block:: console
654

    
655
    SECRET_KEY = 'sy6)mw6a7x%n)-example_secret_key#zzk4jo6f2=uqu!1o%)'
656

    
657
For astakos specific configuration, edit the following options in
658
``/etc/synnefo/20-snf-astakos-app-settings.conf`` :
659

    
660
.. code-block:: console
661

    
662
    ASTAKOS_COOKIE_DOMAIN = '.example.com'
663

    
664
    ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
665

    
666
The ``ASTAKOS_COOKIE_DOMAIN`` should be the base url of our domain (for all
667
services). ``ASTAKOS_BASE_URL`` is the astakos top-level URL. Appending an
668
extra path (``/astakos`` here) is recommended in order to distinguish
669
components, if more than one are installed on the same machine.
670

    
671
.. note:: For the purpose of this guide, we don't enable recaptcha authentication.
672
    If you would like to enable it, you have to edit the following options:
673

    
674
    .. code-block:: console
675

    
676
        ASTAKOS_RECAPTCHA_PUBLIC_KEY = 'example_recaptcha_public_key!@#$%^&*('
677
        ASTAKOS_RECAPTCHA_PRIVATE_KEY = 'example_recaptcha_private_key!@#$%^&*('
678
        ASTAKOS_RECAPTCHA_USE_SSL = True
679
        ASTAKOS_RECAPTCHA_ENABLED = True
680

    
681
    For the ``ASTAKOS_RECAPTCHA_PUBLIC_KEY`` and ``ASTAKOS_RECAPTCHA_PRIVATE_KEY``
682
    go to https://www.google.com/recaptcha/admin/create and create your own pair.
683

    
684
Then edit ``/etc/synnefo/20-snf-astakos-app-cloudbar.conf`` :
685

    
686
.. code-block:: console
687

    
688
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
689

    
690
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
691

    
692
    CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu'
693

    
694
Those settings have to do with the black cloudbar endpoints and will be
695
described in more detail later on in this guide. For now, just edit the domain
696
to point at node1 which is where we have installed Astakos.
697

    
698
If you are an advanced user and want to use the Shibboleth Authentication
699
method, read the relative :ref:`section <shibboleth-auth>`.
700

    
701
.. _email-configuration:
702

    
703
Email delivery configuration
704
----------------------------
705

    
706
Many of the ``astakos`` operations require server to notify service users and 
707
administrators via email. e.g. right after the signup process the service sents 
708
an email to the registered email address containing an email verification url, 
709
after the user verifies the email address astakos once again needs to notify 
710
administrators with a notice that a new account has just been verified.
711

    
712
More specifically astakos sends emails in the following cases
713

    
714
- An email containing a verification link after each signup process.
715
- An email to the people listed in ``ADMINS`` setting after each email 
716
  verification if ``ASTAKOS_MODERATION`` setting is ``True``. The email 
717
  notifies administrators that an additional action is required in order to 
718
  activate the user.
719
- A welcome email to the user email and an admin notification to ``ADMINS`` 
720
  right after each account activation.
721
- Feedback messages submited from astakos contact view and astakos feedback 
722
  API endpoint are sent to contacts listed in ``HELPDESK`` setting.
723
- Project application request notifications to people included in ``HELPDESK`` 
724
  and ``MANAGERS`` settings.
725
- Notifications after each project members action (join request, membership 
726
  accepted/declinde etc.) to project members or project owners.
727

    
728
Astakos uses the Django internal email delivering mechanism to send email 
729
notifications. A simple configuration, using an external smtp server to 
730
deliver messages, is shown below. Alter the following example to meet your 
731
smtp server characteristics. Notice that the smtp server is needed for a proper
732
installation
733

    
734
.. code-block:: python
735
    
736
    # /etc/synnefo/00-snf-common-admins.conf
737
    EMAIL_HOST = "mysmtp.server.synnefo.org"
738
    EMAIL_HOST_USER = "<smtpuser>"
739
    EMAIL_HOST_PASSWORD = "<smtppassword>"
740

    
741
    # this gets appended in all email subjects
742
    EMAIL_SUBJECT_PREFIX = "[example.synnefo.org] "
743
    
744
    # Address to use for outgoing emails
745
    DEFAULT_FROM_EMAIL = "server@example.synnefo.org"
746

    
747
    # Email where users can contact for support. This is used in html/email 
748
    # templates.
749
    CONTACT_EMAIL = "server@example.synnefo.org"
750

    
751
    # The email address that error messages come from
752
    SERVER_EMAIL = "server-errors@example.synnefo.org"
753

    
754
Notice that since email settings might be required by applications other than
755
astakos they are defined in a different configuration file than the one
756
previously used to set astakos specific settings. 
757

    
758
Refer to 
759
`Django documentation <https://docs.djangoproject.com/en/1.2/topics/email/>`_
760
for additional information on available email settings.
761

    
762
As refered in the previous section, based on the operation that triggers 
763
an email notification, the recipients list differs. Specifically for 
764
emails whose recipients include contacts from your service team 
765
(administrators, managers, helpdesk etc) synnefo provides the following 
766
settings located in ``10-snf-common-admins.conf``:
767

    
768
.. code-block:: python
769

    
770
    ADMINS = (('Admin name', 'admin@example.synnefo.org'), 
771
              ('Admin2 name', 'admin2@example.synnefo.org))
772
    MANAGERS = (('Manager name', 'manager@example.synnefo.org'),)
773
    HELPDESK = (('Helpdesk user name', 'helpdesk@example.synnefo.org'),)
774

    
775

    
776

    
777
Enable Pooling
778
--------------
779

    
780
This section can be bypassed, but we strongly recommend you apply the following,
781
since they result in a significant performance boost.
782

    
783
Synnefo includes a pooling DBAPI driver for PostgreSQL, as a thin wrapper
784
around Psycopg2. This allows independent Django requests to reuse pooled DB
785
connections, with significant performance gains.
786

    
787
To use, first monkey-patch psycopg2. For Django, run this before the
788
``DATABASES`` setting in ``/etc/synnefo/10-snf-webproject-database.conf``:
789

    
790
.. code-block:: console
791

    
792
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
793
    monkey_patch_psycopg2()
794

    
795
Since we are running with greenlets, we should modify psycopg2 behavior, so it
796
works properly in a greenlet context:
797

    
798
.. code-block:: console
799

    
800
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
801
    make_psycopg_green()
802

    
803
Use the Psycopg2 driver as usual. For Django, this means using
804
``django.db.backends.postgresql_psycopg2`` without any modifications. To enable
805
connection pooling, pass a nonzero ``synnefo_poolsize`` option to the DBAPI
806
driver, through ``DATABASES.OPTIONS`` in Django.
807

    
808
All the above will result in an ``/etc/synnefo/10-snf-webproject-database.conf``
809
file that looks like this:
810

    
811
.. code-block:: console
812

    
813
    # Monkey-patch psycopg2
814
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
815
    monkey_patch_psycopg2()
816

    
817
    # If running with greenlets
818
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
819
    make_psycopg_green()
820

    
821
    DATABASES = {
822
     'default': {
823
         # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle'
824
         'ENGINE': 'postgresql_psycopg2',
825
         'OPTIONS': {'synnefo_poolsize': 8},
826

    
827
         # ATTENTION: This *must* be the absolute path if using sqlite3.
828
         # See: http://docs.djangoproject.com/en/dev/ref/settings/#name
829
         'NAME': 'snf_apps',
830
         'USER': 'synnefo',                      # Not used with sqlite3.
831
         'PASSWORD': 'example_passw0rd',         # Not used with sqlite3.
832
         # Set to empty string for localhost. Not used with sqlite3.
833
         'HOST': '4.3.2.1',
834
         # Set to empty string for default. Not used with sqlite3.
835
         'PORT': '5432',
836
     }
837
    }
838

    
839
Database Initialization
840
-----------------------
841

    
842
After configuration is done, we initialize the database by running:
843

    
844
.. code-block:: console
845

    
846
    # snf-manage syncdb
847

    
848
At this example we don't need to create a django superuser, so we select
849
``[no]`` to the question. After a successful sync, we run the migration needed
850
for astakos:
851

    
852
.. code-block:: console
853

    
854
    # snf-manage migrate im
855
    # snf-manage migrate quotaholder_app
856

    
857
Then, we load the pre-defined user groups
858

    
859
.. code-block:: console
860

    
861
    # snf-manage loaddata groups
862

    
863
.. _services-reg:
864

    
865
Services Registration
866
---------------------
867

    
868
When the database is ready, we need to register the services. The following
869
command will ask you to register the standard Synnefo components (astakos,
870
cyclades, and pithos) along with the services they provide. Note that you
871
have to register at least astakos in order to have a usable authentication
872
system. For each component, you will be asked to provide two URLs: its base
873
URL and its UI URL.
874

    
875
The former is the location where the component resides; it should equal
876
the ``<component_name>_BASE_URL`` as specified in the respective component
877
settings. For example, the base URL for astakos would be
878
``https://node1.example.com/astakos``.
879

    
880
The latter is the URL that appears in the Cloudbar and leads to the
881
component UI. If you want to follow the default setup, set
882
the UI URL to ``<base_url>/ui/`` where ``base_url`` the component's base
883
URL as explained before. (You can later change the UI URL with
884
``snf-manage component-modify <component_name> --url new_ui_url``.)
885

    
886
The command will also register automatically the resource definitions
887
offered by the services.
888

    
889
.. code-block:: console
890

    
891
    # snf-component-register
892

    
893
.. note::
894

    
895
   This command is equivalent to running the following series of commands;
896
   it registers the three components in astakos and then in each host it
897
   exports the respective service definitions, copies the exported json file
898
   to the astakos host, where it finally imports it:
899

    
900
    .. code-block:: console
901

    
902
       astakos-host$ snf-manage component-add astakos astakos_ui_url
903
       astakos-host$ snf-manage component-add cyclades cyclades_ui_url
904
       astakos-host$ snf-manage component-add pithos pithos_ui_url
905
       astakos-host$ snf-manage service-export-astakos > astakos.json
906
       astakos-host$ snf-manage service-import --json astakos.json
907
       cyclades-host$ snf-manage service-export-cyclades > cyclades.json
908
       # copy the file to astakos-host
909
       astakos-host$ snf-manage service-import --json cyclades.json
910
       pithos-host$ snf-manage service-export-pithos > pithos.json
911
       # copy the file to astakos-host
912
       astakos-host$ snf-manage service-import --json pithos.json
913

    
914
Notice that in this installation astakos and cyclades are in node1 and pithos is in node2
915

    
916
Setting Default Base Quota for Resources
917
----------------------------------------
918

    
919
We now have to specify the limit on resources that each user can employ
920
(exempting resources offered by projects).
921

    
922
.. code-block:: console
923

    
924
    # snf-manage resource-modify --limit-interactive
925

    
926

    
927
Servers Initialization
928
----------------------
929

    
930
Finally, we initialize the servers on node1:
931

    
932
.. code-block:: console
933

    
934
    root@node1:~ # /etc/init.d/gunicorn restart
935
    root@node1:~ # /etc/init.d/apache2 restart
936

    
937
We have now finished the Astakos setup. Let's test it now.
938

    
939

    
940
Testing of Astakos
941
==================
942

    
943
Open your favorite browser and go to:
944

    
945
``http://node1.example.com/astakos``
946

    
947
If this redirects you to ``https://node1.example.com/astakos/ui/`` and you can see
948
the "welcome" door of Astakos, then you have successfully setup Astakos.
949

    
950
Let's create our first user. At the homepage click the "CREATE ACCOUNT" button
951
and fill all your data at the sign up form. Then click "SUBMIT". You should now
952
see a green box on the top, which informs you that you made a successful request
953
and the request has been sent to the administrators. So far so good, let's
954
assume that you created the user with username ``user@example.com``.
955

    
956
Now we need to activate that user. Return to a command prompt at node1 and run:
957

    
958
.. code-block:: console
959

    
960
    root@node1:~ # snf-manage user-list
961

    
962
This command should show you a list with only one user; the one we just created.
963
This user should have an id with a value of ``1`` and flag "active" and
964
"verified" set to False. Now run:
965

    
966
.. code-block:: console
967

    
968
    root@node1:~ # snf-manage user-modify 1 --verify --accept
969

    
970
This verifies the user email and activates the user.
971
When running in production, the activation is done automatically with different
972
types of moderation, that Astakos supports. You can see the moderation methods
973
(by invitation, whitelists, matching regexp, etc.) at the Astakos specific
974
documentation. In production, you can also manually activate a user, by sending
975
him/her an activation email. See how to do this at the :ref:`User
976
activation <user_activation>` section.
977

    
978
Now let's go back to the homepage. Open ``http://node1.example.com/astkos/ui/`` with
979
your browser again. Try to sign in using your new credentials. If the astakos
980
menu appears and you can see your profile, then you have successfully setup
981
Astakos.
982

    
983
Let's continue to install Pithos now.
984

    
985

    
986
Installation of Pithos on node2
987
===============================
988

    
989
To install Pithos, grab the packages from our repository (make sure  you made
990
the additions needed in your ``/etc/apt/sources.list`` file, as described
991
previously), by running:
992

    
993
.. code-block:: console
994

    
995
   # apt-get install snf-pithos-app snf-pithos-backend
996

    
997
Now, install the pithos web interface:
998

    
999
.. code-block:: console
1000

    
1001
   # apt-get install snf-pithos-webclient
1002

    
1003
This package provides the standalone pithos web client. The web client is the
1004
web UI for Pithos and will be accessible by clicking "pithos" on the Astakos
1005
interface's cloudbar, at the top of the Astakos homepage.
1006

    
1007

    
1008
.. _conf-pithos:
1009

    
1010
Configuration of Pithos
1011
=======================
1012

    
1013
Conf Files
1014
----------
1015

    
1016
After Pithos is successfully installed, you will find the directory
1017
``/etc/synnefo`` and some configuration files inside it, as you did in node1
1018
after installation of astakos. Here, you will not have to change anything that
1019
has to do with snf-common or snf-webproject. Everything is set at node1. You
1020
only need to change settings that have to do with Pithos. Specifically:
1021

    
1022
Edit ``/etc/synnefo/20-snf-pithos-app-settings.conf``. There you need to set
1023
this options:
1024

    
1025
.. code-block:: console
1026

    
1027
   ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
1028

    
1029
   PITHOS_BASE_URL = 'https://node2.example.com/pithos'
1030
   PITHOS_BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
1031
   PITHOS_BACKEND_BLOCK_PATH = '/srv/pithos/data'
1032

    
1033
   PITHOS_SERVICE_TOKEN = 'pithos_service_token22w'
1034

    
1035
   # Set to False if astakos & pithos are on the same host
1036
   PITHOS_PROXY_USER_SERVICES = True
1037

    
1038

    
1039
The ``PITHOS_BACKEND_DB_CONNECTION`` option tells to the Pithos app where to
1040
find the Pithos backend database. Above we tell Pithos that its database is
1041
``snf_pithos`` at node1 and to connect as user ``synnefo`` with password
1042
``example_passw0rd``.  All those settings where setup during node1's "Database
1043
setup" section.
1044

    
1045
The ``PITHOS_BACKEND_BLOCK_PATH`` option tells to the Pithos app where to find
1046
the Pithos backend data. Above we tell Pithos to store its data under
1047
``/srv/pithos/data``, which is visible by both nodes. We have already setup this
1048
directory at node1's "Pithos data directory setup" section.
1049

    
1050
The ``ASTAKOS_BASE_URL`` option informs the Pithos app where Astakos is.
1051
The Astakos service is used for user management (authentication, quotas, etc.)
1052

    
1053
The ``PITHOS_BASE_URL`` setting must point to the top-level Pithos URL.
1054

    
1055
The ``PITHOS_SERVICE_TOKEN`` is the token used for authentication with astakos.
1056
It can be retrieved by running on the Astakos node (node1 in our case):
1057

    
1058
.. code-block:: console
1059

    
1060
   # snf-manage component-list
1061

    
1062
The token has been generated automatically during the :ref:`Pithos service
1063
registration <services-reg>`.
1064

    
1065
The ``PITHOS_UPDATE_MD5`` option by default disables the computation of the
1066
object checksums. This results to improved performance during object uploading.
1067
However, if compatibility with the OpenStack Object Storage API is important
1068
then it should be changed to ``True``.
1069

    
1070
Then edit ``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf``, to connect the
1071
Pithos web UI with the astakos web UI (through the top cloudbar):
1072

    
1073
.. code-block:: console
1074

    
1075
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
1076
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
1077
    CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu'
1078

    
1079
The ``CLOUDBAR_LOCATION`` tells the client where to find the astakos common
1080
cloudbar.
1081

    
1082
The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are used by the
1083
Pithos web client to get from astakos all the information needed to fill its
1084
own cloudbar. So we put our astakos deployment urls there.
1085

    
1086
Pooling and Greenlets
1087
---------------------
1088

    
1089
Pithos is pooling-ready without the need of further configuration, because it
1090
doesn't use a Django DB. It pools HTTP connections to Astakos and pithos
1091
backend objects for access to the Pithos DB.
1092

    
1093
However, as in Astakos, since we are running with Greenlets, it is also
1094
recommended to modify psycopg2 behavior so it works properly in a greenlet
1095
context. This means adding the following lines at the top of your
1096
``/etc/synnefo/10-snf-webproject-database.conf`` file:
1097

    
1098
.. code-block:: console
1099

    
1100
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
1101
    make_psycopg_green()
1102

    
1103
Furthermore, add the ``--worker-class=gevent`` (or ``--worker-class=sync`` as
1104
mentioned above, depending on your setup) argument on your
1105
``/etc/gunicorn.d/synnefo`` configuration file. The file should look something
1106
like this:
1107

    
1108
.. code-block:: console
1109

    
1110
    CONFIG = {
1111
     'mode': 'django',
1112
     'environment': {
1113
       'DJANGO_SETTINGS_MODULE': 'synnefo.settings',
1114
     },
1115
     'working_dir': '/etc/synnefo',
1116
     'user': 'www-data',
1117
     'group': 'www-data',
1118
     'args': (
1119
       '--bind=127.0.0.1:8080',
1120
       '--workers=4',
1121
       '--worker-class=gevent',
1122
       '--log-level=debug',
1123
       '--timeout=43200'
1124
     ),
1125
    }
1126

    
1127
Stamp Database Revision
1128
-----------------------
1129

    
1130
Pithos uses the alembic_ database migrations tool.
1131

    
1132
.. _alembic: http://alembic.readthedocs.org
1133

    
1134
After a successful installation, we should stamp it at the most recent
1135
revision, so that future migrations know where to start upgrading in
1136
the migration history.
1137

    
1138
.. code-block:: console
1139

    
1140
    root@node2:~ # pithos-migrate stamp head
1141

    
1142
Servers Initialization
1143
----------------------
1144

    
1145
After configuration is done, we initialize the servers on node2:
1146

    
1147
.. code-block:: console
1148

    
1149
    root@node2:~ # /etc/init.d/gunicorn restart
1150
    root@node2:~ # /etc/init.d/apache2 restart
1151

    
1152
You have now finished the Pithos setup. Let's test it now.
1153

    
1154

    
1155
Testing of Pithos
1156
=================
1157

    
1158
Open your browser and go to the Astakos homepage:
1159

    
1160
``http://node1.example.com/astakos``
1161

    
1162
Login, and you will see your profile page. Now, click the "pithos" link on the
1163
top black cloudbar. If everything was setup correctly, this will redirect you
1164
to:
1165

    
1166

    
1167
and you will see the blue interface of the Pithos application.  Click the
1168
orange "Upload" button and upload your first file. If the file gets uploaded
1169
successfully, then this is your first sign of a successful Pithos installation.
1170
Go ahead and experiment with the interface to make sure everything works
1171
correctly.
1172

    
1173
You can also use the Pithos clients to sync data from your Windows PC or MAC.
1174

    
1175
If you don't stumble on any problems, then you have successfully installed
1176
Pithos, which you can use as a standalone File Storage Service.
1177

    
1178
If you would like to do more, such as:
1179

    
1180
    * Spawning VMs
1181
    * Spawning VMs from Images stored on Pithos
1182
    * Uploading your custom Images to Pithos
1183
    * Spawning VMs from those custom Images
1184
    * Registering existing Pithos files as Images
1185
    * Connect VMs to the Internet
1186
    * Create Private Networks
1187
    * Add VMs to Private Networks
1188

    
1189
please continue with the rest of the guide.
1190

    
1191

    
1192
Cyclades Prerequisites
1193
======================
1194

    
1195
Before proceeding with the Cyclades installation, make sure you have
1196
successfully set up Astakos and Pithos first, because Cyclades depends on
1197
them. If you don't have a working Astakos and Pithos installation yet, please
1198
return to the :ref:`top <quick-install-admin-guide>` of this guide.
1199

    
1200
Besides Astakos and Pithos, you will also need a number of additional working
1201
prerequisites, before you start the Cyclades installation.
1202

    
1203
Ganeti
1204
------
1205

    
1206
`Ganeti <http://code.google.com/p/ganeti/>`_ handles the low level VM management
1207
for Cyclades, so Cyclades requires a working Ganeti installation at the backend.
1208
Please refer to the
1209
`ganeti documentation <http://docs.ganeti.org/ganeti/2.6/html>`_ for all the
1210
gory details. A successful Ganeti installation concludes with a working
1211
:ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs
1212
<GANETI_NODES>`.
1213

    
1214
The above Ganeti cluster can run on different physical machines than node1 and
1215
node2 and can scale independently, according to your needs.
1216

    
1217
For the purpose of this guide, we will assume that the :ref:`GANETI-MASTER
1218
<GANETI_NODES>` runs on node1 and is VM-capable. Also, node2 is a
1219
:ref:`GANETI-NODE <GANETI_NODES>` and is Master-capable and VM-capable too.
1220

    
1221
We highly recommend that you read the official Ganeti documentation, if you are
1222
not familiar with Ganeti. 
1223

    
1224
Unfortunately, the current stable version of the stock Ganeti (v2.6.2) doesn't
1225
support IP pool management. This feature will be available in Ganeti >= 2.7.
1226
Synnefo depends on the IP pool functionality of Ganeti, so you have to use
1227
GRNET provided packages until stable 2.7 is out. These packages will also install
1228
the proper version of Ganeti. To do so:
1229

    
1230
.. code-block:: console
1231

    
1232
   # apt-get install snf-ganeti ganeti-htools
1233

    
1234
Ganeti will make use of drbd. To enable this and make the configuration pemanent 
1235
you have to do the following :
1236

    
1237
.. code-block:: console
1238

    
1239
		# rmmod -f drbd && modprobe drbd minor_count=255 usermode_helper=/bin/true	
1240
		# echo 'drbd minor_count=255 usermode_helper=/bin/true' >> /etc/modules
1241

    
1242

    
1243
We assume that Ganeti will use the KVM hypervisor. After installing Ganeti on
1244
both nodes, choose a domain name that resolves to a valid floating IP (let's
1245
say it's ``ganeti.node1.example.com``). This IP is needed to communicate with 
1246
the Ganeti cluster. Make sure node1 and node2 have same dsa,rsa keys and authorised_keys 
1247
for password-less root ssh between each other. If not then skip passing --no-ssh-init but be 
1248
aware that it will replace /root/.ssh/* related files and you might lose access to master node. 
1249
Also, Ganeti will need a volume to host your VMs' disks. So, make sure there is an lvm volume 
1250
group named ``ganeti``. Finally, setup a bridge interface on the host machines (e.g: br0). This  
1251
will be needed for the network configuration afterwards.
1252

    
1253
Then run on node1:
1254

    
1255
.. code-block:: console
1256

    
1257
    root@node1:~ # gnt-cluster init --enabled-hypervisors=kvm --no-ssh-init \
1258
                    --no-etc-hosts --vg-name=ganeti --nic-parameters link=br0 \
1259
                    --master-netdev eth0 ganeti.node1.example.com
1260
    root@node1:~ # gnt-cluster modify --default-iallocator hail
1261
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:kernel_path=
1262
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:vnc_bind_address=0.0.0.0
1263

    
1264
    root@node1:~ # gnt-node add --no-ssh-key-check --master-capable=yes \
1265
                    --vm-capable=yes node2.example.com
1266
    root@node1:~ # gnt-cluster modify --disk-parameters=drbd:metavg=ganeti
1267
    root@node1:~ # gnt-group modify --disk-parameters=drbd:metavg=ganeti default
1268

    
1269
For any problems you may stumble upon installing Ganeti, please refer to the
1270
`official documentation <http://docs.ganeti.org/ganeti/2.6/html>`_. Installation
1271
of Ganeti is out of the scope of this guide.
1272

    
1273
.. _cyclades-install-snfimage:
1274

    
1275
snf-image
1276
---------
1277

    
1278
Installation
1279
~~~~~~~~~~~~
1280
For :ref:`Cyclades <cyclades>` to be able to launch VMs from specified Images,
1281
you need the :ref:`snf-image <snf-image>` OS Definition installed on *all*
1282
VM-capable Ganeti nodes. This means we need :ref:`snf-image <snf-image>` on
1283
node1 and node2. You can do this by running on *both* nodes:
1284

    
1285
.. code-block:: console
1286

    
1287
   # apt-get install snf-image snf-pithos-backend python-psycopg2
1288

    
1289
snf-image also needs the `snf-pithos-backend <snf-pithos-backend>`, to be able
1290
to handle image files stored on Pithos. It also needs `python-psycopg2` to be
1291
able to access the Pithos database. This is why, we also install them on *all*
1292
VM-capable Ganeti nodes.
1293

    
1294
.. warning:: 
1295
		snf-image uses ``curl`` for handling URLs. This means that it will
1296
		not  work out of the box if you try to use URLs served by servers which do
1297
		not have a valid certificate. In case you haven't followed the guide's
1298
		directions about the certificates,in order to circumvent this you should edit the file
1299
		``/etc/default/snf-image``. Change ``#CURL="curl"`` to ``CURL="curl -k"`` on every node.
1300

    
1301
After `snf-image` has been installed successfully, create the helper VM by
1302
running on *both* nodes:
1303

    
1304
.. code-block:: console
1305

    
1306
   # snf-image-update-helper
1307

    
1308
This will create all the needed files under ``/var/lib/snf-image/helper/`` for
1309
snf-image to run successfully, and it may take a few minutes depending on your
1310
Internet connection.
1311

    
1312
Configuration
1313
~~~~~~~~~~~~~
1314
snf-image supports native access to Images stored on Pithos. This means that
1315
it can talk directly to the Pithos backend, without the need of providing a
1316
public URL. More details, are described in the next section. For now, the only
1317
thing we need to do, is configure snf-image to access our Pithos backend.
1318

    
1319
To do this, we need to set the corresponding variables in
1320
``/etc/default/snf-image``, to reflect our Pithos setup:
1321

    
1322
.. code-block:: console
1323

    
1324
    PITHOS_DB="postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos"
1325

    
1326
    PITHOS_DATA="/srv/pithos/data"
1327

    
1328
If you have installed your Ganeti cluster on different nodes than node1 and
1329
node2 make sure that ``/srv/pithos/data`` is visible by all of them.
1330

    
1331
If you would like to use Images that are also/only stored locally, you need to
1332
save them under ``IMAGE_DIR``, however this guide targets Images stored only on
1333
Pithos.
1334

    
1335
Testing
1336
~~~~~~~
1337
You can test that snf-image is successfully installed by running on the
1338
:ref:`GANETI-MASTER <GANETI_NODES>` (in our case node1):
1339

    
1340
.. code-block:: console
1341

    
1342
   # gnt-os diagnose
1343

    
1344
This should return ``valid`` for snf-image.
1345

    
1346
If you are interested to learn more about snf-image's internals (and even use
1347
it alongside Ganeti without Synnefo), please see
1348
`here <https://code.grnet.gr/projects/snf-image/wiki>`_ for information
1349
concerning installation instructions, documentation on the design and
1350
implementation, and supported Image formats.
1351

    
1352
.. _snf-image-images:
1353

    
1354
Actual Images for snf-image
1355
---------------------------
1356

    
1357
Now that snf-image is installed successfully we need to provide it with some
1358
Images. :ref:`snf-image <snf-image>` supports Images stored in ``extdump``,
1359
``ntfsdump`` or ``diskdump`` format. We recommend the use of the ``diskdump``
1360
format. For more information about snf-image Image formats see `here
1361
<https://code.grnet.gr/projects/snf-image/wiki/Image_Format>`_.
1362

    
1363
:ref:`snf-image <snf-image>` also supports three (3) different locations for the
1364
above Images to be stored:
1365

    
1366
    * Under a local folder (usually an NFS mount, configurable as ``IMAGE_DIR``
1367
      in :file:`/etc/default/snf-image`)
1368
    * On a remote host (accessible via public URL e.g: http://... or ftp://...)
1369
    * On Pithos (accessible natively, not only by its public URL)
1370

    
1371
For the purpose of this guide, we will use the Debian Squeeze Base Image found
1372
on the official `snf-image page
1373
<https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_. The image is
1374
of type ``diskdump``. We will store it in our new Pithos installation.
1375

    
1376
To do so, do the following:
1377

    
1378
a) Download the Image from the official snf-image page.
1379

    
1380
b) Upload the Image to your Pithos installation, either using the Pithos Web
1381
   UI or the command line client `kamaki
1382
   <http://www.synnefo.org/docs/kamaki/latest/index.html>`_.
1383

    
1384
Once the Image is uploaded successfully, download the Image's metadata file
1385
from the official snf-image page. You will need it, for spawning a VM from
1386
Ganeti, in the next section.
1387

    
1388
Of course, you can repeat the procedure to upload more Images, available from
1389
the `official snf-image page
1390
<https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_.
1391

    
1392
.. _ganeti-with-pithos-images:
1393

    
1394
Spawning a VM from a Pithos Image, using Ganeti
1395
-----------------------------------------------
1396

    
1397
Now, it is time to test our installation so far. So, we have Astakos and
1398
Pithos installed, we have a working Ganeti installation, the snf-image
1399
definition installed on all VM-capable nodes and a Debian Squeeze Image on
1400
Pithos. Make sure you also have the `metadata file
1401
<https://pithos.okeanos.grnet.gr/public/gwqcv>`_ for this image.
1402

    
1403
Run on the :ref:`GANETI-MASTER's <GANETI_NODES>` (node1) command line:
1404

    
1405
.. code-block:: console
1406

    
1407
   # gnt-instance add -o snf-image+default --os-parameters \
1408
                      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"}' \
1409
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1410
                      testvm1
1411

    
1412
In the above command:
1413

    
1414
 * ``img_passwd``: the arbitrary root password of your new instance
1415
 * ``img_format``: set to ``diskdump`` to reflect the type of the uploaded Image
1416
 * ``img_id``: If you want to deploy an Image stored on Pithos (our case), this
1417
               should have the format ``pithos://<UUID>/<container>/<filename>``:
1418
               * ``UUID``: the username found in Cyclades Web UI under API access
1419
               * ``container``: ``pithos`` (default, if the Web UI was used)
1420
               * ``filename``: the name of file (visible also from the Web UI)
1421
 * ``img_properties``: taken from the metadata file. Used only the two mandatory
1422
                       properties ``OSFAMILY`` and ``ROOT_PARTITION``. `Learn more
1423
                       <https://code.grnet.gr/projects/snf-image/wiki/Image_Format#Image-Properties>`_
1424

    
1425
If the ``gnt-instance add`` command returns successfully, then run:
1426

    
1427
.. code-block:: console
1428

    
1429
   # gnt-instance info testvm1 | grep "console connection"
1430

    
1431
to find out where to connect using VNC. If you can connect successfully and can
1432
login to your new instance using the root password ``my_vm_example_passw0rd``,
1433
then everything works as expected and you have your new Debian Base VM up and
1434
running.
1435

    
1436
If ``gnt-instance add`` fails, make sure that snf-image is correctly configured
1437
to access the Pithos database and the Pithos backend data (newer versions
1438
require UUID instead of a username). Another issue you may encounter is that in
1439
relatively slow setups, you may need to raise the default HELPER_*_TIMEOUTS in
1440
/etc/default/snf-image. Also, make sure you gave the correct ``img_id`` and
1441
``img_properties``. If ``gnt-instance add`` succeeds but you cannot connect,
1442
again find out what went wrong. Do *NOT* proceed to the next steps unless you
1443
are sure everything works till this point.
1444

    
1445
If everything works, you have successfully connected Ganeti with Pithos. Let's
1446
move on to networking now.
1447

    
1448
.. warning::
1449

    
1450
    You can bypass the networking sections and go straight to
1451
    :ref:`Cyclades Ganeti tools <cyclades-gtools>`, if you do not want to setup
1452
    the Cyclades Network Service, but only the Cyclades Compute Service
1453
    (recommended for now).
1454

    
1455
Networking Setup Overview
1456
-------------------------
1457

    
1458
This part is deployment-specific and must be customized based on the specific
1459
needs of the system administrator. However, to do so, the administrator needs
1460
to understand how each level handles Virtual Networks, to be able to setup the
1461
backend appropriately, before installing Cyclades. To do so, please read the
1462
:ref:`Network <networks>` section before proceeding.
1463

    
1464
Since synnefo 0.11 all network actions are managed with the snf-manage
1465
network-* commands. This needs the underlying setup (Ganeti, nfdhcpd,
1466
snf-network, bridges, vlans) to be already configured correctly. The only
1467
actions needed in this point are:
1468

    
1469
a) Have Ganeti with IP pool management support installed.
1470

    
1471
b) Install :ref:`snf-network <snf-network>`, which provides a synnefo specific kvm-ifup script, etc.
1472

    
1473
c) Install :ref:`nfdhcpd <nfdhcpd>`, which serves DHCP requests of the VMs.
1474

    
1475
In order to test that everything is setup correctly before installing Cyclades,
1476
we will make some testing actions in this section, and the actual setup will be
1477
done afterwards with snf-manage commands.
1478

    
1479
.. _snf-network:
1480

    
1481
snf-network
1482
~~~~~~~~~~~
1483

    
1484
snf-network includes `kvm-vif-bridge` script that is invoked every time
1485
a tap (a VM's NIC) is created. Based on environment variables passed by
1486
Ganeti it issues various commands depending on the network type the NIC is
1487
connected to and sets up a corresponding dhcp lease.
1488

    
1489
Install snf-network on all Ganeti nodes:
1490

    
1491
.. code-block:: console
1492

    
1493
   # apt-get install snf-network
1494

    
1495
Then, in :file:`/etc/default/snf-network` set:
1496

    
1497
.. code-block:: console
1498

    
1499
   MAC_MASK=ff:ff:f0:00:00:00
1500

    
1501
.. _nfdhcpd:
1502

    
1503
nfdhcpd
1504
~~~~~~~
1505

    
1506
Each NIC's IP is chosen by Ganeti (with IP pool management support).
1507
`kvm-vif-bridge` script sets up dhcp leases and when the VM boots and
1508
makes a dhcp request, iptables will mangle the packet and `nfdhcpd` will
1509
create a dhcp response.
1510

    
1511
.. code-block:: console
1512

    
1513
   # apt-get install nfqueue-bindings-python=0.3+physindev-1
1514
   # apt-get install nfdhcpd
1515

    
1516
Edit ``/etc/nfdhcpd/nfdhcpd.conf`` to reflect your network configuration. At
1517
least, set the ``dhcp_queue`` variable to ``42`` and the ``nameservers``
1518
variable to your DNS IP/s. Those IPs will be passed as the DNS IP/s of your new
1519
VMs. Once you are finished, restart the server on all nodes:
1520

    
1521
.. code-block:: console
1522

    
1523
   # /etc/init.d/nfdhcpd restart
1524

    
1525
If you are using ``ferm``, then you need to run the following:
1526

    
1527
.. code-block:: console
1528

    
1529
   # echo "@include 'nfdhcpd.ferm';" >> /etc/ferm/ferm.conf
1530
   # /etc/init.d/ferm restart
1531

    
1532
or make sure to run after boot:
1533

    
1534
.. code-block:: console
1535

    
1536
   # iptables -t mangle -A PREROUTING -p udp -m udp --dport 67 -j NFQUEUE --queue-num 42
1537

    
1538
and if you have IPv6 enabled:
1539

    
1540
.. code-block:: console
1541

    
1542
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 133 -j NFQUEUE --queue-num 43
1543
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 135 -j NFQUEUE --queue-num 44
1544

    
1545
You can check which clients are currently served by nfdhcpd by running:
1546

    
1547
.. code-block:: console
1548

    
1549
   # kill -SIGUSR1 `cat /var/run/nfdhcpd/nfdhcpd.pid`
1550

    
1551
When you run the above, then check ``/var/log/nfdhcpd/nfdhcpd.log``.
1552

    
1553
Public Network Setup
1554
--------------------
1555

    
1556
To achieve basic networking the simplest way is to have a common bridge (e.g.
1557
``br0``, on the same collision domain with the router) where all VMs will
1558
connect to. Packets will be "forwarded" to the router and then to the Internet.
1559
If you want a more advanced setup (ip-less routing and proxy-arp plese refer to
1560
:ref:`Network <networks>` section).
1561

    
1562
Physical Host Setup
1563
~~~~~~~~~~~~~~~~~~~
1564

    
1565
Assuming ``eth0`` on both hosts is the public interface (directly connected
1566
to the router), run on every node:
1567

    
1568
.. code-block:: console
1569

    
1570
   # apt-get install vlan
1571
   # brctl addbr br0
1572
   # ip link set br0 up
1573
   # vconfig add eth0 100
1574
   # ip link set eth0.100 up
1575
   # brctl addif br0 eth0.100
1576

    
1577

    
1578
Testing a Public Network
1579
~~~~~~~~~~~~~~~~~~~~~~~~
1580

    
1581
Let's assume, that you want to assign IPs from the ``5.6.7.0/27`` range to you
1582
new VMs, with ``5.6.7.1`` as the router's gateway. In Ganeti you can add the
1583
network by running:
1584

    
1585
.. code-block:: console
1586

    
1587
   # gnt-network add --network=5.6.7.0/27 --gateway=5.6.7.1 --network-type=public --tags=nfdhcpd test-net-public
1588

    
1589
Then, connect the network to all your nodegroups. We assume that we only have
1590
one nodegroup (``default``) in our Ganeti cluster:
1591

    
1592
.. code-block:: console
1593

    
1594
   # gnt-network connect test-net-public default bridged br0
1595

    
1596
Now, it is time to test that the backend infrastracture is correctly setup for
1597
the Public Network. We will add a new VM, the same way we did it on the
1598
previous testing section. However, now will also add one NIC, configured to be
1599
managed from our previously defined network. Run on the GANETI-MASTER (node1):
1600

    
1601
.. code-block:: console
1602

    
1603
   # gnt-instance add -o snf-image+default --os-parameters \
1604
                      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"}' \
1605
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1606
                      --net 0:ip=pool,network=test-net-public \
1607
                      testvm2
1608

    
1609
If the above returns successfully, connect to the new VM through VNC as before and run:
1610

    
1611
.. code-block:: console
1612

    
1613
   root@testvm2:~ # ip addr
1614
   root@testvm2:~ # ip route
1615
   root@testvm2:~ # cat /etc/resolv.conf
1616

    
1617
to check IP address (5.6.7.2), IP routes (default via 5.6.7.1) and DNS config
1618
(nameserver option in nfdhcpd.conf). This shows correct configuration of
1619
ganeti, snf-network and nfdhcpd.
1620

    
1621
Now ping the outside world. If this works too, then you have also configured
1622
correctly your physical host and router.
1623

    
1624
Make sure everything works as expected, before proceeding with the Private
1625
Networks setup.
1626

    
1627
.. _private-networks-setup:
1628

    
1629
Private Networks Setup
1630
----------------------
1631

    
1632
Synnefo supports two types of private networks:
1633

    
1634
 - based on MAC filtering
1635
 - based on physical VLANs
1636

    
1637
Both types provide Layer 2 isolation to the end-user.
1638

    
1639
For the first type a common bridge (e.g. ``prv0``) is needed while for the
1640
second a range of bridges (e.g. ``prv1..prv100``) each bridged on a different
1641
physical VLAN. To this end to assure isolation among end-users' private networks
1642
each has to have different MAC prefix (for the filtering to take place) or to be
1643
"connected" to a different bridge (VLAN actually).
1644

    
1645
Physical Host Setup
1646
~~~~~~~~~~~~~~~~~~~
1647

    
1648
In order to create the necessary VLAN/bridges, one for MAC filtered private
1649
networks and various (e.g. 20) for private networks based on physical VLANs,
1650
run on every node:
1651

    
1652
Assuming ``eth0`` of both hosts are somehow (via cable/switch with VLANs
1653
configured correctly) connected together, run on every node:
1654

    
1655
.. code-block:: console
1656

    
1657
   # modprobe 8021q
1658
   # $iface=eth0
1659
   # for prv in $(seq 0 20); do
1660
        vlan=$prv
1661
        bridge=prv$prv
1662
        vconfig add $iface $vlan
1663
        ifconfig $iface.$vlan up
1664
        brctl addbr $bridge
1665
        brctl setfd $bridge 0
1666
        brctl addif $bridge $iface.$vlan
1667
        ifconfig $bridge up
1668
      done
1669

    
1670
The above will do the following :
1671

    
1672
 * provision 21 new bridges: ``prv0`` - ``prv20``
1673
 * provision 21 new vlans: ``eth0.0`` - ``eth0.20``
1674
 * add the corresponding vlan to the equivalent bridge
1675

    
1676
You can run ``brctl show`` on both nodes to see if everything was setup
1677
correctly.
1678

    
1679
Testing the Private Networks
1680
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1681

    
1682
To test the Private Networks, we will create two instances and put them in the
1683
same Private Networks (one MAC Filtered and one Physical VLAN). This means
1684
that the instances will have a second NIC connected to the ``prv0``
1685
pre-provisioned bridge and a third to ``prv1``.
1686

    
1687
We run the same command as in the Public Network testing section, but with one
1688
more argument for the second NIC:
1689

    
1690
.. code-block:: console
1691

    
1692
   # 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
1693
   # gnt-network connect test-net-prv-mac default bridged prv0
1694

    
1695
   # gnt-network add --network=10.0.0.0/24 --tags=nfdhcpd --network-type=private test-net-prv-vlan
1696
   # gnt-network connect test-net-prv-vlan default bridged prv1
1697

    
1698
   # gnt-instance add -o snf-image+default --os-parameters \
1699
                      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"}' \
1700
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1701
                      --net 0:ip=pool,network=test-net-public \
1702
                      --net 1:ip=pool,network=test-net-prv-mac \
1703
                      --net 2:ip=none,network=test-net-prv-vlan \
1704
                      testvm3
1705

    
1706
   # gnt-instance add -o snf-image+default --os-parameters \
1707
                      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"}' \
1708
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1709
                      --net 0:ip=pool,network=test-net-public \
1710
                      --net 1:ip=pool,network=test-net-prv-mac \
1711
                      --net 2:ip=none,network=test-net-prv-vlan \
1712
                      testvm4
1713

    
1714
Above, we create two instances with first NIC connected to the internet, their
1715
second NIC connected to a MAC filtered private Network and their third NIC
1716
connected to the first Physical VLAN Private Network. Now, connect to the
1717
instances using VNC and make sure everything works as expected:
1718

    
1719
 a) The instances have access to the public internet through their first eth
1720
    interface (``eth0``), which has been automatically assigned a public IP.
1721

    
1722
 b) ``eth1`` will have mac prefix ``aa:00:55``, while ``eth2`` default one (``aa:00:00``)
1723

    
1724
 c) ip link set ``eth1``/``eth2`` up
1725

    
1726
 d) dhclient ``eth1``/``eth2``
1727

    
1728
 e) On testvm3  ping 192.168.1.2/10.0.0.2
1729

    
1730
If everything works as expected, then you have finished the Network Setup at the
1731
backend for both types of Networks (Public & Private).
1732

    
1733
.. _cyclades-gtools:
1734

    
1735
Cyclades Ganeti tools
1736
---------------------
1737

    
1738
In order for Ganeti to be connected with Cyclades later on, we need the
1739
`Cyclades Ganeti tools` available on all Ganeti nodes (node1 & node2 in our
1740
case). You can install them by running in both nodes:
1741

    
1742
.. code-block:: console
1743

    
1744
   # apt-get install snf-cyclades-gtools
1745

    
1746
This will install the following:
1747

    
1748
 * ``snf-ganeti-eventd`` (daemon to publish Ganeti related messages on RabbitMQ)
1749
 * ``snf-ganeti-hook`` (all necessary hooks under ``/etc/ganeti/hooks``)
1750
 * ``snf-progress-monitor`` (used by ``snf-image`` to publish progress messages)
1751

    
1752
Configure ``snf-cyclades-gtools``
1753
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1754

    
1755
The package will install the ``/etc/synnefo/20-snf-cyclades-gtools-backend.conf``
1756
configuration file. At least we need to set the RabbitMQ endpoint for all tools
1757
that need it:
1758

    
1759
.. code-block:: console
1760

    
1761
  AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"]
1762

    
1763
The above variables should reflect your :ref:`Message Queue setup
1764
<rabbitmq-setup>`. This file should be editted in all Ganeti nodes.
1765

    
1766
Connect ``snf-image`` with ``snf-progress-monitor``
1767
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1768

    
1769
Finally, we need to configure ``snf-image`` to publish progress messages during
1770
the deployment of each Image. To do this, we edit ``/etc/default/snf-image`` and
1771
set the corresponding variable to ``snf-progress-monitor``:
1772

    
1773
.. code-block:: console
1774

    
1775
   PROGRESS_MONITOR="snf-progress-monitor"
1776

    
1777
This file should be editted in all Ganeti nodes.
1778

    
1779
.. _rapi-user:
1780

    
1781
Synnefo RAPI user
1782
-----------------
1783

    
1784
As a last step before installing Cyclades, create a new RAPI user that will
1785
have ``write`` access. Cyclades will use this user to issue commands to Ganeti,
1786
so we will call the user ``cyclades`` with password ``example_rapi_passw0rd``.
1787
You can do this, by first running:
1788

    
1789
.. code-block:: console
1790

    
1791
   # echo -n 'cyclades:Ganeti Remote API:example_rapi_passw0rd' | openssl md5
1792

    
1793
and then putting the output in ``/var/lib/ganeti/rapi/users`` as follows:
1794

    
1795
.. code-block:: console
1796

    
1797
   cyclades {HA1}55aec7050aa4e4b111ca43cb505a61a0 write
1798

    
1799
More about Ganeti's RAPI users `here.
1800
<http://docs.ganeti.org/ganeti/2.6/html/rapi.html#introduction>`_
1801

    
1802
You have now finished with all needed Prerequisites for Cyclades. Let's move on
1803
to the actual Cyclades installation.
1804

    
1805

    
1806
Installation of Cyclades on node1
1807
=================================
1808

    
1809
This section describes the installation of Cyclades. Cyclades is Synnefo's
1810
Compute service. The Image Service will get installed automatically along with
1811
Cyclades, because it is contained in the same Synnefo component.
1812

    
1813
We will install Cyclades on node1. To do so, we install the corresponding
1814
package by running on node1:
1815

    
1816
.. code-block:: console
1817

    
1818
   # apt-get install snf-cyclades-app memcached python-memcache
1819

    
1820
If all packages install successfully, then Cyclades are installed and we
1821
proceed with their configuration.
1822

    
1823
Since version 0.13, Synnefo uses the VMAPI in order to prevent sensitive data
1824
needed by 'snf-image' to be stored in Ganeti configuration (e.g. VM password).
1825
This is achieved by storing all sensitive information to a CACHE backend and
1826
exporting it via VMAPI. The cache entries are invalidated after the first
1827
request. Synnefo uses `memcached <http://memcached.org/>`_ as a
1828
`Django <https://www.djangoproject.com/>`_ cache backend.
1829

    
1830
Configuration of Cyclades
1831
=========================
1832

    
1833
Conf files
1834
----------
1835

    
1836
After installing Cyclades, a number of new configuration files will appear under
1837
``/etc/synnefo/`` prefixed with ``20-snf-cyclades-app-``. We will describe here
1838
only the minimal needed changes to result with a working system. In general,
1839
sane defaults have been chosen for the most of the options, to cover most of the
1840
common scenarios. However, if you want to tweak Cyclades feel free to do so,
1841
once you get familiar with the different options.
1842

    
1843
Edit ``/etc/synnefo/20-snf-cyclades-app-api.conf``:
1844

    
1845
.. code-block:: console
1846

    
1847
   CYCLADES_BASE_URL = 'https://node1.example.com/cyclades'
1848
   ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
1849

    
1850
   # Set to False if astakos & cyclades are on the same host
1851
   CYCLADES_PROXY_USER_SERVICES = False
1852

    
1853
   CYCLADES_SERVICE_TOKEN = 'cyclades_service_token22w'
1854

    
1855
The ``ASTAKOS_BASE_URL`` denotes the Astakos endpoint for Cyclades,
1856
which is used for all user management, including authentication.
1857
Since our Astakos, Cyclades, and Pithos installations belong together,
1858
they should all have identical ``ASTAKOS_BASE_URL`` setting
1859
(see also, :ref:`previously <conf-pithos>`).
1860

    
1861
The ``CYCLADES_BASE_URL`` setting must point to the top-level Cyclades URL.
1862
Appending an extra path (``/cyclades`` here) is recommended in order to
1863
distinguish components, if more than one are installed on the same machine.
1864

    
1865
The ``CYCLADES_SERVICE_TOKEN`` is the token used for authentication with astakos.
1866
It can be retrieved by running on the Astakos node (node1 in our case):
1867

    
1868
.. code-block:: console
1869

    
1870
   # snf-manage component-list
1871

    
1872
The token has been generated automatically during the :ref:`Cyclades service
1873
registration <services-reg>`.
1874

    
1875
Edit ``/etc/synnefo/20-snf-cyclades-app-cloudbar.conf``:
1876

    
1877
.. code-block:: console
1878

    
1879
   CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
1880
   CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
1881
   CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu'
1882

    
1883
``CLOUDBAR_LOCATION`` tells the client where to find the Astakos common
1884
cloudbar. The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are
1885
used by the Cyclades Web UI to get from Astakos all the information needed to
1886
fill its own cloudbar. So, we put our Astakos deployment urls there. All the
1887
above should have the same values we put in the corresponding variables in
1888
``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf`` on the previous
1889
:ref:`Pithos configuration <conf-pithos>` section.
1890

    
1891
Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``:
1892

    
1893
.. code-block:: console
1894

    
1895
   BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
1896
   BACKEND_BLOCK_PATH = '/srv/pithos/data/'
1897

    
1898
In this file we configure the Image Service. ``BACKEND_DB_CONNECTION``
1899
denotes the Pithos database (where the Image files are stored). So we set that
1900
to point to our Pithos database. ``BACKEND_BLOCK_PATH`` denotes the actual
1901
Pithos data location.
1902

    
1903
Edit ``/etc/synnefo/20-snf-cyclades-app-queues.conf``:
1904

    
1905
.. code-block:: console
1906

    
1907
   AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"]
1908

    
1909
The above settings denote the Message Queue. Those settings should have the same
1910
values as in ``/etc/synnefo/10-snf-cyclades-gtools-backend.conf`` file, and
1911
reflect our :ref:`Message Queue setup <rabbitmq-setup>`.
1912

    
1913
Edit ``/etc/synnefo/20-snf-cyclades-app-vmapi.conf``:
1914

    
1915
.. code-block:: console
1916

    
1917
   VMAPI_CACHE_BACKEND = "memcached://127.0.0.1:11211/?timeout=3600"
1918

    
1919
Edit ``/etc/default/vncauthproxy``:
1920

    
1921
.. code-block:: console
1922

    
1923
   CHUID="nobody:www-data"
1924

    
1925
We have now finished with the basic Cyclades configuration.
1926

    
1927
Database Initialization
1928
-----------------------
1929

    
1930
Once Cyclades is configured, we sync the database:
1931

    
1932
.. code-block:: console
1933

    
1934
   $ snf-manage syncdb
1935
   $ snf-manage migrate
1936

    
1937
and load the initial server flavors:
1938

    
1939
.. code-block:: console
1940

    
1941
   $ snf-manage loaddata flavors
1942

    
1943
If everything returns successfully, our database is ready.
1944

    
1945
Add the Ganeti backend
1946
----------------------
1947

    
1948
In our installation we assume that we only have one Ganeti cluster, the one we
1949
setup earlier.  At this point you have to add this backend (Ganeti cluster) to
1950
cyclades assuming that you have setup the :ref:`Rapi User <rapi-user>`
1951
correctly.
1952

    
1953
.. code-block:: console
1954

    
1955
   $ snf-manage backend-add --clustername=ganeti.node1.example.com --user=cyclades --pass=example_rapi_passw0rd
1956

    
1957
You can see everything has been setup correctly by running:
1958

    
1959
.. code-block:: console
1960

    
1961
   $ snf-manage backend-list
1962

    
1963
Enable the new backend by running:
1964

    
1965
.. code-block::
1966

    
1967
   $ snf-manage backend-modify --drained False 1
1968

    
1969
.. warning:: Since version 0.13, the backend is set to "drained" by default.
1970
    This means that you cannot add VMs to it. The reason for this is that the
1971
    nodes should be unavailable to Synnefo until the Administrator explicitly
1972
    releases them. To change this setting, use ``snf-manage backend-modify
1973
    --drained False <backend-id>``.
1974

    
1975
If something is not set correctly, you can modify the backend with the
1976
``snf-manage backend-modify`` command. If something has gone wrong, you could
1977
modify the backend to reflect the Ganeti installation by running:
1978

    
1979
.. code-block:: console
1980

    
1981
   $ snf-manage backend-modify --clustername "ganeti.node1.example.com"
1982
                               --user=cyclades
1983
                               --pass=example_rapi_passw0rd
1984
                               1
1985

    
1986
``clustername`` denotes the Ganeti-cluster's name. We provide the corresponding
1987
domain that resolves to the master IP, than the IP itself, to ensure Cyclades
1988
can talk to Ganeti even after a Ganeti master-failover.
1989

    
1990
``user`` and ``pass`` denote the RAPI user's username and the RAPI user's
1991
password.  Once we setup the first backend to point at our Ganeti cluster, we
1992
update the Cyclades backends status by running:
1993

    
1994
.. code-block:: console
1995

    
1996
   $ snf-manage backend-update-status
1997

    
1998
Cyclades can manage multiple Ganeti backends, but for the purpose of this
1999
guide,we won't get into more detail regarding mulitple backends. If you want to
2000
learn more please see /*TODO*/.
2001

    
2002
Add a Public Network
2003
----------------------
2004

    
2005
Cyclades supports different Public Networks on different Ganeti backends.
2006
After connecting Cyclades with our Ganeti cluster, we need to setup a Public
2007
Network for this Ganeti backend (`id = 1`). The basic setup is to bridge every
2008
created NIC on a bridge. After having a bridge (e.g. br0) created in every
2009
backend node edit Synnefo setting CUSTOM_BRIDGED_BRIDGE to 'br0':
2010

    
2011
.. code-block:: console
2012

    
2013
   $ snf-manage network-create --subnet=5.6.7.0/27 \
2014
                               --gateway=5.6.7.1 \
2015
                               --subnet6=2001:648:2FFC:1322::/64 \
2016
                               --gateway6=2001:648:2FFC:1322::1 \
2017
                               --public --dhcp --flavor=CUSTOM \
2018
                               --link=br0 --mode=bridged \
2019
                               --name=public_network \
2020
                               --backend-id=1
2021

    
2022
This will create the Public Network on both Cyclades and the Ganeti backend. To
2023
make sure everything was setup correctly, also run:
2024

    
2025
.. code-block:: console
2026

    
2027
   $ snf-manage reconcile-networks
2028

    
2029
You can see all available networks by running:
2030

    
2031
.. code-block:: console
2032

    
2033
   $ snf-manage network-list
2034

    
2035
and inspect each network's state by running:
2036

    
2037
.. code-block:: console
2038

    
2039
   $ snf-manage network-inspect <net_id>
2040

    
2041
Finally, you can see the networks from the Ganeti perspective by running on the
2042
Ganeti MASTER:
2043

    
2044
.. code-block:: console
2045

    
2046
   $ gnt-network list
2047
   $ gnt-network info <network_name>
2048

    
2049
Create pools for Private Networks
2050
---------------------------------
2051

    
2052
To prevent duplicate assignment of resources to different private networks,
2053
Cyclades supports two types of pools:
2054

    
2055
 - MAC prefix Pool
2056
 - Bridge Pool
2057

    
2058
As long as those resourses have been provisioned, admin has to define two
2059
these pools in Synnefo:
2060

    
2061

    
2062
.. code-block:: console
2063

    
2064
   root@testvm1:~ # snf-manage pool-create --type=mac-prefix --base=aa:00:0 --size=65536
2065

    
2066
   root@testvm1:~ # snf-manage pool-create --type=bridge --base=prv --size=20
2067

    
2068
Also, change the Synnefo setting in :file:`20-snf-cyclades-app-api.conf`:
2069

    
2070
.. code-block:: console
2071

    
2072
   DEFAULT_MAC_FILTERED_BRIDGE = 'prv0'
2073

    
2074
Servers restart
2075
---------------
2076

    
2077
Restart gunicorn on node1:
2078

    
2079
.. code-block:: console
2080

    
2081
   # /etc/init.d/gunicorn restart
2082

    
2083
Now let's do the final connections of Cyclades with Ganeti.
2084

    
2085
``snf-dispatcher`` initialization
2086
---------------------------------
2087

    
2088
``snf-dispatcher`` dispatches all messages published to the Message Queue and
2089
manages the Cyclades database accordingly. It also initializes all exchanges. By
2090
default it is not enabled during installation of Cyclades, so let's enable it in
2091
its configuration file ``/etc/default/snf-dispatcher``:
2092

    
2093
.. code-block:: console
2094

    
2095
   SNF_DSPTCH_ENABLE=true
2096

    
2097
and start the daemon:
2098

    
2099
.. code-block:: console
2100

    
2101
   # /etc/init.d/snf-dispatcher start
2102

    
2103
You can see that everything works correctly by tailing its log file
2104
``/var/log/synnefo/dispatcher.log``.
2105

    
2106
``snf-ganeti-eventd`` on GANETI MASTER
2107
--------------------------------------
2108

    
2109
The last step of the Cyclades setup is enabling the ``snf-ganeti-eventd``
2110
daemon (part of the :ref:`Cyclades Ganeti tools <cyclades-gtools>` package).
2111
The daemon is already installed on the GANETI MASTER (node1 in our case).
2112
``snf-ganeti-eventd`` is disabled by default during the ``snf-cyclades-gtools``
2113
installation, so we enable it in its configuration file
2114
``/etc/default/snf-ganeti-eventd``:
2115

    
2116
.. code-block:: console
2117

    
2118
   SNF_EVENTD_ENABLE=true
2119

    
2120
and start the daemon:
2121

    
2122
.. code-block:: console
2123

    
2124
   # /etc/init.d/snf-ganeti-eventd start
2125

    
2126
.. warning:: Make sure you start ``snf-ganeti-eventd`` *ONLY* on GANETI MASTER
2127

    
2128
Apply Quota
2129
-----------
2130

    
2131
The following commands will check and fix the integrity of user quota.
2132
In a freshly installed system, these commands have no effect and can be
2133
skipped.
2134

    
2135
.. code-block:: console
2136

    
2137
   node1 # snf-manage quota --sync
2138
   node1 # snf-manage reconcile-resources-astakos --fix
2139
   node2 # snf-manage reconcile-resources-pithos --fix
2140
   node1 # snf-manage reconcile-resources-cyclades --fix
2141

    
2142

    
2143
If all the above return successfully, then you have finished with the Cyclades
2144
installation and setup.
2145

    
2146
Let's test our installation now.
2147

    
2148

    
2149
Testing of Cyclades
2150
===================
2151

    
2152
Cyclades Web UI
2153
---------------
2154

    
2155
First of all we need to test that our Cyclades Web UI works correctly. Open your
2156
browser and go to the Astakos home page. Login and then click 'cyclades' on the
2157
top cloud bar. This should redirect you to:
2158

    
2159
 `http://node1.example.com/cyclades/ui/`
2160

    
2161
and the Cyclades home page should appear. If not, please go back and find what
2162
went wrong. Do not proceed if you don't see the Cyclades home page.
2163

    
2164
If the Cyclades home page appears, click on the orange button 'New machine'. The
2165
first step of the 'New machine wizard' will appear. This step shows all the
2166
available Images from which you can spawn new VMs. The list should be currently
2167
empty, as we haven't registered any Images yet. Close the wizard and browse the
2168
interface (not many things to see yet). If everything seems to work, let's
2169
register our first Image file.
2170

    
2171
Cyclades Images
2172
---------------
2173

    
2174
To test our Cyclades installation, we will use an Image stored on Pithos to
2175
spawn a new VM from the Cyclades interface. We will describe all steps, even
2176
though you may already have uploaded an Image on Pithos from a :ref:`previous
2177
<snf-image-images>` section:
2178

    
2179
 * Upload an Image file to Pithos
2180
 * Register that Image file to Cyclades
2181
 * Spawn a new VM from that Image from the Cyclades Web UI
2182

    
2183
We will use the `kamaki <http://www.synnefo.org/docs/kamaki/latest/index.html>`_
2184
command line client to do the uploading and registering of the Image.
2185

    
2186
Installation of `kamaki`
2187
~~~~~~~~~~~~~~~~~~~~~~~~
2188

    
2189
You can install `kamaki` anywhere you like, since it is a standalone client of
2190
the APIs and talks to the installation over `http`. For the purpose of this
2191
guide we will assume that we have downloaded the `Debian Squeeze Base Image
2192
<https://pithos.okeanos.grnet.gr/public/9epgb>`_ and stored it under node1's
2193
``/srv/images`` directory. For that reason we will install `kamaki` on node1,
2194
too. We do this by running:
2195

    
2196
.. code-block:: console
2197

    
2198
   # apt-get install kamaki
2199

    
2200
Configuration of kamaki
2201
~~~~~~~~~~~~~~~~~~~~~~~
2202

    
2203
Now we need to setup kamaki, by adding the appropriate URLs and tokens of our
2204
installation. We do this by running:
2205

    
2206
.. code-block:: console
2207

    
2208
   $ kamaki config set cloud.default.url \
2209
       "https://node1.example.com/astakos/identity/v2.0"
2210
   $ kamaki config set cloud.default.token USER_TOKEN
2211

    
2212
Both the Authentication URL and the USER_TOKEN appear on the user's
2213
`API access` web page on the Astakos Web UI.
2214

    
2215
You can see that the new configuration options have been applied correctly,
2216
either by checking the editable file ``~/.kamakirc`` or by running:
2217

    
2218
.. code-block:: console
2219

    
2220
   $ kamaki config list
2221

    
2222
A quick test to check that kamaki is configured correctly, is to try to
2223
authenticate a user based on his/her token (in this case the user is you):
2224

    
2225
.. code-block:: console
2226

    
2227
  $ kamaki user authenticate
2228

    
2229
The above operation provides various user information, e.g. UUID (the unique
2230
user id) which might prove useful in some operations.
2231

    
2232
Upload an Image file to Pithos
2233
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2234

    
2235
Now, that we have set up `kamaki` we will upload the Image that we have
2236
downloaded and stored under ``/srv/images/``. Although we can upload the Image
2237
under the root ``Pithos`` container (as you may have done when uploading the
2238
Image from the Pithos Web UI), we will create a new container called ``images``
2239
and store the Image under that container. We do this for two reasons:
2240

    
2241
a) To demonstrate how to create containers other than the default ``Pithos``.
2242
   This can be done only with the `kamaki` client and not through the Web UI.
2243

    
2244
b) As a best organization practise, so that you won't have your Image files
2245
   tangled along with all your other Pithos files and directory structures.
2246

    
2247
We create the new ``images`` container by running:
2248

    
2249
.. code-block:: console
2250

    
2251
   $ kamaki file create images
2252

    
2253
To check if the container has been created, list all containers of your
2254
account:
2255

    
2256
.. code-block:: console
2257

    
2258
  $ kamaki file list
2259

    
2260
Then, we upload the Image file to that container:
2261

    
2262
.. code-block:: console
2263

    
2264
   $ kamaki file upload /srv/images/debian_base-6.0-7-x86_64.diskdump images
2265

    
2266
The first is the local path and the second is the remote container on Pithos.
2267
Check if the file has been uploaded, by listing the container contents:
2268

    
2269
.. code-block:: console
2270

    
2271
  $ kamaki file list images
2272

    
2273
Alternatively check if the new container and file appear on the Pithos Web UI.
2274

    
2275
Register an existing Image file to Cyclades
2276
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2277

    
2278
For the purposes of the following example, we assume that the user UUID is
2279
``u53r-un1qu3-1d``.
2280

    
2281
Once the Image file has been successfully uploaded on Pithos then we register
2282
it to Cyclades, by running:
2283

    
2284
.. code-block:: console
2285

    
2286
   $ kamaki image register "Debian Base" \
2287
                           pithos://u53r-un1qu3-1d/images/debian_base-6.0-11-x86_64.diskdump \
2288
                           --public \
2289
                           --disk-format=diskdump \
2290
                           --property OSFAMILY=linux --property ROOT_PARTITION=1 \
2291
                           --property description="Debian Squeeze Base System" \
2292
                           --property size=451 --property kernel=2.6.32 --property GUI="No GUI" \
2293
                           --property sortorder=1 --property USERS=root --property OS=debian
2294

    
2295
This command registers the Pithos file
2296
``pithos://u53r-un1qu3-1d/images/debian_base-6.0-11-x86_64.diskdump`` as an
2297
Image in Cyclades. This Image will be public (``--public``), so all users will
2298
be able to spawn VMs from it and is of type ``diskdump``. The first two
2299
properties (``OSFAMILY`` and ``ROOT_PARTITION``) are mandatory. All the rest
2300
properties are optional, but recommended, so that the Images appear nicely on
2301
the Cyclades Web UI. ``Debian Base`` will appear as the name of this Image. The
2302
``OS`` property's valid values may be found in the ``IMAGE_ICONS`` variable
2303
inside the ``20-snf-cyclades-app-ui.conf`` configuration file.
2304

    
2305
``OSFAMILY`` and ``ROOT_PARTITION`` are mandatory because they will be passed
2306
from Cyclades to Ganeti and then `snf-image` (also see
2307
:ref:`previous section <ganeti-with-pithos-images>`). All other properties are
2308
used to show information on the Cyclades UI.
2309

    
2310
Spawn a VM from the Cyclades Web UI
2311
-----------------------------------
2312

    
2313
If the registration completes successfully, then go to the Cyclades Web UI from
2314
your browser at:
2315

    
2316
 `https://node1.example.com/cyclades/ui/`
2317

    
2318
Click on the 'New Machine' button and the first step of the wizard will appear.
2319
Click on 'My Images' (right after 'System' Images) on the left pane of the
2320
wizard. Your previously registered Image "Debian Base" should appear under
2321
'Available Images'. If not, something has gone wrong with the registration. Make
2322
sure you can see your Image file on the Pithos Web UI and ``kamaki image
2323
register`` returns successfully with all options and properties as shown above.
2324

    
2325
If the Image appears on the list, select it and complete the wizard by selecting
2326
a flavor and a name for your VM. Then finish by clicking 'Create'. Make sure you
2327
write down your password, because you *WON'T* be able to retrieve it later.
2328

    
2329
If everything was setup correctly, after a few minutes your new machine will go
2330
to state 'Running' and you will be able to use it. Click 'Console' to connect
2331
through VNC out of band, or click on the machine's icon to connect directly via
2332
SSH or RDP (for windows machines).
2333

    
2334
Congratulations. You have successfully installed the whole Synnefo stack and
2335
connected all components. Go ahead in the next section to test the Network
2336
functionality from inside Cyclades and discover even more features.
2337

    
2338
General Testing
2339
===============
2340

    
2341
Notes
2342
=====
2343