Statistics
| Branch: | Tag: | Revision:

root / docs / quick-install-admin-guide.rst @ e332c1fd

History | View | Annotate | Download (78.2 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 IPs are "4.3.2.1" and
41
"4.3.2.2" respectively.
42

    
43
.. note:: It is import that the two machines are under the same domain name.
44
    If they are not, you can do this by editting the file ``/etc/hosts``
45
    on both machines, and add the following lines:
46

    
47
    .. code-block:: console
48

    
49
        4.3.2.1     node1.example.com
50
        4.3.2.2     node2.example.com
51

    
52

    
53
General Prerequisites
54
=====================
55

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

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

    
62
| ``deb http://apt.dev.grnet.gr squeeze/``
63
| ``deb-src http://apt.dev.grnet.gr squeeze/``
64

    
65
and import the repo's GPG key:
66

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

    
69
Also add the following line to enable the ``squeeze-backports`` repository,
70
which may provide more recent versions of certain packages. The repository
71
is deactivated by default and must be specified expicitly in ``apt-get``
72
operations:
73

    
74
| ``deb http://backports.debian.org/debian-backports squeeze-backports main``
75

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

    
84
Before starting the synnefo installation, you will need basic third party
85
software to be installed and configured on the physical nodes. We will describe
86
each node's general prerequisites separately. Any additional configuration,
87
specific to a synnefo service for each node, will be described at the service's
88
section.
89

    
90
Finally, it is required for Cyclades and Ganeti nodes to have synchronized
91
system clocks (e.g. by running ntpd).
92

    
93
Node1
94
-----
95

    
96
General Synnefo dependencies
97
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98

    
99
    * apache (http server)
100
    * gunicorn (WSGI http server)
101
    * postgresql (database)
102
    * rabbitmq (message queue)
103
    * ntp (NTP daemon)
104
    * gevent
105

    
106
You can install apache2, progresql and ntp by running:
107

    
108
.. code-block:: console
109

    
110
   # apt-get install apache2 postgresql ntp
111

    
112
Make sure to install gunicorn >= v0.12.2. You can do this by installing from
113
the official debian backports:
114

    
115
.. code-block:: console
116

    
117
   # apt-get -t squeeze-backports install gunicorn
118

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

    
121
.. code-block:: console
122

    
123
   # apt-get -t squeeze-backports install python-gevent
124

    
125
On node1, we will create our databases, so you will also need the
126
python-psycopg2 package:
127

    
128
.. code-block:: console
129

    
130
   # apt-get install python-psycopg2
131

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

    
135
.. code-block:: console
136

    
137
    deb http://www.rabbitmq.com/debian testing main
138

    
139
Add RabbitMQ public key, to trusted key list:
140

    
141
.. code-block:: console
142

    
143
  # wget http://www.rabbitmq.com/rabbitmq-signing-key-public.asc
144
  # apt-key add rabbitmq-signing-key-public.asc
145

    
146
Finally, to install the package run:
147

    
148
.. code-block:: console
149

    
150
  # apt-get update
151
  # apt-get install rabbitmq-server
152

    
153
Database setup
154
~~~~~~~~~~~~~~
155

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

    
160
.. code-block:: console
161

    
162
    root@node1:~ # su - postgres
163
    postgres@node1:~ $ psql
164
    postgres=# CREATE DATABASE snf_apps WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0;
165
    postgres=# CREATE USER synnefo WITH PASSWORD 'example_passw0rd';
166
    postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_apps TO synnefo;
167

    
168
We also create the database ``snf_pithos`` needed by the Pithos backend and
169
grant the ``synnefo`` user all privileges on the database. This database could
170
be created on node2 instead, but we do it on node1 for simplicity. We will
171
create all needed databases on node1 and then node2 will connect to them.
172

    
173
.. code-block:: console
174

    
175
    postgres=# CREATE DATABASE snf_pithos WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0;
176
    postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_pithos TO synnefo;
177

    
178
Configure the database to listen to all network interfaces. You can do this by
179
editting the file ``/etc/postgresql/8.4/main/postgresql.conf`` and change
180
``listen_addresses`` to ``'*'`` :
181

    
182
.. code-block:: console
183

    
184
    listen_addresses = '*'
185

    
186
Furthermore, edit ``/etc/postgresql/8.4/main/pg_hba.conf`` to allow node1 and
187
node2 to connect to the database. Add the following lines under ``#IPv4 local
188
connections:`` :
189

    
190
.. code-block:: console
191

    
192
    host		all	all	4.3.2.1/32	md5
193
    host		all	all	4.3.2.2/32	md5
194

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

    
198
.. code-block:: console
199

    
200
   # /etc/init.d/postgresql restart
201

    
202
Gunicorn setup
203
~~~~~~~~~~~~~~
204

    
205
Create the file ``/etc/gunicorn.d/synnefo`` containing the following:
206

    
207
.. code-block:: console
208

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

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

    
231
       # /etc/init.d/gunicorn stop
232

    
233
Apache2 setup
234
~~~~~~~~~~~~~
235

    
236
Create the file ``/etc/apache2/sites-available/synnefo`` containing the
237
following:
238

    
239
.. code-block:: console
240

    
241
    <VirtualHost *:80>
242
        ServerName node1.example.com
243

    
244
        RewriteEngine On
245
        RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC]
246
        RewriteRule ^(.*)$ - [F,L]
247
        RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
248
    </VirtualHost>
249

    
250
Create the file ``/etc/apache2/sites-available/synnefo-ssl`` containing the
251
following:
252

    
253
.. code-block:: console
254

    
255
    <IfModule mod_ssl.c>
256
    <VirtualHost _default_:443>
257
        ServerName node1.example.com
258

    
259
        Alias /static "/usr/share/synnefo/static"
260

    
261
        #  SetEnv no-gzip
262
        #  SetEnv dont-vary
263

    
264
       AllowEncodedSlashes On
265

    
266
       RequestHeader set X-Forwarded-Protocol "https"
267

    
268
    <Proxy * >
269
        Order allow,deny
270
        Allow from all
271
    </Proxy>
272

    
273
        SetEnv                proxy-sendchunked
274
        SSLProxyEngine        off
275
        ProxyErrorOverride    off
276

    
277
        ProxyPass        /static !
278
        ProxyPass        / http://localhost:8080/ retry=0
279
        ProxyPassReverse / http://localhost:8080/
280

    
281
        RewriteEngine On
282
        RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC]
283
        RewriteRule ^(.*)$ - [F,L]
284

    
285
        SSLEngine on
286
        SSLCertificateFile    /etc/ssl/certs/ssl-cert-snakeoil.pem
287
        SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
288
    </VirtualHost>
289
    </IfModule>
290

    
291
Now enable sites and modules by running:
292

    
293
.. code-block:: console
294

    
295
   # a2enmod ssl
296
   # a2enmod rewrite
297
   # a2dissite default
298
   # a2ensite synnefo
299
   # a2ensite synnefo-ssl
300
   # a2enmod headers
301
   # a2enmod proxy_http
302

    
303
.. warning:: Do NOT start/restart the server yet. If the server is running::
304

    
305
       # /etc/init.d/apache2 stop
306

    
307
.. _rabbitmq-setup:
308

    
309
Message Queue setup
310
~~~~~~~~~~~~~~~~~~~
311

    
312
The message queue will run on node1, so we need to create the appropriate
313
rabbitmq user. The user is named ``synnefo`` and gets full privileges on all
314
exchanges:
315

    
316
.. code-block:: console
317

    
318
   # rabbitmqctl add_user synnefo "example_rabbitmq_passw0rd"
319
   # rabbitmqctl set_permissions synnefo ".*" ".*" ".*"
