Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (75.8 kB)

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

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

    
6
This is the Administrator's quick installation guide.
7

    
8
It describes how to install the whole synnefo stack on two (2) physical nodes,
9
with minimum configuration. It installs synnefo from Debian packages, and
10
assumes the nodes run Debian Squeeze. After successful installation, you will
11
have the following services running:
12

    
13
    * Identity Management (Astakos)
14
    * Object Storage Service (Pithos)
15
    * Compute Service (Cyclades)
16
    * Image 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://apt2.dev.grnet.gr stable/``
63
| ``deb-src http://apt2.dev.grnet.gr stable/``
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
After successful installation of snf-astakos-app, make sure that also
507
snf-webproject has been installed (marked as "Recommended" package). By default
508
Debian installs "Recommended" packages, but if you have changed your
509
configuration and the package didn't install automatically, you should
510
explicitly install it manually running:
511

    
512
.. code-block:: console
513

    
514
   # apt-get install snf-webproject
515

    
516
The reason snf-webproject is "Recommended" and not a hard dependency, is to give
517
the experienced administrator the ability to install Synnefo in a custom made
518
`Django <https://www.djangoproject.com/>`_ project. This corner case
519
concerns only very advanced users that know what they are doing and want to
520
experiment with synnefo.
521

    
522

    
523
.. _conf-astakos:
524

    
525
Configuration of Astakos
526
========================
527

    
528
Conf Files
529
----------
530

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

    
538
After getting familiar with synnefo, you will be able to customize the software
539
as you wish and fits your needs. Many options are available, to empower the
540
administrator with extensively customizable setups.
541

    
542
For the snf-webproject component (installed as an astakos dependency), we
543
need the following:
544

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

    
548
.. code-block:: console
549

    
550
    DATABASES = {
551
     'default': {
552
         # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle'
553
         'ENGINE': 'postgresql_psycopg2',
554
         # ATTENTION: This *must* be the absolute path if using sqlite3.
555
         # See: http://docs.djangoproject.com/en/dev/ref/settings/#name
556
         'NAME': 'snf_apps',
557
         'USER': 'synnefo',                      # Not used with sqlite3.
558
         'PASSWORD': 'example_passw0rd',         # Not used with sqlite3.
559
         # Set to empty string for localhost. Not used with sqlite3.
560
         'HOST': '4.3.2.1',
561
         # Set to empty string for default. Not used with sqlite3.
562
         'PORT': '5432',
563
     }
564
    }
565

    
566
Edit ``/etc/synnefo/10-snf-webproject-deploy.conf``. Uncomment and edit
567
``SECRET_KEY``. This is a Django specific setting which is used to provide a
568
seed in secret-key hashing algorithms. Set this to a random string of your
569
choise and keep it private:
570

    
571
.. code-block:: console
572

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

    
575
For astakos specific configuration, edit the following options in
576
``/etc/synnefo/20-snf-astakos-app-settings.conf`` :
577

    
578
.. code-block:: console
579

    
580
    ASTAKOS_DEFAULT_ADMIN_EMAIL = None
581

    
582
    ASTAKOS_COOKIE_DOMAIN = '.example.com'
583

    
584
    ASTAKOS_BASE_URL = 'https://node1.example.com'
585

    
586
The ``ASTAKOS_COOKIE_DOMAIN`` should be the base url of our domain (for all
587
services). ``ASTAKOS_BASE_URL`` is the astakos top-level URL.
588

    
589
``ASTAKOS_DEFAULT_ADMIN_EMAIL`` refers to the administrator's email.
590
Every time a new account is created a notification is sent to this email.
591
For this we need access to a running mail server, so we have disabled
592
it for now by setting its value to None. For more informations on this,
593
read the relative :ref:`section <mail-server>`.
594

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

    
598
    .. code-block:: console
599

    
600
        ASTAKOS_RECAPTCHA_PUBLIC_KEY = 'example_recaptcha_public_key!@#$%^&*('
601
        ASTAKOS_RECAPTCHA_PRIVATE_KEY = 'example_recaptcha_private_key!@#$%^&*('
602
        ASTAKOS_RECAPTCHA_USE_SSL = True
603
        ASTAKOS_RECAPTCHA_ENABLED = True
604

    
605
    For the ``ASTAKOS_RECAPTCHA_PUBLIC_KEY`` and ``ASTAKOS_RECAPTCHA_PRIVATE_KEY``
606
    go to https://www.google.com/recaptcha/admin/create and create your own pair.
607

    
608
Then edit ``/etc/synnefo/20-snf-astakos-app-cloudbar.conf`` :
609

    
610
.. code-block:: console
611

    
612
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
613

    
614
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services'
615

    
616
    CLOUDBAR_MENU_URL = 'https://node1.example.com/im/get_menu'
617

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

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

    
625
.. note:: Because Cyclades and Astakos are running on the same machine
626
    in our example, we have to deactivate the CSRF verification. We can do so
627
    by adding to
628
    ``/etc/synnefo/99-local.conf``:
629

    
630
    .. code-block:: console
631

    
632
        MIDDLEWARE_CLASSES.remove('django.middleware.csrf.CsrfViewMiddleware')
633
        TEMPLATE_CONTEXT_PROCESSORS.remove('django.core.context_processors.csrf')
634

    
635
Enable Pooling
636
--------------
637

    
638
This section can be bypassed, but we strongly recommend you apply the following,
639
since they result in a significant performance boost.
640

    
641
Synnefo includes a pooling DBAPI driver for PostgreSQL, as a thin wrapper
642
around Psycopg2. This allows independent Django requests to reuse pooled DB
643
connections, with significant performance gains.
644

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

    
648
.. code-block:: console
649

    
650
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
651
    monkey_patch_psycopg2()
652

    
653
Since we are running with greenlets, we should modify psycopg2 behavior, so it
654
works properly in a greenlet context:
655

    
656
.. code-block:: console
657

    
658
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
659
    make_psycopg_green()