320

    
321
We do not need to initialize the exchanges. This will be done automatically,
322
during the Cyclades setup.
323

    
324
Pithos data directory setup
325
~~~~~~~~~~~~~~~~~~~~~~~~~~~
326

    
327
As mentioned in the General Prerequisites section, there is a directory called
328
``/srv/pithos`` visible by both nodes. We create and setup the ``data``
329
directory inside it:
330

    
331
.. code-block:: console
332

    
333
   # cd /srv/pithos
334
   # mkdir data
335
   # chown www-data:www-data data
336
   # chmod g+ws data
337

    
338
You are now ready with all general prerequisites concerning node1. Let's go to
339
node2.
340

    
341
Node2
342
-----
343

    
344
General Synnefo dependencies
345
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
346

    
347
    * apache (http server)
348
    * gunicorn (WSGI http server)
349
    * postgresql (database)
350
    * ntp (NTP daemon)
351
    * gevent
352

    
353
You can install the above by running:
354

    
355
.. code-block:: console
356

    
357
   # apt-get install apache2 postgresql ntp
358

    
359
Make sure to install gunicorn >= v0.12.2. You can do this by installing from
360
the official debian backports:
361

    
362
.. code-block:: console
363

    
364
   # apt-get -t squeeze-backports install gunicorn
365

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

    
368
.. code-block:: console
369

    
370
   # apt-get -t squeeze-backports install python-gevent
371

    
372
Node2 will connect to the databases on node1, so you will also need the
373
python-psycopg2 package:
374

    
375
.. code-block:: console
376

    
377
   # apt-get install python-psycopg2
378

    
379
Database setup
380
~~~~~~~~~~~~~~
381

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

    
388
Gunicorn setup
389
~~~~~~~~~~~~~~
390

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

    
394
.. code-block:: console
395

    
396
    CONFIG = {
397
     'mode': 'django',
398
     'environment': {
399
      'DJANGO_SETTINGS_MODULE': 'synnefo.settings',
400
     },
401
     'working_dir': '/etc/synnefo',
402
     'user': 'www-data',
403
     'group': 'www-data',
404
     'args': (
405
       '--bind=127.0.0.1:8080',
406
       '--worker-class=gevent',
407
       '--workers=4',
408
       '--log-level=debug',
409
       '--timeout=43200'
410
     ),
411
    }
412

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

    
419
       # /etc/init.d/gunicorn stop
420

    
421
Apache2 setup
422
~~~~~~~~~~~~~
423

    
424
Create the file ``/etc/apache2/sites-available/synnefo`` containing the
425
following:
426

    
427
.. code-block:: console
428

    
429
    <VirtualHost *:80>
430
        ServerName node2.example.com
431

    
432
        RewriteEngine On
433
        RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC]
434
        RewriteRule ^(.*)$ - [F,L]
435
        RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
436
    </VirtualHost>
437

    
438
Create the file ``synnefo-ssl`` under ``/etc/apache2/sites-available/``
439
containing the following:
440

    
441
.. code-block:: console
442

    
443
    <IfModule mod_ssl.c>
444
    <VirtualHost _default_:443>
445
        ServerName node2.example.com
446

    
447
        Alias /static "/usr/share/synnefo/static"
448

    
449
        SetEnv no-gzip
450
        SetEnv dont-vary
451
        AllowEncodedSlashes On
452

    
453
        RequestHeader set X-Forwarded-Protocol "https"
454

    
455
        <Proxy * >
456
            Order allow,deny
457
            Allow from all
458
        </Proxy>
459

    
460
        SetEnv                proxy-sendchunked
461
        SSLProxyEngine        off
462
        ProxyErrorOverride    off
463

    
464
        ProxyPass        /static !
465
        ProxyPass        / http://localhost:8080/ retry=0
466
        ProxyPassReverse / http://localhost:8080/
467

    
468
        SSLEngine on
469
        SSLCertificateFile    /etc/ssl/certs/ssl-cert-snakeoil.pem
470
        SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
471
    </VirtualHost>
472
    </IfModule>
473

    
474
As in node1, enable sites and modules by running:
475

    
476
.. code-block:: console
477

    
478
   # a2enmod ssl
479
   # a2enmod rewrite
480
   # a2dissite default
481
   # a2ensite synnefo
482
   # a2ensite synnefo-ssl
483
   # a2enmod headers
484
   # a2enmod proxy_http
485

    
486
.. warning:: Do NOT start/restart the server yet. If the server is running::
487

    
488
       # /etc/init.d/apache2 stop
489

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

    
494

    
495
Installation of Astakos on node1
496
================================
497

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

    
502
.. code-block:: console
503

    
504
   # apt-get install snf-astakos-app snf-pithos-backend
505

    
506
.. _conf-astakos:
507

    
508
Configuration of Astakos
509
========================
510

    
511
Conf Files
512
----------
513

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

    
521
After getting familiar with synnefo, you will be able to customize the software
522
as you wish and fits your needs. Many options are available, to empower the
523
administrator with extensively customizable setups.
524

    
525
For the snf-webproject component (installed as an astakos dependency), we
526
need the following:
527

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

    
531
.. code-block:: console
532

    
533
    DATABASES = {
534
     'default': {
535
         # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle'
536
         'ENGINE': 'postgresql_psycopg2',
537
         # ATTENTION: This *must* be the absolute path if using sqlite3.
538
         # See: http://docs.djangoproject.com/en/dev/ref/settings/#name
539
         'NAME': 'snf_apps',
540
         'USER': 'synnefo',                      # Not used with sqlite3.
541
         'PASSWORD': 'example_passw0rd',         # Not used with sqlite3.
542
         # Set to empty string for localhost. Not used with sqlite3.
543
         'HOST': '4.3.2.1',
544
         # Set to empty string for default. Not used with sqlite3.
545
         'PORT': '5432',
546
     }
547
    }
548

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

    
554
.. code-block:: console
555

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

    
558
For astakos specific configuration, edit the following options in
559
``/etc/synnefo/20-snf-astakos-app-settings.conf`` :
560

    
561
.. code-block:: console
562

    
563
    ASTAKOS_COOKIE_DOMAIN = '.example.com'
564

    
565
    ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
566

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

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

    
575
    .. code-block:: console
576

    
577
        ASTAKOS_RECAPTCHA_PUBLIC_KEY = 'example_recaptcha_public_key!@#$%^&*('
578
        ASTAKOS_RECAPTCHA_PRIVATE_KEY = 'example_recaptcha_private_key!@#$%^&*('
579
        ASTAKOS_RECAPTCHA_USE_SSL = True
580
        ASTAKOS_RECAPTCHA_ENABLED = True
581

    
582
    For the ``ASTAKOS_RECAPTCHA_PUBLIC_KEY`` and ``ASTAKOS_RECAPTCHA_PRIVATE_KEY``
583
    go to https://www.google.com/recaptcha/admin/create and create your own pair.
584

    
585
Then edit ``/etc/synnefo/20-snf-astakos-app-cloudbar.conf`` :
586

    
587
.. code-block:: console
588

    
589
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
590

    
591
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
592

    
593
    CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu'
594

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

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

    
602

    
603
Email delivery configuration
604
----------------------------
605

    
606
Many of the ``astakos`` operations require server to notify service users and 
607
administrators via email. e.g. right after the signup process the service sents 
608
an email to the registered email address containing an email verification url, 
609
after the user verifies the email address astakos once again needs to notify 
610
administrators with a notice that a new account has just been verified.
611

    
612
More specifically astakos sends emails in the following cases
613

    
614
- An email containing a verification link after each signup process.
615
- An email to the people listed in ``ADMINS`` setting after each email 
616
  verification if ``ASTAKOS_MODERATION`` setting is ``True``. The email 
617
  notifies administrators that an additional action is required in order to 
618
  activate the user.
619
- A welcome email to the user email and an admin notification to ``ADMINS`` 
620
  right after each account activation.
621
- Feedback messages submited from astakos contact view and astakos feedback 
622
  API endpoint are sent to contacts listed in ``HELPDESK`` setting.
623
- Project application request notifications to people included in ``HELPDESK`` 
624
  and ``MANAGERS`` settings.
625
- Notifications after each project members action (join request, membership 
626
  accepted/declinde etc.) to project members or project owners.
627

    
628
Astakos uses the Django internal email delivering mechanism to send email 
629
notifications. A simple configuration, using an external smtp server to 
630
deliver messages, is shown below. 
631

    
632
.. code-block:: python
633
    
634
    # /etc/synnefo/10-snf-common-admins.conf
635
    EMAIL_HOST = "mysmtp.server.synnefo.org"
636
    EMAIL_HOST_USER = "<smtpuser>"
637
    EMAIL_HOST_PASSWORD = "<smtppassword>"
638

    
639
    # this gets appended in all email subjects
640
    EMAIL_SUBJECT_PREFIX = "[example.synnefo.org] "
641
    
642
    # Address to use for outgoing emails
643
    DEFAULT_FROM_EMAIL = "server@example.synnefo.org"
644

    
645
    # Email where users can contact for support. This is used in html/email 
646
    # templates.
647
    CONTACT_EMAIL = "server@example.synnefo.org"
648

    
649
    # The email address that error messages come from
650
    SERVER_EMAIL = "server-errors@example.synnefo.org"