660

    
661
Use the Psycopg2 driver as usual. For Django, this means using
662
``django.db.backends.postgresql_psycopg2`` without any modifications. To enable
663
connection pooling, pass a nonzero ``synnefo_poolsize`` option to the DBAPI
664
driver, through ``DATABASES.OPTIONS`` in Django.
665

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

    
669
.. code-block:: console
670

    
671
    # Monkey-patch psycopg2
672
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
673
    monkey_patch_psycopg2()
674

    
675
    # If running with greenlets
676
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
677
    make_psycopg_green()
678

    
679
    DATABASES = {
680
     'default': {
681
         # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle'
682
         'ENGINE': 'postgresql_psycopg2',
683
         'OPTIONS': {'synnefo_poolsize': 8},
684

    
685
         # ATTENTION: This *must* be the absolute path if using sqlite3.
686
         # See: http://docs.djangoproject.com/en/dev/ref/settings/#name
687
         'NAME': 'snf_apps',
688
         'USER': 'synnefo',                      # Not used with sqlite3.
689
         'PASSWORD': 'example_passw0rd',         # Not used with sqlite3.
690
         # Set to empty string for localhost. Not used with sqlite3.
691
         'HOST': '4.3.2.1',
692
         # Set to empty string for default. Not used with sqlite3.
693
         'PORT': '5432',
694
     }
695
    }
696

    
697
Database Initialization
698
-----------------------
699

    
700
After configuration is done, we initialize the database by running:
701

    
702
.. code-block:: console
703

    
704
    # snf-manage syncdb
705

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

    
710
.. code-block:: console
711

    
712
    # snf-manage migrate im
713
    # snf-manage migrate quotaholder_app
714

    
715
Then, we load the pre-defined user groups
716

    
717
.. code-block:: console
718

    
719
    # snf-manage loaddata groups
720

    
721
.. _services-reg:
722

    
723
Services Registration
724
---------------------
725

    
726
When the database is ready, we need to register the services. The following
727
command will ask you to register the standard Synnefo services (astakos,
728
cyclades, and pithos). Note that you have to register at least astakos in
729
order to have a usable authentication system. For each service, you will be
730
asked to provide the service URL (to appear in the Cloudbar) as well as its
731
API URL. Moreover, the command will automatically register the resource
732
definitions offered by the respective service.
733

    
734
.. code-block:: console
735

    
736
    # snf-register-services
737

    
738
Setting Default Base Quota for Resources
739
----------------------------------------
740

    
741
We now have to specify the limit on resources that each user can employ
742
(exempting resources offered by projects).
743

    
744
.. code-block:: console
745

    
746
    # snf-manage resource-modify --limit-interactive
747

    
748

    
749
Servers Initialization
750
----------------------
751

    
752
Finally, we initialize the servers on node1:
753

    
754
.. code-block:: console
755

    
756
    root@node1:~ # /etc/init.d/gunicorn restart
757
    root@node1:~ # /etc/init.d/apache2 restart
758

    
759
We have now finished the Astakos setup. Let's test it now.
760

    
761

    
762
Testing of Astakos
763
==================
764

    
765
Open your favorite browser and go to:
766

    
767
``http://node1.example.com/im``
768

    
769
If this redirects you to ``https://node1.example.com/im/`` and you can see
770
the "welcome" door of Astakos, then you have successfully setup Astakos.
771

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

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

    
780
.. code-block:: console
781

    
782
    root@node1:~ # snf-manage user-list
783

    
784
This command should show you a list with only one user; the one we just created.
785
This user should have an id with a value of ``1``. It should also have an
786
"active" status with the value of ``0`` (inactive). Now run:
787

    
788
.. code-block:: console
789

    
790
    root@node1:~ # snf-manage user-update --set-active 1
791

    
792
This modifies the active value to ``1``, and actually activates the user.
793
When running in production, the activation is done automatically with different
794
types of moderation, that Astakos supports. You can see the moderation methods
795
(by invitation, whitelists, matching regexp, etc.) at the Astakos specific
796
documentation. In production, you can also manually activate a user, by sending
797
him/her an activation email. See how to do this at the :ref:`User
798
activation <user_activation>` section.
799

    
800
Now let's go back to the homepage. Open ``http://node1.example.com/im/`` with
801
your browser again. Try to sign in using your new credentials. If the astakos
802
menu appears and you can see your profile, then you have successfully setup
803
Astakos.
804

    
805
Let's continue to install Pithos now.
806

    
807

    
808
Installation of Pithos on node2
809
===============================
810

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

    
815
.. code-block:: console
816

    
817
   # apt-get install snf-pithos-app snf-pithos-backend
818

    
819
After successful installation of snf-pithos-app, make sure that also
820
snf-webproject has been installed (marked as "Recommended" package). Refer to
821
the "Installation of Astakos on node1" section, if you don't remember why this
822
should happen. Now, install the pithos web interface:
823

    
824
.. code-block:: console
825

    
826
   # apt-get install snf-pithos-webclient
827

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

    
832

    
833
.. _conf-pithos:
834

    
835
Configuration of Pithos
836
=======================
837

    
838
Conf Files
839
----------
840

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

    
847
Edit ``/etc/synnefo/20-snf-pithos-app-settings.conf``. There you need to set
848
this options:
849

    
850
.. code-block:: console
851

    
852
   ASTAKOS_BASE_URL = 'https://node1.example.com/'
853

    
854
   PITHOS_BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
855
   PITHOS_BACKEND_BLOCK_PATH = '/srv/pithos/data'
856

    
857

    
858
   PITHOS_SERVICE_TOKEN = 'pithos_service_token22w=='
859

    
860
   # Set to False if astakos & pithos are on the same host
861
   #PITHOS_PROXY_USER_SERVICES = True