651

    
652
Notice that since email settings might be required by applications other than
653
astakos they are defined in a different configuration file than the one
654
previously used to set astakos specific settings. 
655

    
656
Refer to 
657
`Django documentation <https://docs.djangoproject.com/en/1.2/topics/email/>`_
658
for additional information on available email settings.
659

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

    
666
.. code-block:: python
667

    
668
    ADMINS = (('Admin name', 'admin@example.synnefo.org'), 
669
              ('Admin2 name', 'admin2@example.synnefo.org))
670
    MANAGERS = (('Manager name', 'manager@example.synnefo.org'),)
671
    HELPDESK = (('Helpdesk user name', 'helpdesk@example.synnefo.org'),)
672

    
673

    
674

    
675
Enable Pooling
676
--------------
677

    
678
This section can be bypassed, but we strongly recommend you apply the following,
679
since they result in a significant performance boost.
680

    
681
Synnefo includes a pooling DBAPI driver for PostgreSQL, as a thin wrapper
682
around Psycopg2. This allows independent Django requests to reuse pooled DB
683
connections, with significant performance gains.
684

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

    
688
.. code-block:: console
689

    
690
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
691
    monkey_patch_psycopg2()
692

    
693
Since we are running with greenlets, we should modify psycopg2 behavior, so it
694
works properly in a greenlet context:
695

    
696
.. code-block:: console
697

    
698
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
699
    make_psycopg_green()
700

    
701
Use the Psycopg2 driver as usual. For Django, this means using
702
``django.db.backends.postgresql_psycopg2`` without any modifications. To enable
703
connection pooling, pass a nonzero ``synnefo_poolsize`` option to the DBAPI
704
driver, through ``DATABASES.OPTIONS`` in Django.
705

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

    
709
.. code-block:: console
710

    
711
    # Monkey-patch psycopg2
712
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
713
    monkey_patch_psycopg2()
714

    
715
    # If running with greenlets
716
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
717
    make_psycopg_green()
718

    
719
    DATABASES = {
720
     'default': {
721
         # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle'
722
         'ENGINE': 'postgresql_psycopg2',
723
         'OPTIONS': {'synnefo_poolsize': 8},
724

    
725
         # ATTENTION: This *must* be the absolute path if using sqlite3.
726
         # See: http://docs.djangoproject.com/en/dev/ref/settings/#name
727
         'NAME': 'snf_apps',
728
         'USER': 'synnefo',                      # Not used with sqlite3.
729
         'PASSWORD': 'example_passw0rd',         # Not used with sqlite3.
730
         # Set to empty string for localhost. Not used with sqlite3.
731
         'HOST': '4.3.2.1',
732
         # Set to empty string for default. Not used with sqlite3.
733
         'PORT': '5432',
734
     }
735
    }
736

    
737
Database Initialization
738
-----------------------
739

    
740
After configuration is done, we initialize the database by running:
741

    
742
.. code-block:: console
743

    
744
    # snf-manage syncdb
745

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

    
750
.. code-block:: console
751

    
752
    # snf-manage migrate im
753
    # snf-manage migrate quotaholder_app
754

    
755
Then, we load the pre-defined user groups
756

    
757
.. code-block:: console
758

    
759
    # snf-manage loaddata groups
760

    
761
.. _services-reg:
762

    
763
Services Registration
764
---------------------
765

    
766
When the database is ready, we need to register the services. The following
767
command will ask you to register the standard Synnefo components (astakos,
768
cyclades, and pithos) along with the services they provide. Note that you
769
have to register at least astakos in order to have a usable authentication
770
system. For each component, you will be asked to provide two URLs: its base
771
URL and its UI URL.
772

    
773
The former is the location where the component resides; it should equal
774
the ``<component_name>_BASE_URL`` as specified in the respective component
775
settings. For example, the base URL for astakos would be
776
``https://node1.example.com/astakos``.
777

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

    
784
The command will also register automatically the resource definitions
785
offered by the services.
786

    
787
.. code-block:: console
788

    
789
    # snf-component-register
790

    
791
.. note::
792

    
793
   This command is equivalent to running the following series of commands;
794
   it registers the three components in astakos and then in each host it
795
   exports the respective service definitions, copies the exported json file
796
   to the astakos host, where it finally imports it:
797

    
798
    .. code-block:: console
799

    
800
       astakos-host$ snf-manage component-add astakos astakos_ui_url
801
       astakos-host$ snf-manage component-add cyclades cyclades_ui_url
802
       astakos-host$ snf-manage component-add pithos pithos_ui_url
803
       astakos-host$ snf-manage service-export-astakos > astakos.json
804
       astakos-host$ snf-manage service-import --json astakos.json
805
       cyclades-host$ snf-manage service-export-cyclades > cyclades.json
806
       # copy the file to astakos-host
807
       astakos-host$ snf-manage service-import --json cyclades.json
808
       pithos-host$ snf-manage service-export-pithos > pithos.json
809
       # copy the file to astakos-host
810
       astakos-host$ snf-manage service-import --json pithos.json
811

    
812
Setting Default Base Quota for Resources
813
----------------------------------------
814

    
815
We now have to specify the limit on resources that each user can employ
816
(exempting resources offered by projects).
817

    
818
.. code-block:: console
819

    
820
    # snf-manage resource-modify --limit-interactive
821

    
822

    
823
Servers Initialization
824
----------------------
825

    
826
Finally, we initialize the servers on node1:
827

    
828
.. code-block:: console
829

    
830
    root@node1:~ # /etc/init.d/gunicorn restart
831
    root@node1:~ # /etc/init.d/apache2 restart
832

    
833
We have now finished the Astakos setup. Let's test it now.
834

    
835

    
836
Testing of Astakos
837
==================
838

    
839
Open your favorite browser and go to:
840

    
841
``http://node1.example.com/astakos``
842

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

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

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

    
854
.. code-block:: console
855

    
856
    root@node1:~ # snf-manage user-list
857

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

    
862
.. code-block:: console
863

    
864
    root@node1:~ # snf-manage user-modify 1 --verify --accept
865

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

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

    
879
Let's continue to install Pithos now.
880

    
881

    
882
Installation of Pithos on node2
883
===============================
884

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

    
889
.. code-block:: console
890

    
891
   # apt-get install snf-pithos-app snf-pithos-backend
892

    
893
Now, install the pithos web interface:
894

    
895
.. code-block:: console
896

    
897
   # apt-get install snf-pithos-webclient
898

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

    
903

    
904
.. _conf-pithos:
905

    
906
Configuration of Pithos
907
=======================
908

    
909
Conf Files
910
----------
911

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

    
918
Edit ``/etc/synnefo/20-snf-pithos-app-settings.conf``. There you need to set
919
this options:
920

    
921
.. code-block:: console
922

    
923
   ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
924

    
925
   PITHOS_BASE_URL = 'https://node2.example.com/pithos'
926
   PITHOS_BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
927
   PITHOS_BACKEND_BLOCK_PATH = '/srv/pithos/data'
928

    
929
   PITHOS_SERVICE_TOKEN = 'pithos_service_token22w'
930

    
931
   # Set to False if astakos & pithos are on the same host
932
   PITHOS_PROXY_USER_SERVICES = True
933

    
934

    
935
The ``PITHOS_BACKEND_DB_CONNECTION`` option tells to the Pithos app where to
936
find the Pithos backend database. Above we tell Pithos that its database is
937
``snf_pithos`` at node1 and to connect as user ``synnefo`` with password
938
``example_passw0rd``.  All those settings where setup during node1's "Database
939
setup" section.
940

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

    
946
The ``ASTAKOS_BASE_URL`` option informs the Pithos app where Astakos is.
947
The Astakos service is used for user management (authentication, quotas, etc.)
948

    
949
The ``PITHOS_BASE_URL`` setting must point to the top-level Pithos URL.
950

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

    
954
.. code-block:: console
955

    
956
   # snf-manage component-list
957

    
958
The token has been generated automatically during the :ref:`Pithos service
959
registration <services-reg>`.
960

    
961
Then we need to setup the web UI and connect it to astakos. To do so, edit
962
``/etc/synnefo/20-snf-pithos-webclient-settings.conf``:
963

    
964
.. code-block:: console
965

    
966
    PITHOS_UI_LOGIN_URL = "https://node1.example.com/ui/login?next="
967
    PITHOS_UI_FEEDBACK_URL = "https://node2.example.com/feedback"
968

    
969
The ``PITHOS_UI_LOGIN_URL`` option tells the client where to redirect you, if
970
you are not logged in. The ``PITHOS_UI_FEEDBACK_URL`` option points at the
971
Pithos feedback form. Astakos already provides a generic feedback form for all
972
services, so we use this one.
973

    
974
The ``PITHOS_UPDATE_MD5`` option by default disables the computation of the
975
object checksums. This results to improved performance during object uploading.
976
However, if compatibility with the OpenStack Object Storage API is important
977
then it should be changed to ``True``.
978

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

    
982
.. code-block:: console
983

    
984
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
985
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
986
    CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu'
987

    
988
The ``CLOUDBAR_LOCATION`` tells the client where to find the astakos common
989
cloudbar.
990

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

    
995
Pooling and Greenlets
996
---------------------
997

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

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

    
1007
.. code-block:: console
1008

    
1009
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
1010
    make_psycopg_green()
1011

    
1012
Furthermore, add the ``--worker-class=gevent`` (or ``--worker-class=sync`` as
1013
mentioned above, depending on your setup) argument on your
1014
``/etc/gunicorn.d/synnefo`` configuration file. The file should look something
1015
like this:
1016

    
1017
.. code-block:: console
1018

    
1019
    CONFIG = {
1020
     'mode': 'django',
1021
     'environment': {
1022
       'DJANGO_SETTINGS_MODULE': 'synnefo.settings',
1023
     },
1024
     'working_dir': '/etc/synnefo',
1025
     'user': 'www-data',
1026
     'group': 'www-data',
1027
     'args': (
1028
       '--bind=127.0.0.1:8080',
1029
       '--workers=4',
1030
       '--worker-class=gevent',
1031
       '--log-level=debug',
1032
       '--timeout=43200'
1033
     ),
1034
    }
1035

    
1036
Stamp Database Revision
1037
-----------------------
1038

    
1039
Pithos uses the alembic_ database migrations tool.
1040

    
1041
.. _alembic: http://alembic.readthedocs.org
1042

    
1043
After a successful installation, we should stamp it at the most recent
1044
revision, so that future migrations know where to start upgrading in
1045
the migration history.
1046

    
1047
.. code-block:: console
1048

    
1049
    root@node2:~ # pithos-migrate stamp head
1050

    
1051
Servers Initialization
1052
----------------------
1053

    
1054
After configuration is done, we initialize the servers on node2:
1055

    
1056
.. code-block:: console
1057

    
1058
    root@node2:~ # /etc/init.d/gunicorn restart
1059
    root@node2:~ # /etc/init.d/apache2 restart
1060

    
1061
You have now finished the Pithos setup. Let's test it now.
1062

    
1063

    
1064
Testing of Pithos
1065
=================
1066

    
1067
Open your browser and go to the Astakos homepage:
1068

    
1069
``http://node1.example.com/astakos``
1070

    
1071
Login, and you will see your profile page. Now, click the "pithos" link on the
1072
top black cloudbar. If everything was setup correctly, this will redirect you
1073
to:
1074

    
1075

    
1076
and you will see the blue interface of the Pithos application.  Click the
1077
orange "Upload" button and upload your first file. If the file gets uploaded
1078
successfully, then this is your first sign of a successful Pithos installation.
1079
Go ahead and experiment with the interface to make sure everything works
1080
correctly.
1081

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

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

    
1087
If you would like to do more, such as:
1088

    
1089
    * Spawning VMs
1090
    * Spawning VMs from Images stored on Pithos
1091
    * Uploading your custom Images to Pithos
1092
    * Spawning VMs from those custom Images
1093
    * Registering existing Pithos files as Images
1094
    * Connect VMs to the Internet
1095
    * Create Private Networks
1096
    * Add VMs to Private Networks
1097

    
1098
please continue with the rest of the guide.
1099

    
1100

    
1101
Cyclades Prerequisites
1102
======================
1103

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

    
1109
Besides Astakos and Pithos, you will also need a number of additional working
1110
prerequisites, before you start the Cyclades installation.
1111

    
1112
Ganeti
1113
------
1114

    
1115
`Ganeti <http://code.google.com/p/ganeti/>`_ handles the low level VM management
1116
for Cyclades, so Cyclades requires a working Ganeti installation at the backend.
1117
Please refer to the
1118
`ganeti documentation <http://docs.ganeti.org/ganeti/2.6/html>`_ for all the
1119
gory details. A successful Ganeti installation concludes with a working
1120
:ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs
1121
<GANETI_NODES>`.
1122

    
1123
The above Ganeti cluster can run on different physical machines than node1 and
1124
node2 and can scale independently, according to your needs.
1125

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

    
1130
We highly recommend that you read the official Ganeti documentation, if you are
1131
not familiar with Ganeti.
1132

    
1133
Unfortunatelly, the current stable version of the stock Ganeti (v2.6.2) doesn't
1134
support IP pool management. This feature will be available in Ganeti >= 2.7.
1135
Synnefo depends on the IP pool functionality of Ganeti, so you have to use
1136
GRNET provided packages until stable 2.7 is out. To do so:
1137

    
1138
.. code-block:: console
1139

    
1140
   # apt-get install snf-ganeti ganeti-htools
1141
   # rmmod -f drbd && modprobe drbd minor_count=255 usermode_helper=/bin/true
1142

    
1143
You should have:
1144

    
1145
Ganeti >= 2.6.2+ippool11+hotplug5+extstorage3+rdbfix1+kvmfix2-1
1146

    
1147
We assume that Ganeti will use the KVM hypervisor. After installing Ganeti on
1148
both nodes, choose a domain name that resolves to a valid floating IP (let's
1149
say it's ``ganeti.node1.example.com``). Make sure node1 and node2 have same
1150
dsa/rsa keys and authorised_keys for password-less root ssh between each other.
1151
If not then skip passing --no-ssh-init but be aware that it will replace
1152
/root/.ssh/* related files and you might lose access to master node. Also,
1153
make sure there is an lvm volume group named ``ganeti`` that will host your
1154
VMs' disks. Finally, setup a bridge interface on the host machines (e.g: br0).
1155
Then run on node1:
1156

    
1157
.. code-block:: console
1158

    
1159
    root@node1:~ # gnt-cluster init --enabled-hypervisors=kvm --no-ssh-init \
1160
                    --no-etc-hosts --vg-name=ganeti --nic-parameters link=br0 \
1161
                    --master-netdev eth0 ganeti.node1.example.com
1162
    root@node1:~ # gnt-cluster modify --default-iallocator hail
1163
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:kernel_path=
1164
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:vnc_bind_address=0.0.0.0
1165

    
1166
    root@node1:~ # gnt-node add --no-ssh-key-check --master-capable=yes \
1167
                    --vm-capable=yes node2.example.com
1168
    root@node1:~ # gnt-cluster modify --disk-parameters=drbd:metavg=ganeti
1169
    root@node1:~ # gnt-group modify --disk-parameters=drbd:metavg=ganeti default
1170

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

    
1175
.. _cyclades-install-snfimage:
1176

    
1177
snf-image
1178
---------
1179

    
1180
Installation
1181
~~~~~~~~~~~~
1182
For :ref:`Cyclades <cyclades>` to be able to launch VMs from specified Images,
1183
you need the :ref:`snf-image <snf-image>` OS Definition installed on *all*
1184
VM-capable Ganeti nodes. This means we need :ref:`snf-image <snf-image>` on
1185
node1 and node2. You can do this by running on *both* nodes:
1186

    
1187
.. code-block:: console
1188

    
1189
   # apt-get install snf-image snf-pithos-backend python-psycopg2
1190

    
1191
snf-image also needs the `snf-pithos-backend <snf-pithos-backend>`, to be able
1192
to handle image files stored on Pithos. It also needs `python-psycopg2` to be
1193
able to access the Pithos database. This is why, we also install them on *all*
1194
VM-capable Ganeti nodes.
1195

    
1196
.. warning:: snf-image uses ``curl`` for handling URLs. This means that it will
1197
    not  work out of the box if you try to use URLs served by servers which do
1198
    not have a valid certificate. To circumvent this you should edit the file
1199
    ``/etc/default/snf-image``. Change ``#CURL="curl"`` to ``CURL="curl -k"``.
1200

    
1201
After `snf-image` has been installed successfully, create the helper VM by
1202
running on *both* nodes:
1203

    
1204
.. code-block:: console
1205

    
1206
   # snf-image-update-helper
1207

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

    
1212
Configuration
1213
~~~~~~~~~~~~~
1214
snf-image supports native access to Images stored on Pithos. This means that
1215
it can talk directly to the Pithos backend, without the need of providing a
1216
public URL. More details, are described in the next section. For now, the only
1217
thing we need to do, is configure snf-image to access our Pithos backend.
1218

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

    
1222
.. code-block:: console
1223

    
1224
    PITHOS_DB="postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos"
1225

    
1226
    PITHOS_DATA="/srv/pithos/data"
1227

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

    
1231
If you would like to use Images that are also/only stored locally, you need to
1232
save them under ``IMAGE_DIR``, however this guide targets Images stored only on
1233
Pithos.
1234

    
1235
Testing
1236
~~~~~~~
1237
You can test that snf-image is successfully installed by running on the
1238
:ref:`GANETI-MASTER <GANETI_NODES>` (in our case node1):
1239

    
1240
.. code-block:: console
1241

    
1242
   # gnt-os diagnose
1243

    
1244
This should return ``valid`` for snf-image.
1245

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

    
1252
.. _snf-image-images:
1253

    
1254
Actual Images for snf-image
1255
---------------------------
1256

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

    
1263
:ref:`snf-image <snf-image>` also supports three (3) different locations for the
1264
above Images to be stored:
1265

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

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

    
1276
To do so, do the following:
1277

    
1278
a) Download the Image from the official snf-image page.
1279

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

    
1284
Once the Image is uploaded successfully, download the Image's metadata file
1285
from the official snf-image page. You will need it, for spawning a VM from
1286
Ganeti, in the next section.
1287

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

    
1292
.. _ganeti-with-pithos-images:
1293

    
1294
Spawning a VM from a Pithos Image, using Ganeti
1295
-----------------------------------------------
1296

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

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

    
1305
.. code-block:: console
1306

    
1307
   # gnt-instance add -o snf-image+default --os-parameters \
1308
                      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"}' \
1309
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1310
                      testvm1
1311

    
1312
In the above command:
1313

    
1314
 * ``img_passwd``: the arbitrary root password of your new instance
1315
 * ``img_format``: set to ``diskdump`` to reflect the type of the uploaded Image
1316
 * ``img_id``: If you want to deploy an Image stored on Pithos (our case), this
1317
               should have the format ``pithos://<UUID>/<container>/<filename>``:
1318
               * ``username``: ``user@example.com`` (defined during Astakos sign up)
1319
               * ``container``: ``pithos`` (default, if the Web UI was used)
1320
               * ``filename``: the name of file (visible also from the Web UI)
1321
 * ``img_properties``: taken from the metadata file. Used only the two mandatory
1322
                       properties ``OSFAMILY`` and ``ROOT_PARTITION``. `Learn more
1323
                       <https://code.grnet.gr/projects/snf-image/wiki/Image_Format#Image-Properties>`_
1324

    
1325
If the ``gnt-instance add`` command returns successfully, then run:
1326

    
1327
.. code-block:: console
1328

    
1329
   # gnt-instance info testvm1 | grep "console connection"
1330

    
1331
to find out where to connect using VNC. If you can connect successfully and can
1332
login to your new instance using the root password ``my_vm_example_passw0rd``,
1333
then everything works as expected and you have your new Debian Base VM up and
1334
running.
1335

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

    
1345
If everything works, you have successfully connected Ganeti with Pithos. Let's
1346
move on to networking now.
1347

    
1348
.. warning::
1349

    
1350
    You can bypass the networking sections and go straight to
1351
    :ref:`Cyclades Ganeti tools <cyclades-gtools>`, if you do not want to setup
1352
    the Cyclades Network Service, but only the Cyclades Compute Service
1353
    (recommended for now).
1354

    
1355
Networking Setup Overview
1356
-------------------------
1357

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

    
1364
Since synnefo 0.11 all network actions are managed with the snf-manage
1365
network-* commands. This needs the underlying setup (Ganeti, nfdhcpd,
1366
snf-network, bridges, vlans) to be already configured correctly. The only
1367
actions needed in this point are:
1368

    
1369
a) Have Ganeti with IP pool management support installed.
1370

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

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

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

    
1379
.. _snf-network:
1380

    
1381
snf-network
1382
~~~~~~~~~~~
1383

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

    
1389
Install snf-network on all Ganeti nodes:
1390

    
1391
.. code-block:: console
1392

    
1393
   # apt-get install snf-network
1394

    
1395
Then, in :file:`/etc/default/snf-network` set:
1396

    
1397
.. code-block:: console
1398

    
1399
   MAC_MASK=ff:ff:f0:00:00:00
1400

    
1401
.. _nfdhcpd:
1402

    
1403
nfdhcpd
1404
~~~~~~~
1405

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

    
1411
.. code-block:: console
1412

    
1413
   # apt-get install nfqueue-bindings-python=0.3+physindev-1
1414
   # apt-get install nfdhcpd
1415

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

    
1421
.. code-block:: console
1422

    
1423
   # /etc/init.d/nfdhcpd restart
1424

    
1425
If you are using ``ferm``, then you need to run the following:
1426

    
1427
.. code-block:: console
1428

    
1429
   # echo "@include 'nfdhcpd.ferm';" >> /etc/ferm/ferm.conf
1430
   # /etc/init.d/ferm restart
1431

    
1432
or make sure to run after boot:
1433

    
1434
.. code-block:: console
1435

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

    
1438
and if you have IPv6 enabled:
1439

    
1440
.. code-block:: console
1441

    
1442
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 133 -j NFQUEUE --queue-num 43
1443
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 135 -j NFQUEUE --queue-num 44
1444

    
1445
You can check which clients are currently served by nfdhcpd by running:
1446

    
1447
.. code-block:: console
1448

    
1449
   # kill -SIGUSR1 `cat /var/run/nfdhcpd/nfdhcpd.pid`
1450

    
1451
When you run the above, then check ``/var/log/nfdhcpd/nfdhcpd.log``.
1452

    
1453
Public Network Setup
1454
--------------------
1455

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

    
1462
Physical Host Setup
1463
~~~~~~~~~~~~~~~~~~~
1464

    
1465
Assuming ``eth0`` on both hosts is the public interface (directly connected
1466
to the router), run on every node:
1467

    
1468
.. code-block:: console
1469

    
1470
   # apt-get install vlan
1471
   # brctl addbr br0
1472
   # ip link set br0 up
1473
   # vconfig add eth0 100
1474
   # ip link set eth0.100 up
1475
   # brctl addif br0 eth0.100
1476

    
1477

    
1478
Testing a Public Network
1479
~~~~~~~~~~~~~~~~~~~~~~~~
1480

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

    
1485
.. code-block:: console
1486

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

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

    
1492
.. code-block:: console
1493

    
1494
   # gnt-network connect test-net-public default bridged br0
1495

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

    
1501
.. code-block:: console
1502

    
1503
   # gnt-instance add -o snf-image+default --os-parameters \
1504
                      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"}' \
1505
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1506
                      --net 0:ip=pool,network=test-net-public \
1507
                      testvm2
1508

    
1509
If the above returns successfully, connect to the new VM and run:
1510

    
1511
.. code-block:: console
1512

    
1513
   root@testvm2:~ # ip addr
1514
   root@testvm2:~ # ip route
1515
   root@testvm2:~ # cat /etc/resolv.conf
1516

    
1517
to check IP address (5.6.7.2), IP routes (default via 5.6.7.1) and DNS config
1518
(nameserver option in nfdhcpd.conf). This shows correct configuration of
1519
ganeti, snf-network and nfdhcpd.
1520

    
1521
Now ping the outside world. If this works too, then you have also configured
1522
correctly your physical host and router.
1523

    
1524
Make sure everything works as expected, before proceeding with the Private
1525
Networks setup.
1526

    
1527
.. _private-networks-setup:
1528

    
1529
Private Networks Setup
1530
----------------------
1531

    
1532
Synnefo supports two types of private networks:
1533

    
1534
 - based on MAC filtering
1535
 - based on physical VLANs
1536

    
1537
Both types provide Layer 2 isolation to the end-user.
1538

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

    
1545
Physical Host Setup
1546
~~~~~~~~~~~~~~~~~~~
1547

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

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

    
1555
.. code-block:: console
1556

    
1557
   # modprobe 8021q
1558
   # $iface=eth0
1559
   # for prv in $(seq 0 20); do
1560
        vlan=$prv
1561
        bridge=prv$prv
1562
        vconfig add $iface $vlan
1563
        ifconfig $iface.$vlan up
1564
        brctl addbr $bridge
1565
        brctl setfd $bridge 0
1566
        brctl addif $bridge $iface.$vlan
1567
        ifconfig $bridge up
1568
      done
1569

    
1570
The above will do the following :
1571

    
1572
 * provision 21 new bridges: ``prv0`` - ``prv20``
1573
 * provision 21 new vlans: ``eth0.0`` - ``eth0.20``
1574
 * add the corresponding vlan to the equivalent bridge
1575

    
1576
You can run ``brctl show`` on both nodes to see if everything was setup
1577
correctly.
1578

    
1579
Testing the Private Networks
1580
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1581

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

    
1587
We run the same command as in the Public Network testing section, but with one
1588
more argument for the second NIC:
1589

    
1590
.. code-block:: console
1591

    
1592
   # 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
1593
   # gnt-network connect test-net-prv-mac default bridged prv0
1594

    
1595
   # gnt-network add --network=10.0.0.0/24 --tags=nfdhcpd --network-type=private test-net-prv-vlan
1596
   # gnt-network connect test-net-prv-vlan default bridged prv1
1597

    
1598
   # gnt-instance add -o snf-image+default --os-parameters \
1599
                      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"}' \
1600
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1601
                      --net 0:ip=pool,network=test-net-public \
1602
                      --net 1:ip=pool,network=test-net-prv-mac \
1603
                      --net 2:ip=none,network=test-net-prv-vlan \
1604
                      testvm3
1605

    
1606
   # gnt-instance add -o snf-image+default --os-parameters \
1607
                      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"}' \
1608
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1609
                      --net 0:ip=pool,network=test-net-public \
1610
                      --net 1:ip=pool,network=test-net-prv-mac \
1611
                      --net 2:ip=none,network=test-net-prv-vlan \
1612
                      testvm4
1613

    
1614
Above, we create two instances with first NIC connected to the internet, their
1615
second NIC connected to a MAC filtered private Network and their third NIC
1616
connected to the first Physical VLAN Private Network. Now, connect to the
1617
instances using VNC and make sure everything works as expected:
1618

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

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

    
1624
 c) ip link set ``eth1``/``eth2`` up
1625

    
1626
 d) dhclient ``eth1``/``eth2``
1627

    
1628
 e) On testvm3  ping 192.168.1.2/10.0.0.2
1629

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

    
1633
.. _cyclades-gtools:
1634

    
1635
Cyclades Ganeti tools
1636
---------------------
1637

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

    
1642
.. code-block:: console
1643

    
1644
   # apt-get install snf-cyclades-gtools
1645

    
1646
This will install the following:
1647

    
1648
 * ``snf-ganeti-eventd`` (daemon to publish Ganeti related messages on RabbitMQ)
1649
 * ``snf-ganeti-hook`` (all necessary hooks under ``/etc/ganeti/hooks``)
1650
 * ``snf-progress-monitor`` (used by ``snf-image`` to publish progress messages)
1651

    
1652
Configure ``snf-cyclades-gtools``
1653
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1654

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

    
1659
.. code-block:: console
1660

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

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

    
1666
Connect ``snf-image`` with ``snf-progress-monitor``
1667
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1668

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

    
1673
.. code-block:: console
1674

    
1675
   PROGRESS_MONITOR="snf-progress-monitor"
1676

    
1677
This file should be editted in all Ganeti nodes.
1678

    
1679
.. _rapi-user:
1680

    
1681
Synnefo RAPI user
1682
-----------------
1683

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

    
1689
.. code-block:: console
1690

    
1691
   # echo -n 'cyclades:Ganeti Remote API:example_rapi_passw0rd' | openssl md5