862

    
863

    
864
The ``PITHOS_BACKEND_DB_CONNECTION`` option tells to the Pithos app where to
865
find the Pithos backend database. Above we tell Pithos that its database is
866
``snf_pithos`` at node1 and to connect as user ``synnefo`` with password
867
``example_passw0rd``.  All those settings where setup during node1's "Database
868
setup" section.
869

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

    
875
The ``ASTAKOS_BASE_URL`` option informs the Pithos app where Astakos is.
876
The Astakos service is used for user management (authentication, quotas, etc.)
877

    
878
The ``PITHOS_SERVICE_TOKEN`` should be the Pithos token returned by running on
879
the Astakos node (node1 in our case):
880

    
881
.. code-block:: console
882

    
883
   # snf-manage service-list
884

    
885
The token has been generated automatically during the :ref:`Pithos service
886
registration <services-reg>`.
887

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

    
891
.. code-block:: console
892

    
893
    PITHOS_UI_LOGIN_URL = "https://node1.example.com/im/login?next="
894
    PITHOS_UI_FEEDBACK_URL = "https://node2.example.com/feedback"
895

    
896
The ``PITHOS_UI_LOGIN_URL`` option tells the client where to redirect you, if
897
you are not logged in. The ``PITHOS_UI_FEEDBACK_URL`` option points at the
898
Pithos feedback form. Astakos already provides a generic feedback form for all
899
services, so we use this one.
900

    
901
The ``PITHOS_UPDATE_MD5`` option by default disables the computation of the
902
object checksums. This results to improved performance during object uploading.
903
However, if compatibility with the OpenStack Object Storage API is important
904
then it should be changed to ``True``.
905

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

    
909
.. code-block:: console
910

    
911
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
912
    PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE = '3'
913
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services'
914
    CLOUDBAR_MENU_URL = 'https://node1.example.com/im/get_menu'
915

    
916
The ``CLOUDBAR_LOCATION`` tells the client where to find the astakos common
917
cloudbar.
918

    
919
The ``PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE`` points to an already registered
920
Astakos service. You can see all :ref:`registered services <services-reg>` by
921
running on the Astakos node (node1):
922

    
923
.. code-block:: console
924

    
925
   # snf-manage service-list
926

    
927
The value of ``PITHOS_UI_CLOUDBAR_ACTIVE_SERVICE`` should be the pithos
928
service's ``id`` as shown by the above command, in our case ``3``.
929

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

    
934
Pooling and Greenlets
935
---------------------
936

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

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

    
946
.. code-block:: console
947

    
948
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
949
    make_psycopg_green()
950

    
951
Furthermore, add the ``--worker-class=gevent`` (or ``--worker-class=sync`` as
952
mentioned above, depending on your setup) argument on your
953
``/etc/gunicorn.d/synnefo`` configuration file. The file should look something
954
like this:
955

    
956
.. code-block:: console
957

    
958
    CONFIG = {
959
     'mode': 'django',
960
     'environment': {
961
       'DJANGO_SETTINGS_MODULE': 'synnefo.settings',
962
     },
963
     'working_dir': '/etc/synnefo',
964
     'user': 'www-data',
965
     'group': 'www-data',
966
     'args': (
967
       '--bind=127.0.0.1:8080',
968
       '--workers=4',
969
       '--worker-class=gevent',
970
       '--log-level=debug',
971
       '--timeout=43200'
972
     ),
973
    }
974

    
975
Stamp Database Revision
976
-----------------------
977

    
978
Pithos uses the alembic_ database migrations tool.
979

    
980
.. _alembic: http://alembic.readthedocs.org
981

    
982
After a sucessful installation, we should stamp it at the most recent
983
revision, so that future migrations know where to start upgrading in
984
the migration history.
985

    
986
First, find the most recent revision in the migration history:
987

    
988
.. code-block:: console
989

    
990
    root@node2:~ # pithos-migrate history
991
    2a309a9a3438 -> 27381099d477 (head), alter public add column url
992
    165ba3fbfe53 -> 2a309a9a3438, fix statistics negative population
993
    3dd56e750a3 -> 165ba3fbfe53, update account in paths
994
    230f8ce9c90f -> 3dd56e750a3, Fix latest_version
995
    8320b1c62d9 -> 230f8ce9c90f, alter nodes add column latest version
996
    None -> 8320b1c62d9, create index nodes.parent
997

    
998
Finally, we stamp it with the one found in the previous step:
999

    
1000
.. code-block:: console
1001

    
1002
    root@node2:~ # pithos-migrate stamp 27381099d477
1003

    
1004
Servers Initialization
1005
----------------------
1006

    
1007
After configuration is done, we initialize the servers on node2:
1008

    
1009
.. code-block:: console
1010

    
1011
    root@node2:~ # /etc/init.d/gunicorn restart
1012
    root@node2:~ # /etc/init.d/apache2 restart
1013

    
1014
You have now finished the Pithos setup. Let's test it now.
1015

    
1016

    
1017
Testing of Pithos
1018
=================
1019

    
1020
Open your browser and go to the Astakos homepage:
1021

    
1022
``http://node1.example.com/im``
1023

    
1024
Login, and you will see your profile page. Now, click the "pithos" link on the
1025
top black cloudbar. If everything was setup correctly, this will redirect you
1026
to:
1027

    
1028

    
1029
and you will see the blue interface of the Pithos application.  Click the
1030
orange "Upload" button and upload your first file. If the file gets uploaded
1031
successfully, then this is your first sign of a successful Pithos installation.
1032
Go ahead and experiment with the interface to make sure everything works
1033
correctly.
1034

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

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

    
1040
If you would like to do more, such as:
1041

    
1042
    * Spawning VMs
1043
    * Spawning VMs from Images stored on Pithos
1044
    * Uploading your custom Images to Pithos
1045
    * Spawning VMs from those custom Images
1046
    * Registering existing Pithos files as Images
1047
    * Connect VMs to the Internet
1048
    * Create Private Networks
1049
    * Add VMs to Private Networks