1692

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

    
1695
.. code-block:: console
1696

    
1697
   cyclades {HA1}55aec7050aa4e4b111ca43cb505a61a0 write
1698

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

    
1702
You have now finished with all needed Prerequisites for Cyclades. Let's move on
1703
to the actual Cyclades installation.
1704

    
1705

    
1706
Installation of Cyclades on node1
1707
=================================
1708

    
1709
This section describes the installation of Cyclades. Cyclades is Synnefo's
1710
Compute service. The Image Service will get installed automatically along with
1711
Cyclades, because it is contained in the same Synnefo component.
1712

    
1713
We will install Cyclades on node1. To do so, we install the corresponding
1714
package by running on node1:
1715

    
1716
.. code-block:: console
1717

    
1718
   # apt-get install snf-cyclades-app memcached python-memcache
1719

    
1720
If all packages install successfully, then Cyclades are installed and we
1721
proceed with their configuration.
1722

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

    
1730
Configuration of Cyclades
1731
=========================
1732

    
1733
Conf files
1734
----------
1735

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

    
1743
Edit ``/etc/synnefo/20-snf-cyclades-app-api.conf``:
1744

    
1745
.. code-block:: console
1746

    
1747
   CYCLADES_BASE_URL = 'https://node1.example.com/cyclades'