1050

    
1051
please continue with the rest of the guide.
1052

    
1053

    
1054
Cyclades Prerequisites
1055
======================
1056

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

    
1062
Besides Astakos and Pithos, you will also need a number of additional working
1063
prerequisites, before you start the Cyclades installation.
1064

    
1065
Ganeti
1066
------
1067

    
1068
`Ganeti <http://code.google.com/p/ganeti/>`_ handles the low level VM management
1069
for Cyclades, so Cyclades requires a working Ganeti installation at the backend.
1070
Please refer to the
1071
`ganeti documentation <http://docs.ganeti.org/ganeti/2.5/html>`_ for all the
1072
gory details. A successful Ganeti installation concludes with a working
1073
:ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs
1074
<GANETI_NODES>`.
1075

    
1076
The above Ganeti cluster can run on different physical machines than node1 and
1077
node2 and can scale independently, according to your needs.
1078

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

    
1083
We highly recommend that you read the official Ganeti documentation, if you are
1084
not familiar with Ganeti.
1085

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

    
1091
.. code-block:: console
1092

    
1093
   # apt-get install snf-ganeti ganeti-htools
1094
   # rmmod -f drbd && modprobe drbd minor_count=255 usermode_helper=/bin/true
1095

    
1096
You should have:
1097

    
1098
Ganeti >= 2.6.2+ippool11+hotplug5+extstorage3+rdbfix1+kvmfix2-1
1099

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

    
1110
.. code-block:: console
1111

    
1112
    root@node1:~ # gnt-cluster init --enabled-hypervisors=kvm --no-ssh-init \
1113
                    --no-etc-hosts --vg-name=ganeti --nic-parameters link=br0 \
1114
                    --master-netdev eth0 ganeti.node1.example.com
1115
    root@node1:~ # gnt-cluster modify --default-iallocator hail
1116
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:kernel_path=
1117
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:vnc_bind_address=0.0.0.0
1118

    
1119
    root@node1:~ # gnt-node add --no-ssh-key-check --master-capable=yes \
1120
                    --vm-capable=yes node2.example.com
1121
    root@node1:~ # gnt-cluster modify --disk-parameters=drbd:metavg=ganeti
1122
    root@node1:~ # gnt-group modify --disk-parameters=drbd:metavg=ganeti default
1123

    
1124
For any problems you may stumble upon installing Ganeti, please refer to the
1125
`official documentation <http://docs.ganeti.org/ganeti/2.5/html>`_. Installation
1126
of Ganeti is out of the scope of this guide.
1127

    
1128
.. _cyclades-install-snfimage:
1129

    
1130
snf-image
1131
---------
1132

    
1133
Installation
1134
~~~~~~~~~~~~
1135
For :ref:`Cyclades <cyclades>` to be able to launch VMs from specified Images,
1136
you need the :ref:`snf-image <snf-image>` OS Definition installed on *all*
1137
VM-capable Ganeti nodes. This means we need :ref:`snf-image <snf-image>` on
1138
node1 and node2. You can do this by running on *both* nodes:
1139

    
1140
.. code-block:: console
1141

    
1142
   # apt-get install snf-image snf-pithos-backend python-psycopg2
1143

    
1144
snf-image also needs the `snf-pithos-backend <snf-pithos-backend>`, to be able
1145
to handle image files stored on Pithos. It also needs `python-psycopg2` to be
1146
able to access the Pithos database. This is why, we also install them on *all*
1147
VM-capable Ganeti nodes.
1148

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

    
1154
After `snf-image` has been installed successfully, create the helper VM by
1155
running on *both* nodes:
1156

    
1157
.. code-block:: console
1158

    
1159
   # snf-image-update-helper
1160

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

    
1165
Configuration
1166
~~~~~~~~~~~~~
1167
snf-image supports native access to Images stored on Pithos. This means that
1168
it can talk directly to the Pithos backend, without the need of providing a
1169
public URL. More details, are described in the next section. For now, the only
1170
thing we need to do, is configure snf-image to access our Pithos backend.
1171

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

    
1175
.. code-block:: console
1176

    
1177
    PITHOS_DB="postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos"
1178

    
1179
    PITHOS_DATA="/srv/pithos/data"
1180

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

    
1184
If you would like to use Images that are also/only stored locally, you need to
1185
save them under ``IMAGE_DIR``, however this guide targets Images stored only on
1186
Pithos.
1187

    
1188
Testing
1189
~~~~~~~
1190
You can test that snf-image is successfully installed by running on the
1191
:ref:`GANETI-MASTER <GANETI_NODES>` (in our case node1):
1192

    
1193
.. code-block:: console
1194

    
1195
   # gnt-os diagnose
1196

    
1197
This should return ``valid`` for snf-image.
1198

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

    
1205
.. _snf-image-images:
1206

    
1207
Actual Images for snf-image
1208
---------------------------
1209

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

    
1216
:ref:`snf-image <snf-image>` also supports three (3) different locations for the
1217
above Images to be stored:
1218

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

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

    
1229
To do so, do the following:
1230

    
1231
a) Download the Image from the official snf-image page.
1232

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

    
1237
Once the Image is uploaded successfully, download the Image's metadata file
1238
from the official snf-image page. You will need it, for spawning a VM from
1239
Ganeti, in the next section.
1240

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

    
1245
.. _ganeti-with-pithos-images:
1246

    
1247
Spawning a VM from a Pithos Image, using Ganeti
1248
-----------------------------------------------
1249

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

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

    
1258
.. code-block:: console
1259

    
1260
   # gnt-instance add -o snf-image+default --os-parameters \
1261
                      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"}' \
1262
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1263
                      testvm1
1264

    
1265
In the above command:
1266

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

    
1278
If the ``gnt-instance add`` command returns successfully, then run:
1279

    
1280
.. code-block:: console
1281

    
1282
   # gnt-instance info testvm1 | grep "console connection"
1283

    
1284
to find out where to connect using VNC. If you can connect successfully and can
1285
login to your new instance using the root password ``my_vm_example_passw0rd``,
1286
then everything works as expected and you have your new Debian Base VM up and
1287
running.
1288

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

    
1298
If everything works, you have successfully connected Ganeti with Pithos. Let's
1299
move on to networking now.
1300

    
1301
.. warning::
1302

    
1303
    You can bypass the networking sections and go straight to
1304
    :ref:`Cyclades Ganeti tools <cyclades-gtools>`, if you do not want to setup
1305
    the Cyclades Network Service, but only the Cyclades Compute Service
1306
    (recommended for now).
1307

    
1308
Networking Setup Overview
1309
-------------------------
1310

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

    
1317
Since synnefo 0.11 all network actions are managed with the snf-manage
1318
network-* commands. This needs the underlying setup (Ganeti, nfdhcpd,
1319
snf-network, bridges, vlans) to be already configured correctly. The only
1320
actions needed in this point are:
1321

    
1322
a) Have Ganeti with IP pool management support installed.
1323

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

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

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

    
1332
.. _snf-network:
1333

    
1334
snf-network
1335
~~~~~~~~~~~
1336

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

    
1342
Install snf-network on all Ganeti nodes:
1343

    
1344
.. code-block:: console
1345

    
1346
   # apt-get install snf-network
1347

    
1348
Then, in :file:`/etc/default/snf-network` set:
1349

    
1350
.. code-block:: console
1351

    
1352
   MAC_MASK=ff:ff:f0:00:00:00
1353

    
1354
.. _nfdhcpd:
1355

    
1356
nfdhcpd
1357
~~~~~~~
1358

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

    
1364
.. code-block:: console
1365

    
1366
   # apt-get install nfqueue-bindings-python=0.3+physindev-1
1367
   # apt-get install nfdhcpd
1368

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

    
1374
.. code-block:: console
1375

    
1376
   # /etc/init.d/nfdhcpd restart
1377

    
1378
If you are using ``ferm``, then you need to run the following:
1379

    
1380
.. code-block:: console
1381

    
1382
   # echo "@include 'nfdhcpd.ferm';" >> /etc/ferm/ferm.conf
1383
   # /etc/init.d/ferm restart
1384

    
1385
or make sure to run after boot:
1386

    
1387
.. code-block:: console
1388

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

    
1391
and if you have IPv6 enabled:
1392

    
1393
.. code-block:: console
1394

    
1395
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 133 -j NFQUEUE --queue-num 43
1396
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 135 -j NFQUEUE --queue-num 44
1397

    
1398
You can check which clients are currently served by nfdhcpd by running:
1399

    
1400
.. code-block:: console
1401

    
1402
   # kill -SIGUSR1 `cat /var/run/nfdhcpd/nfdhcpd.pid`
1403

    
1404
When you run the above, then check ``/var/log/nfdhcpd/nfdhcpd.log``.
1405

    
1406
Public Network Setup
1407
--------------------
1408

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

    
1415
Physical Host Setup
1416
~~~~~~~~~~~~~~~~~~~
1417

    
1418
Assuming ``eth0`` on both hosts is the public interface (directly connected
1419
to the router), run on every node:
1420

    
1421
.. code-block:: console
1422

    
1423
   # apt-get install vlan
1424
   # brctl addbr br0
1425
   # ip link set br0 up
1426
   # vconfig add eth0 100
1427
   # ip link set eth0.100 up
1428
   # brctl addif br0 eth0.100
1429

    
1430

    
1431
Testing a Public Network
1432
~~~~~~~~~~~~~~~~~~~~~~~~
1433

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

    
1438
.. code-block:: console
1439

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

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

    
1445
.. code-block:: console
1446

    
1447
   # gnt-network connect test-net-public default bridged br0
1448

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

    
1454
.. code-block:: console
1455

    
1456
   # gnt-instance add -o snf-image+default --os-parameters \
1457
                      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"}' \
1458
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1459
                      --net 0:ip=pool,network=test-net-public \
1460
                      testvm2
1461

    
1462
If the above returns successfully, connect to the new VM and run:
1463

    
1464
.. code-block:: console
1465

    
1466
   root@testvm2:~ # ip addr
1467
   root@testvm2:~ # ip route
1468
   root@testvm2:~ # cat /etc/resolv.conf
1469

    
1470
to check IP address (5.6.7.2), IP routes (default via 5.6.7.1) and DNS config
1471
(nameserver option in nfdhcpd.conf). This shows correct configuration of
1472
ganeti, snf-network and nfdhcpd.
1473

    
1474
Now ping the outside world. If this works too, then you have also configured
1475
correctly your physical host and router.
1476

    
1477
Make sure everything works as expected, before proceeding with the Private
1478
Networks setup.
1479

    
1480
.. _private-networks-setup:
1481

    
1482
Private Networks Setup
1483
----------------------
1484

    
1485
Synnefo supports two types of private networks:
1486

    
1487
 - based on MAC filtering
1488
 - based on physical VLANs
1489

    
1490
Both types provide Layer 2 isolation to the end-user.
1491

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

    
1498
Physical Host Setup
1499
~~~~~~~~~~~~~~~~~~~
1500

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

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

    
1508
.. code-block:: console
1509

    
1510
   # modprobe 8021q
1511
   # $iface=eth0
1512
   # for prv in $(seq 0 20); do
1513
        vlan=$prv
1514
        bridge=prv$prv
1515
        vconfig add $iface $vlan
1516
        ifconfig $iface.$vlan up
1517
        brctl addbr $bridge
1518
        brctl setfd $bridge 0
1519
        brctl addif $bridge $iface.$vlan
1520
        ifconfig $bridge up
1521
      done
1522

    
1523
The above will do the following :
1524

    
1525
 * provision 21 new bridges: ``prv0`` - ``prv20``