1748
   ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
1749

    
1750
   # Set to False if astakos & cyclades are on the same host
1751
   CYCLADES_PROXY_USER_SERVICES = False
1752

    
1753
   CYCLADES_SERVICE_TOKEN = 'cyclades_service_token22w'
1754

    
1755
The ``ASTAKOS_BASE_URL`` denotes the Astakos endpoint for Cyclades,
1756
which is used for all user management, including authentication.
1757
Since our Astakos, Cyclades, and Pithos installations belong together,
1758
they should all have identical ``ASTAKOS_BASE_URL`` setting
1759
(see also, :ref:`previously <conf-pithos>`).
1760

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

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

    
1768
.. code-block:: console
1769

    
1770
   # snf-manage component-list
1771

    
1772
The token has been generated automatically during the :ref:`Cyclades service
1773
registration <services-reg>`.
1774

    
1775
TODO: Document the Network Options here
1776

    
1777
Edit ``/etc/synnefo/20-snf-cyclades-app-cloudbar.conf``:
1778

    
1779
.. code-block:: console
1780

    
1781
   CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
1782
   CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
1783
   CLOUDBAR_MENU_URL = 'https://account.node1.example.com/astakos/ui/get_menu'
1784

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

    
1793
Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``:
1794

    
1795
.. code-block:: console
1796

    
1797
   BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
1798
   BACKEND_BLOCK_PATH = '/srv/pithos/data/'
1799

    
1800
In this file we configure the Image Service. ``BACKEND_DB_CONNECTION``
1801
denotes the Pithos database (where the Image files are stored). So we set that
1802
to point to our Pithos database. ``BACKEND_BLOCK_PATH`` denotes the actual
1803
Pithos data location.
1804

    
1805
Edit ``/etc/synnefo/20-snf-cyclades-app-queues.conf``:
1806

    
1807
.. code-block:: console
1808

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

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

    
1815
Edit ``/etc/synnefo/20-snf-cyclades-app-ui.conf``:
1816

    
1817
.. code-block:: console
1818

    
1819
   UI_LOGIN_URL = "https://node1.example.com/ui/login"
1820
   UI_LOGOUT_URL = "https://node1.example.com/ui/logout"
1821

    
1822
The ``UI_LOGIN_URL`` option tells the Cyclades Web UI where to redirect users,
1823
if they are not logged in. We point that to Astakos.
1824

    
1825
The ``UI_LOGOUT_URL`` option tells the Cyclades Web UI where to redirect the
1826
user when he/she logs out. We point that to Astakos, too.
1827

    
1828
Edit ``/etc/synnefo/20-snf-cyclades-app-vmapi.conf``:
1829

    
1830
.. code-block:: console
1831

    
1832
   VMAPI_CACHE_BACKEND = "memcached://127.0.0.1:11211/?timeout=3600"
1833

    
1834
Edit ``/etc/default/vncauthproxy``:
1835

    
1836
.. code-block:: console
1837

    
1838
   CHUID="nobody:www-data"
1839

    
1840
We have now finished with the basic Cyclades configuration.
1841

    
1842
Database Initialization
1843
-----------------------
1844

    
1845
Once Cyclades is configured, we sync the database:
1846

    
1847
.. code-block:: console
1848

    
1849
   $ snf-manage syncdb
1850
   $ snf-manage migrate
1851

    
1852
and load the initial server flavors:
1853

    
1854
.. code-block:: console
1855

    
1856
   $ snf-manage loaddata flavors
1857

    
1858
If everything returns successfully, our database is ready.
1859

    
1860
Add the Ganeti backend
1861
----------------------
1862

    
1863
In our installation we assume that we only have one Ganeti cluster, the one we
1864
setup earlier.  At this point you have to add this backend (Ganeti cluster) to
1865
cyclades assuming that you have setup the :ref:`Rapi User <rapi-user>`
1866
correctly.
1867

    
1868
.. code-block:: console
1869

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

    
1872
You can see everything has been setup correctly by running:
1873

    
1874
.. code-block:: console
1875

    
1876
   $ snf-manage backend-list
1877

    
1878
Enable the new backend by running:
1879

    
1880
.. code-block::
1881

    
1882
   $ snf-manage backend-modify --drained False 1
1883

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

    
1890
If something is not set correctly, you can modify the backend with the
1891
``snf-manage backend-modify`` command. If something has gone wrong, you could
1892
modify the backend to reflect the Ganeti installation by running:
1893

    
1894
.. code-block:: console
1895

    
1896
   $ snf-manage backend-modify --clustername "ganeti.node1.example.com"
1897
                               --user=cyclades
1898
                               --pass=example_rapi_passw0rd
1899
                               1
1900

    
1901
``clustername`` denotes the Ganeti-cluster's name. We provide the corresponding
1902
domain that resolves to the master IP, than the IP itself, to ensure Cyclades
1903
can talk to Ganeti even after a Ganeti master-failover.
1904

    
1905
``user`` and ``pass`` denote the RAPI user's username and the RAPI user's
1906
password.  Once we setup the first backend to point at our Ganeti cluster, we
1907
update the Cyclades backends status by running:
1908

    
1909
.. code-block:: console
1910

    
1911
   $ snf-manage backend-update-status
1912

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

    
1917
Add a Public Network
1918
----------------------
1919

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

    
1926
.. code-block:: console
1927

    
1928
   $ snf-manage network-create --subnet=5.6.7.0/27 \
1929
                               --gateway=5.6.7.1 \
1930
                               --subnet6=2001:648:2FFC:1322::/64 \
1931
                               --gateway6=2001:648:2FFC:1322::1 \
1932
                               --public --dhcp --flavor=CUSTOM \
1933
                               --link=br0 --mode=bridged \
1934
                               --name=public_network \
1935
                               --backend-id=1
1936

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

    
1940
.. code-block:: console
1941

    
1942
   $ snf-manage reconcile-networks
1943

    
1944
You can see all available networks by running:
1945

    
1946
.. code-block:: console
1947

    
1948
   $ snf-manage network-list
1949

    
1950
and inspect each network's state by running:
1951

    
1952
.. code-block:: console
1953

    
1954
   $ snf-manage network-inspect <net_id>