1526
 * provision 21 new vlans: ``eth0.0`` - ``eth0.20``
1527
 * add the corresponding vlan to the equivalent bridge
1528

    
1529
You can run ``brctl show`` on both nodes to see if everything was setup
1530
correctly.
1531

    
1532
Testing the Private Networks
1533
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1534

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

    
1540
We run the same command as in the Public Network testing section, but with one
1541
more argument for the second NIC:
1542

    
1543
.. code-block:: console
1544

    
1545
   # 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
1546
   # gnt-network connect test-net-prv-mac default bridged prv0
1547

    
1548
   # gnt-network add --network=10.0.0.0/24 --tags=nfdhcpd --network-type=private test-net-prv-vlan
1549
   # gnt-network connect test-net-prv-vlan default bridged prv1
1550

    
1551
   # gnt-instance add -o snf-image+default --os-parameters \
1552
                      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"}' \
1553
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1554
                      --net 0:ip=pool,network=test-net-public \
1555
                      --net 1:ip=pool,network=test-net-prv-mac \
1556
                      --net 2:ip=none,network=test-net-prv-vlan \
1557
                      testvm3
1558

    
1559
   # gnt-instance add -o snf-image+default --os-parameters \
1560
                      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"}' \
1561
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1562
                      --net 0:ip=pool,network=test-net-public \
1563
                      --net 1:ip=pool,network=test-net-prv-mac \
1564
                      --net 2:ip=none,network=test-net-prv-vlan \
1565
                      testvm4
1566

    
1567
Above, we create two instances with first NIC connected to the internet, their
1568
second NIC connected to a MAC filtered private Network and their third NIC
1569
connected to the first Physical VLAN Private Network. Now, connect to the
1570
instances using VNC and make sure everything works as expected:
1571

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

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

    
1577
 c) ip link set ``eth1``/``eth2`` up
1578

    
1579
 d) dhclient ``eth1``/``eth2``
1580

    
1581
 e) On testvm3  ping 192.168.1.2/10.0.0.2
1582

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

    
1586
.. _cyclades-gtools:
1587

    
1588
Cyclades Ganeti tools
1589
---------------------
1590

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

    
1595
.. code-block:: console
1596

    
1597
   # apt-get install snf-cyclades-gtools
1598

    
1599
This will install the following:
1600

    
1601
 * ``snf-ganeti-eventd`` (daemon to publish Ganeti related messages on RabbitMQ)
1602
 * ``snf-ganeti-hook`` (all necessary hooks under ``/etc/ganeti/hooks``)
1603
 * ``snf-progress-monitor`` (used by ``snf-image`` to publish progress messages)
1604

    
1605
Configure ``snf-cyclades-gtools``
1606
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1607

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

    
1612
.. code-block:: console
1613

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

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

    
1619
Connect ``snf-image`` with ``snf-progress-monitor``
1620
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1621

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

    
1626
.. code-block:: console
1627

    
1628
   PROGRESS_MONITOR="snf-progress-monitor"
1629

    
1630
This file should be editted in all Ganeti nodes.
1631

    
1632
.. _rapi-user:
1633

    
1634
Synnefo RAPI user
1635
-----------------
1636

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

    
1642
.. code-block:: console
1643

    
1644
   # echo -n 'cyclades:Ganeti Remote API:example_rapi_passw0rd' | openssl md5
1645

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

    
1648
.. code-block:: console
1649

    
1650
   cyclades {HA1}55aec7050aa4e4b111ca43cb505a61a0 write
1651

    
1652
More about Ganeti's RAPI users `here.
1653
<http://docs.ganeti.org/ganeti/2.5/html/rapi.html#introduction>`_
1654

    
1655
You have now finished with all needed Prerequisites for Cyclades. Let's move on
1656
to the actual Cyclades installation.
1657

    
1658

    
1659
Installation of Cyclades on node1
1660
=================================
1661

    
1662
This section describes the installation of Cyclades. Cyclades is Synnefo's
1663
Compute service. The Image Service will get installed automatically along with
1664
Cyclades, because it is contained in the same Synnefo component.
1665

    
1666
We will install Cyclades on node1. To do so, we install the corresponding
1667
package by running on node1:
1668

    
1669
.. code-block:: console
1670

    
1671
   # apt-get install snf-cyclades-app memcached python-memcache
1672

    
1673
If all packages install successfully, then Cyclades are installed and we
1674
proceed with their configuration.
1675

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

    
1683
Configuration of Cyclades
1684
=========================
1685

    
1686
Conf files
1687
----------
1688

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

    
1696
Edit ``/etc/synnefo/20-snf-cyclades-app-api.conf``:
1697

    
1698
.. code-block:: console
1699

    
1700
   CYCLADES_BASE_URL = 'https://node1.example.com/cyclades'
1701
   ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
1702

    
1703
   # Set to False if astakos & cyclades are on the same host
1704
   CYCLADES_PROXY_USER_SERVICES = False
1705

    
1706
The ``ASTAKOS_BASE_URL`` denotes the Astakos endpoint for Cyclades,
1707
which is used for all user management, including authentication.
1708
Since our Astakos, Cyclades, and Pithos installations belong together,
1709
they should all have identical ``ASTAKOS_BASE_URL`` setting
1710
(see also, :ref:`previously <conf-pithos>`).
1711

    
1712
TODO: Document the Network Options here
1713

    
1714
Edit ``/etc/synnefo/20-snf-cyclades-app-cloudbar.conf``:
1715

    
1716
.. code-block:: console
1717

    
1718
   CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
1719
   CLOUDBAR_ACTIVE_SERVICE = '2'
1720
   CLOUDBAR_SERVICES_URL = 'https://node1.example.com/im/get_services'
1721
   CLOUDBAR_MENU_URL = 'https://account.node1.example.com/im/get_menu'