1955

    
1956
Finally, you can see the networks from the Ganeti perspective by running on the
1957
Ganeti MASTER:
1958

    
1959
.. code-block:: console
1960

    
1961
   $ gnt-network list
1962
   $ gnt-network info <network_name>
1963

    
1964
Create pools for Private Networks
1965
---------------------------------
1966

    
1967
To prevent duplicate assignment of resources to different private networks,
1968
Cyclades supports two types of pools:
1969

    
1970
 - MAC prefix Pool
1971
 - Bridge Pool
1972

    
1973
As long as those resourses have been provisioned, admin has to define two
1974
these pools in Synnefo:
1975

    
1976

    
1977
.. code-block:: console
1978

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

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

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

    
1985
.. code-block:: console
1986

    
1987
   DEFAULT_MAC_FILTERED_BRIDGE = 'prv0'
1988

    
1989
Servers restart
1990
---------------
1991

    
1992
Restart gunicorn on node1:
1993

    
1994
.. code-block:: console
1995

    
1996
   # /etc/init.d/gunicorn restart
1997

    
1998
Now let's do the final connections of Cyclades with Ganeti.
1999

    
2000
``snf-dispatcher`` initialization
2001
---------------------------------
2002

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

    
2008
.. code-block:: console
2009

    
2010
   SNF_DSPTCH_ENABLE=true
2011

    
2012
and start the daemon:
2013

    
2014
.. code-block:: console
2015

    
2016
   # /etc/init.d/snf-dispatcher start
2017

    
2018
You can see that everything works correctly by tailing its log file
2019
``/var/log/synnefo/dispatcher.log``.
2020

    
2021
``snf-ganeti-eventd`` on GANETI MASTER
2022
--------------------------------------
2023

    
2024
The last step of the Cyclades setup is enabling the ``snf-ganeti-eventd``
2025
daemon (part of the :ref:`Cyclades Ganeti tools <cyclades-gtools>` package).
2026
The daemon is already installed on the GANETI MASTER (node1 in our case).
2027
``snf-ganeti-eventd`` is disabled by default during the ``snf-cyclades-gtools``
2028
installation, so we enable it in its configuration file
2029
``/etc/default/snf-ganeti-eventd``:
2030

    
2031
.. code-block:: console
2032

    
2033
   SNF_EVENTD_ENABLE=true
2034

    
2035
and start the daemon:
2036

    
2037
.. code-block:: console
2038

    
2039
   # /etc/init.d/snf-ganeti-eventd start
2040

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

    
2043
Apply Quota
2044
-----------
2045

    
2046
The following commands will check and fix the integrity of user quota.
2047
In a freshly installed system, these commands have no effect and can be
2048
skipped.
2049

    
2050
.. code-block:: console
2051

    
2052
   node1 # snf-manage quota --sync
2053
   node1 # snf-manage reconcile-resources-astakos --fix
2054
   node2 # snf-manage reconcile-resources-pithos --fix
2055
   node1 # snf-manage reconcile-resources-cyclades --fix
2056

    
2057
If all the above return successfully, then you have finished with the Cyclades
2058
installation and setup.
2059

    
2060
Let's test our installation now.
2061

    
2062

    
2063
Testing of Cyclades
2064
===================
2065

    
2066
Cyclades Web UI
2067
---------------
2068

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

    
2073
 `http://node1.example.com/cyclades/ui/`
2074

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

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

    
2085
Cyclades Images
2086
---------------
2087

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

    
2093
 * Upload an Image file to Pithos
2094
 * Register that Image file to Cyclades
2095
 * Spawn a new VM from that Image from the Cyclades Web UI
2096

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

    
2100
Installation of `kamaki`
2101
~~~~~~~~~~~~~~~~~~~~~~~~
2102

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

    
2110
.. code-block:: console
2111

    
2112
   # apt-get install kamaki
2113

    
2114
Configuration of kamaki
2115
~~~~~~~~~~~~~~~~~~~~~~~
2116

    
2117
Now we need to setup kamaki, by adding the appropriate URLs and tokens of our
2118
installation. We do this by running:
2119

    
2120
.. code-block:: console
2121

    
2122
   $ kamaki config set user.url "https://node1.example.com"
2123
   $ kamaki config set compute.url "https://node1.example.com/api/v1.1"
2124
   $ kamaki config set image.url "https://node1.example.com/image"
2125
   $ kamaki config set file.url "https://node2.example.com/v1"
2126
   $ kamaki config set token USER_TOKEN
2127

    
2128
The USER_TOKEN appears on the user's `Profile` web page on the Astakos Web UI.
2129

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

    
2133
.. code-block:: console
2134

    
2135
   $ kamaki config list
2136

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

    
2140
.. code-block:: console
2141

    
2142
  $ kamaki user authenticate
2143

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

    
2147
Upload an Image file to Pithos
2148
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2149

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

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

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

    
2162
We create the new ``images`` container by running:
2163

    
2164
.. code-block:: console
2165

    
2166
   $ kamaki file create images
2167

    
2168
To check if the container has been created, list all containers of your
2169
account:
2170

    
2171
.. code-block:: console
2172

    
2173
  $ kamaki file list
2174

    
2175
Then, we upload the Image file to that container:
2176

    
2177
.. code-block:: console
2178

    
2179
   $ kamaki file upload /srv/images/debian_base-6.0-7-x86_64.diskdump images
2180

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

    
2184
.. code-block:: console
2185

    
2186
  $ kamaki file list images
2187

    
2188
Alternatively check if the new container and file appear on the Pithos Web UI.
2189

    
2190
Register an existing Image file to Cyclades
2191
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2192

    
2193
For the purposes of the following example, we assume that the user UUID is
2194
``u53r-un1qu3-1d``.
2195

    
2196
Once the Image file has been successfully uploaded on Pithos then we register
2197
it to Cyclades, by running:
2198

    
2199
.. code-block:: console
2200

    
2201
   $ kamaki image register "Debian Base" \
2202
                           pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump \
2203
                           --public \
2204
                           --disk-format=diskdump \
2205
                           --property OSFAMILY=linux --property ROOT_PARTITION=1 \
2206
                           --property description="Debian Squeeze Base System" \
2207
                           --property size=451 --property kernel=2.6.32 --property GUI="No GUI" \
2208
                           --property sortorder=1 --property USERS=root --property OS=debian
2209

    
2210
This command registers the Pithos file
2211
``pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump`` as an
2212
Image in Cyclades. This Image will be public (``--public``), so all users will
2213
be able to spawn VMs from it and is of type ``diskdump``. The first two
2214
properties (``OSFAMILY`` and ``ROOT_PARTITION``) are mandatory. All the rest
2215
properties are optional, but recommended, so that the Images appear nicely on
2216
the Cyclades Web UI. ``Debian Base`` will appear as the name of this Image. The
2217
``OS`` property's valid values may be found in the ``IMAGE_ICONS`` variable
2218
inside the ``20-snf-cyclades-app-ui.conf`` configuration file.
2219

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

    
2225
Spawn a VM from the Cyclades Web UI
2226
-----------------------------------
2227

    
2228
If the registration completes successfully, then go to the Cyclades Web UI from
2229
your browser at:
2230

    
2231
 `https://node1.example.com/cyclades/ui/`
2232

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

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

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

    
2249
Congratulations. You have successfully installed the whole Synnefo stack and
2250
connected all components. Go ahead in the next section to test the Network
2251
functionality from inside Cyclades and discover even more features.
2252

    
2253
General Testing
2254
===============
2255

    
2256
Notes
2257
=====
2258