1722

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

    
1731
The ``CLOUDBAR_ACTIVE_SERVICE`` points to an already registered Astakos
1732
service. You can see all :ref:`registered services <services-reg>` by running
1733
on the Astakos node (node1):
1734

    
1735
.. code-block:: console
1736

    
1737
   # snf-manage service-list
1738

    
1739
The value of ``CLOUDBAR_ACTIVE_SERVICE`` should be the cyclades service's
1740
``id`` as shown by the above command, in our case ``2``.
1741

    
1742
Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``:
1743

    
1744
.. code-block:: console
1745

    
1746
   BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
1747
   BACKEND_BLOCK_PATH = '/srv/pithos/data/'
1748

    
1749
In this file we configure the Image Service. ``BACKEND_DB_CONNECTION``
1750
denotes the Pithos database (where the Image files are stored). So we set that
1751
to point to our Pithos database. ``BACKEND_BLOCK_PATH`` denotes the actual
1752
Pithos data location.
1753

    
1754
Edit ``/etc/synnefo/20-snf-cyclades-app-queues.conf``:
1755

    
1756
.. code-block:: console
1757

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

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

    
1764
Edit ``/etc/synnefo/20-snf-cyclades-app-ui.conf``:
1765

    
1766
.. code-block:: console
1767

    
1768
   UI_LOGIN_URL = "https://node1.example.com/im/login"
1769
   UI_LOGOUT_URL = "https://node1.example.com/im/logout"
1770

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

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

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

    
1779
.. code-block:: console
1780

    
1781
   VMAPI_CACHE_BACKEND = "memcached://127.0.0.1:11211/?timeout=3600"
1782
   VMAPI_BASE_URL = "https://node1.example.com"
1783

    
1784
Edit ``/etc/default/vncauthproxy``:
1785

    
1786
.. code-block:: console
1787

    
1788
   CHUID="nobody:www-data"
1789

    
1790
We have now finished with the basic Cyclades configuration.
1791

    
1792
Database Initialization
1793
-----------------------
1794

    
1795
Once Cyclades is configured, we sync the database:
1796

    
1797
.. code-block:: console
1798

    
1799
   $ snf-manage syncdb
1800
   $ snf-manage migrate
1801

    
1802
and load the initial server flavors:
1803

    
1804
.. code-block:: console
1805

    
1806
   $ snf-manage loaddata flavors
1807

    
1808
If everything returns successfully, our database is ready.
1809

    
1810
Add the Ganeti backend
1811
----------------------
1812

    
1813
In our installation we assume that we only have one Ganeti cluster, the one we
1814
setup earlier.  At this point you have to add this backend (Ganeti cluster) to
1815
cyclades assuming that you have setup the :ref:`Rapi User <rapi-user>`
1816
correctly.
1817

    
1818
.. code-block:: console
1819

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

    
1822
You can see everything has been setup correctly by running:
1823

    
1824
.. code-block:: console
1825

    
1826
   $ snf-manage backend-list
1827

    
1828
Enable the new backend by running:
1829

    
1830
.. code-block::
1831

    
1832
   $ snf-manage backend-modify --drained False 1
1833

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

    
1840
If something is not set correctly, you can modify the backend with the
1841
``snf-manage backend-modify`` command. If something has gone wrong, you could
1842
modify the backend to reflect the Ganeti installation by running:
1843

    
1844
.. code-block:: console
1845

    
1846
   $ snf-manage backend-modify --clustername "ganeti.node1.example.com"
1847
                               --user=cyclades
1848
                               --pass=example_rapi_passw0rd
1849
                               1
1850

    
1851
``clustername`` denotes the Ganeti-cluster's name. We provide the corresponding
1852
domain that resolves to the master IP, than the IP itself, to ensure Cyclades
1853
can talk to Ganeti even after a Ganeti master-failover.
1854

    
1855
``user`` and ``pass`` denote the RAPI user's username and the RAPI user's
1856
password.  Once we setup the first backend to point at our Ganeti cluster, we
1857
update the Cyclades backends status by running:
1858

    
1859
.. code-block:: console
1860

    
1861
   $ snf-manage backend-update-status
1862

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

    
1867
Add a Public Network
1868
----------------------
1869

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

    
1876
.. code-block:: console
1877

    
1878
   $ snf-manage network-create --subnet=5.6.7.0/27 \
1879
                               --gateway=5.6.7.1 \
1880
                               --subnet6=2001:648:2FFC:1322::/64 \
1881
                               --gateway6=2001:648:2FFC:1322::1 \
1882
                               --public --dhcp --flavor=CUSTOM \
1883
                               --link=br0 --mode=bridged \
1884
                               --name=public_network \
1885
                               --backend-id=1
1886

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

    
1890
.. code-block:: console
1891

    
1892
   $ snf-manage reconcile-networks
1893

    
1894
You can see all available networks by running:
1895

    
1896
.. code-block:: console
1897

    
1898
   $ snf-manage network-list
1899

    
1900
and inspect each network's state by running:
1901

    
1902
.. code-block:: console
1903

    
1904
   $ snf-manage network-inspect <net_id>
1905

    
1906
Finally, you can see the networks from the Ganeti perspective by running on the
1907
Ganeti MASTER:
1908

    
1909
.. code-block:: console
1910

    
1911
   $ gnt-network list
1912
   $ gnt-network info <network_name>
1913

    
1914
Create pools for Private Networks
1915
---------------------------------
1916

    
1917
To prevent duplicate assignment of resources to different private networks,
1918
Cyclades supports two types of pools:
1919

    
1920
 - MAC prefix Pool
1921
 - Bridge Pool
1922

    
1923
As long as those resourses have been provisioned, admin has to define two
1924
these pools in Synnefo:
1925

    
1926

    
1927
.. code-block:: console
1928

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

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

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

    
1935
.. code-block:: console
1936

    
1937
   DEFAULT_MAC_FILTERED_BRIDGE = 'prv0'
1938

    
1939
Servers restart
1940
---------------
1941

    
1942
Restart gunicorn on node1:
1943

    
1944
.. code-block:: console
1945

    
1946
   # /etc/init.d/gunicorn restart
1947

    
1948
Now let's do the final connections of Cyclades with Ganeti.
1949

    
1950
``snf-dispatcher`` initialization
1951
---------------------------------
1952

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

    
1958
.. code-block:: console
1959

    
1960
   SNF_DSPTCH_ENABLE=true
1961

    
1962
and start the daemon:
1963

    
1964
.. code-block:: console
1965

    
1966
   # /etc/init.d/snf-dispatcher start
1967

    
1968
You can see that everything works correctly by tailing its log file
1969
``/var/log/synnefo/dispatcher.log``.
1970

    
1971
``snf-ganeti-eventd`` on GANETI MASTER
1972
--------------------------------------
1973

    
1974
The last step of the Cyclades setup is enabling the ``snf-ganeti-eventd``
1975
daemon (part of the :ref:`Cyclades Ganeti tools <cyclades-gtools>` package).
1976
The daemon is already installed on the GANETI MASTER (node1 in our case).
1977
``snf-ganeti-eventd`` is disabled by default during the ``snf-cyclades-gtools``
1978
installation, so we enable it in its configuration file
1979
``/etc/default/snf-ganeti-eventd``:
1980

    
1981
.. code-block:: console
1982

    
1983
   SNF_EVENTD_ENABLE=true
1984

    
1985
and start the daemon:
1986

    
1987
.. code-block:: console
1988

    
1989
   # /etc/init.d/snf-ganeti-eventd start
1990

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

    
1993
Apply Quota
1994
-----------
1995

    
1996
The following commands will check and fix the integrity of user quota.
1997
In a freshly installed system, these commands have no effect and can be
1998
skipped.
1999

    
2000
.. code-block:: console
2001

    
2002
   node1 # snf-manage quota --sync
2003
   node1 # snf-manage reconcile-resources-astakos --fix
2004
   node2 # snf-manage reconcile-resources-pithos --fix
2005
   node1 # snf-manage reconcile-resources-cyclades --fix
2006

    
2007
If all the above return successfully, then you have finished with the Cyclades
2008
installation and setup.
2009

    
2010
Let's test our installation now.
2011

    
2012

    
2013
Testing of Cyclades
2014
===================
2015

    
2016
Cyclades Web UI
2017
---------------
2018

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

    
2023
 `http://node1.example.com/ui/`
2024

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

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

    
2035
Cyclades Images
2036
---------------
2037

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

    
2043
 * Upload an Image file to Pithos
2044
 * Register that Image file to Cyclades
2045
 * Spawn a new VM from that Image from the Cyclades Web UI
2046

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

    
2050
Installation of `kamaki`
2051
~~~~~~~~~~~~~~~~~~~~~~~~
2052

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

    
2060
.. code-block:: console
2061

    
2062
   # apt-get install kamaki
2063

    
2064
Configuration of kamaki
2065
~~~~~~~~~~~~~~~~~~~~~~~
2066

    
2067
Now we need to setup kamaki, by adding the appropriate URLs and tokens of our
2068
installation. We do this by running:
2069

    
2070
.. code-block:: console
2071

    
2072
   $ kamaki config set user.url "https://node1.example.com"
2073
   $ kamaki config set compute.url "https://node1.example.com/api/v1.1"
2074
   $ kamaki config set image.url "https://node1.example.com/image"
2075
   $ kamaki config set file.url "https://node2.example.com/v1"
2076
   $ kamaki config set token USER_TOKEN
2077

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

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

    
2083
.. code-block:: console
2084

    
2085
   $ kamaki config list
2086

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

    
2090
.. code-block:: console
2091

    
2092
  $ kamaki user authenticate
2093

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

    
2097
Upload an Image file to Pithos
2098
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2099

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

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

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

    
2112
We create the new ``images`` container by running:
2113

    
2114
.. code-block:: console
2115

    
2116
   $ kamaki file create images
2117

    
2118
To check if the container has been created, list all containers of your
2119
account:
2120

    
2121
.. code-block:: console
2122

    
2123
  $ kamaki file list
2124

    
2125
Then, we upload the Image file to that container:
2126

    
2127
.. code-block:: console
2128

    
2129
   $ kamaki file upload /srv/images/debian_base-6.0-7-x86_64.diskdump images
2130

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

    
2134
.. code-block:: console
2135

    
2136
  $ kamaki file list images
2137

    
2138
Alternatively check if the new container and file appear on the Pithos Web UI.
2139

    
2140
Register an existing Image file to Cyclades
2141
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2142

    
2143
For the purposes of the following example, we assume that the user UUID is
2144
``u53r-un1qu3-1d``.
2145

    
2146
Once the Image file has been successfully uploaded on Pithos then we register
2147
it to Cyclades, by running:
2148

    
2149
.. code-block:: console
2150

    
2151
   $ kamaki image register "Debian Base" \
2152
                           pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump \
2153
                           --public \
2154
                           --disk-format=diskdump \
2155
                           --property OSFAMILY=linux --property ROOT_PARTITION=1 \
2156
                           --property description="Debian Squeeze Base System" \
2157
                           --property size=451 --property kernel=2.6.32 --property GUI="No GUI" \
2158
                           --property sortorder=1 --property USERS=root --property OS=debian
2159

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

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

    
2175
Spawn a VM from the Cyclades Web UI
2176
-----------------------------------
2177

    
2178
If the registration completes successfully, then go to the Cyclades Web UI from
2179
your browser at:
2180

    
2181
 `https://node1.example.com/ui/`
2182

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

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

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

    
2199
Congratulations. You have successfully installed the whole Synnefo stack and
2200
connected all components. Go ahead in the next section to test the Network
2201
functionality from inside Cyclades and discover even more features.
2202

    
2203
General Testing
2204
===============
2205

    
2206
Notes
2207
=====
2208