Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (74.6 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_DEFAULT_ADMIN_EMAIL = None
564

    
565
    ASTAKOS_COOKIE_DOMAIN = '.example.com'
566

    
567
    ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
568

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

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

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

    
581
    .. code-block:: console
582

    
583
        ASTAKOS_RECAPTCHA_PUBLIC_KEY = 'example_recaptcha_public_key!@#$%^&*('
584
        ASTAKOS_RECAPTCHA_PRIVATE_KEY = 'example_recaptcha_private_key!@#$%^&*('
585
        ASTAKOS_RECAPTCHA_USE_SSL = True
586
        ASTAKOS_RECAPTCHA_ENABLED = True
587

    
588
    For the ``ASTAKOS_RECAPTCHA_PUBLIC_KEY`` and ``ASTAKOS_RECAPTCHA_PRIVATE_KEY``
589
    go to https://www.google.com/recaptcha/admin/create and create your own pair.
590

    
591
Then edit ``/etc/synnefo/20-snf-astakos-app-cloudbar.conf`` :
592

    
593
.. code-block:: console
594

    
595
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
596

    
597
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
598

    
599
    CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu'
600

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

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

    
608
Enable Pooling
609
--------------
610

    
611
This section can be bypassed, but we strongly recommend you apply the following,
612
since they result in a significant performance boost.
613

    
614
Synnefo includes a pooling DBAPI driver for PostgreSQL, as a thin wrapper
615
around Psycopg2. This allows independent Django requests to reuse pooled DB
616
connections, with significant performance gains.
617

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

    
621
.. code-block:: console
622

    
623
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
624
    monkey_patch_psycopg2()
625

    
626
Since we are running with greenlets, we should modify psycopg2 behavior, so it
627
works properly in a greenlet context:
628

    
629
.. code-block:: console
630

    
631
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
632
    make_psycopg_green()
633

    
634
Use the Psycopg2 driver as usual. For Django, this means using
635
``django.db.backends.postgresql_psycopg2`` without any modifications. To enable
636
connection pooling, pass a nonzero ``synnefo_poolsize`` option to the DBAPI
637
driver, through ``DATABASES.OPTIONS`` in Django.
638

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

    
642
.. code-block:: console
643

    
644
    # Monkey-patch psycopg2
645
    from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2
646
    monkey_patch_psycopg2()
647

    
648
    # If running with greenlets
649
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
650
    make_psycopg_green()
651

    
652
    DATABASES = {
653
     'default': {
654
         # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle'
655
         'ENGINE': 'postgresql_psycopg2',
656
         'OPTIONS': {'synnefo_poolsize': 8},
657

    
658
         # ATTENTION: This *must* be the absolute path if using sqlite3.
659
         # See: http://docs.djangoproject.com/en/dev/ref/settings/#name
660
         'NAME': 'snf_apps',
661
         'USER': 'synnefo',                      # Not used with sqlite3.
662
         'PASSWORD': 'example_passw0rd',         # Not used with sqlite3.
663
         # Set to empty string for localhost. Not used with sqlite3.
664
         'HOST': '4.3.2.1',
665
         # Set to empty string for default. Not used with sqlite3.
666
         'PORT': '5432',
667
     }
668
    }
669

    
670
Database Initialization
671
-----------------------
672

    
673
After configuration is done, we initialize the database by running:
674

    
675
.. code-block:: console
676

    
677
    # snf-manage syncdb
678

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

    
683
.. code-block:: console
684

    
685
    # snf-manage migrate im
686
    # snf-manage migrate quotaholder_app
687

    
688
Then, we load the pre-defined user groups
689

    
690
.. code-block:: console
691

    
692
    # snf-manage loaddata groups
693

    
694
.. _services-reg:
695

    
696
Services Registration
697
---------------------
698

    
699
When the database is ready, we need to register the services. The following
700
command will ask you to register the standard Synnefo components (astakos,
701
cyclades, and pithos) along with the services they provide. Note that you
702
have to register at least astakos in order to have a usable authentication
703
system. For each component, you will be asked to provide its base
704
installation URL as well as the UI URL (to appear in the Cloudbar).
705
Moreover, the command will automatically register the resource definitions
706
offered by the services.
707

    
708
.. code-block:: console
709

    
710
    # snf-component-register
711

    
712
.. note::
713

    
714
   This command is equivalent to running the following series of commands;
715
   it registers the three components in astakos and then in each host it
716
   exports the respective service definitions, copies the exported json file
717
   to the astakos host, where it finally imports it:
718

    
719
    .. code-block:: console
720

    
721
       astakos-host$ snf-manage component-add astakos astakos_ui_url
722
       astakos-host$ snf-manage component-add cyclades cyclades_ui_url
723
       astakos-host$ snf-manage component-add pithos pithos_ui_url
724
       astakos-host$ snf-manage service-export-astakos > astakos.json
725
       astakos-host$ snf-manage service-import --json astakos.json
726
       cyclades-host$ snf-manage service-export-cyclades > cyclades.json
727
       # copy the file to astakos-host
728
       astakos-host$ snf-manage service-import --json cyclades.json
729
       pithos-host$ snf-manage service-export-pithos > pithos.json
730
       # copy the file to astakos-host
731
       astakos-host$ snf-manage service-import --json pithos.json
732

    
733
Setting Default Base Quota for Resources
734
----------------------------------------
735

    
736
We now have to specify the limit on resources that each user can employ
737
(exempting resources offered by projects).
738

    
739
.. code-block:: console
740

    
741
    # snf-manage resource-modify --limit-interactive
742

    
743

    
744
Servers Initialization
745
----------------------
746

    
747
Finally, we initialize the servers on node1:
748

    
749
.. code-block:: console
750

    
751
    root@node1:~ # /etc/init.d/gunicorn restart
752
    root@node1:~ # /etc/init.d/apache2 restart
753

    
754
We have now finished the Astakos setup. Let's test it now.
755

    
756

    
757
Testing of Astakos
758
==================
759

    
760
Open your favorite browser and go to:
761

    
762
``http://node1.example.com/astakos``
763

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

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

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

    
775
.. code-block:: console
776

    
777
    root@node1:~ # snf-manage user-list
778

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

    
783
.. code-block:: console
784

    
785
    root@node1:~ # snf-manage user-modify 1 --verify --accept
786

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

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

    
800
Let's continue to install Pithos now.
801

    
802

    
803
Installation of Pithos on node2
804
===============================
805

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

    
810
.. code-block:: console
811

    
812
   # apt-get install snf-pithos-app snf-pithos-backend
813

    
814
Now, install the pithos web interface:
815

    
816
.. code-block:: console
817

    
818
   # apt-get install snf-pithos-webclient
819

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

    
824

    
825
.. _conf-pithos:
826

    
827
Configuration of Pithos
828
=======================
829

    
830
Conf Files
831
----------
832

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

    
839
Edit ``/etc/synnefo/20-snf-pithos-app-settings.conf``. There you need to set
840
this options:
841

    
842
.. code-block:: console
843

    
844
   ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
845

    
846
   PITHOS_BASE_URL = 'https://node2.example.com/pithos'
847
   PITHOS_BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
848
   PITHOS_BACKEND_BLOCK_PATH = '/srv/pithos/data'
849

    
850
   PITHOS_SERVICE_TOKEN = 'pithos_service_token22w'
851

    
852
   # Set to False if astakos & pithos are on the same host
853
   PITHOS_PROXY_USER_SERVICES = True
854

    
855

    
856
The ``PITHOS_BACKEND_DB_CONNECTION`` option tells to the Pithos app where to
857
find the Pithos backend database. Above we tell Pithos that its database is
858
``snf_pithos`` at node1 and to connect as user ``synnefo`` with password
859
``example_passw0rd``.  All those settings where setup during node1's "Database
860
setup" section.
861

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

    
867
The ``ASTAKOS_BASE_URL`` option informs the Pithos app where Astakos is.
868
The Astakos service is used for user management (authentication, quotas, etc.)
869

    
870
The ``PITHOS_BASE_URL`` setting must point to the top-level Pithos URL.
871

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

    
875
.. code-block:: console
876

    
877
   # snf-manage component-list
878

    
879
The token has been generated automatically during the :ref:`Pithos service
880
registration <services-reg>`.
881

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

    
885
.. code-block:: console
886

    
887
    PITHOS_UI_LOGIN_URL = "https://node1.example.com/ui/login?next="
888
    PITHOS_UI_FEEDBACK_URL = "https://node2.example.com/feedback"
889

    
890
The ``PITHOS_UI_LOGIN_URL`` option tells the client where to redirect you, if
891
you are not logged in. The ``PITHOS_UI_FEEDBACK_URL`` option points at the
892
Pithos feedback form. Astakos already provides a generic feedback form for all
893
services, so we use this one.
894

    
895
The ``PITHOS_UPDATE_MD5`` option by default disables the computation of the
896
object checksums. This results to improved performance during object uploading.
897
However, if compatibility with the OpenStack Object Storage API is important
898
then it should be changed to ``True``.
899

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

    
903
.. code-block:: console
904

    
905
    CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
906
    CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
907
    CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu'
908

    
909
The ``CLOUDBAR_LOCATION`` tells the client where to find the astakos common
910
cloudbar.
911

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

    
916
Pooling and Greenlets
917
---------------------
918

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

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

    
928
.. code-block:: console
929

    
930
    from synnefo.lib.db.psyco_gevent import make_psycopg_green
931
    make_psycopg_green()
932

    
933
Furthermore, add the ``--worker-class=gevent`` (or ``--worker-class=sync`` as
934
mentioned above, depending on your setup) argument on your
935
``/etc/gunicorn.d/synnefo`` configuration file. The file should look something
936
like this:
937

    
938
.. code-block:: console
939

    
940
    CONFIG = {
941
     'mode': 'django',
942
     'environment': {
943
       'DJANGO_SETTINGS_MODULE': 'synnefo.settings',
944
     },
945
     'working_dir': '/etc/synnefo',
946
     'user': 'www-data',
947
     'group': 'www-data',
948
     'args': (
949
       '--bind=127.0.0.1:8080',
950
       '--workers=4',
951
       '--worker-class=gevent',
952
       '--log-level=debug',
953
       '--timeout=43200'
954
     ),
955
    }
956

    
957
Stamp Database Revision
958
-----------------------
959

    
960
Pithos uses the alembic_ database migrations tool.
961

    
962
.. _alembic: http://alembic.readthedocs.org
963

    
964
After a successful installation, we should stamp it at the most recent
965
revision, so that future migrations know where to start upgrading in
966
the migration history.
967

    
968
.. code-block:: console
969

    
970
    root@node2:~ # pithos-migrate stamp head
971

    
972
Servers Initialization
973
----------------------
974

    
975
After configuration is done, we initialize the servers on node2:
976

    
977
.. code-block:: console
978

    
979
    root@node2:~ # /etc/init.d/gunicorn restart
980
    root@node2:~ # /etc/init.d/apache2 restart
981

    
982
You have now finished the Pithos setup. Let's test it now.
983

    
984

    
985
Testing of Pithos
986
=================
987

    
988
Open your browser and go to the Astakos homepage:
989

    
990
``http://node1.example.com/astakos``
991

    
992
Login, and you will see your profile page. Now, click the "pithos" link on the
993
top black cloudbar. If everything was setup correctly, this will redirect you
994
to:
995

    
996

    
997
and you will see the blue interface of the Pithos application.  Click the
998
orange "Upload" button and upload your first file. If the file gets uploaded
999
successfully, then this is your first sign of a successful Pithos installation.
1000
Go ahead and experiment with the interface to make sure everything works
1001
correctly.
1002

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

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

    
1008
If you would like to do more, such as:
1009

    
1010
    * Spawning VMs
1011
    * Spawning VMs from Images stored on Pithos
1012
    * Uploading your custom Images to Pithos
1013
    * Spawning VMs from those custom Images
1014
    * Registering existing Pithos files as Images
1015
    * Connect VMs to the Internet
1016
    * Create Private Networks
1017
    * Add VMs to Private Networks
1018

    
1019
please continue with the rest of the guide.
1020

    
1021

    
1022
Cyclades Prerequisites
1023
======================
1024

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

    
1030
Besides Astakos and Pithos, you will also need a number of additional working
1031
prerequisites, before you start the Cyclades installation.
1032

    
1033
Ganeti
1034
------
1035

    
1036
`Ganeti <http://code.google.com/p/ganeti/>`_ handles the low level VM management
1037
for Cyclades, so Cyclades requires a working Ganeti installation at the backend.
1038
Please refer to the
1039
`ganeti documentation <http://docs.ganeti.org/ganeti/2.5/html>`_ for all the
1040
gory details. A successful Ganeti installation concludes with a working
1041
:ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs
1042
<GANETI_NODES>`.
1043

    
1044
The above Ganeti cluster can run on different physical machines than node1 and
1045
node2 and can scale independently, according to your needs.
1046

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

    
1051
We highly recommend that you read the official Ganeti documentation, if you are
1052
not familiar with Ganeti.
1053

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

    
1059
.. code-block:: console
1060

    
1061
   # apt-get install snf-ganeti ganeti-htools
1062
   # rmmod -f drbd && modprobe drbd minor_count=255 usermode_helper=/bin/true
1063

    
1064
You should have:
1065

    
1066
Ganeti >= 2.6.2+ippool11+hotplug5+extstorage3+rdbfix1+kvmfix2-1
1067

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

    
1078
.. code-block:: console
1079

    
1080
    root@node1:~ # gnt-cluster init --enabled-hypervisors=kvm --no-ssh-init \
1081
                    --no-etc-hosts --vg-name=ganeti --nic-parameters link=br0 \
1082
                    --master-netdev eth0 ganeti.node1.example.com
1083
    root@node1:~ # gnt-cluster modify --default-iallocator hail
1084
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:kernel_path=
1085
    root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:vnc_bind_address=0.0.0.0
1086

    
1087
    root@node1:~ # gnt-node add --no-ssh-key-check --master-capable=yes \
1088
                    --vm-capable=yes node2.example.com
1089
    root@node1:~ # gnt-cluster modify --disk-parameters=drbd:metavg=ganeti
1090
    root@node1:~ # gnt-group modify --disk-parameters=drbd:metavg=ganeti default
1091

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

    
1096
.. _cyclades-install-snfimage:
1097

    
1098
snf-image
1099
---------
1100

    
1101
Installation
1102
~~~~~~~~~~~~
1103
For :ref:`Cyclades <cyclades>` to be able to launch VMs from specified Images,
1104
you need the :ref:`snf-image <snf-image>` OS Definition installed on *all*
1105
VM-capable Ganeti nodes. This means we need :ref:`snf-image <snf-image>` on
1106
node1 and node2. You can do this by running on *both* nodes:
1107

    
1108
.. code-block:: console
1109

    
1110
   # apt-get install snf-image snf-pithos-backend python-psycopg2
1111

    
1112
snf-image also needs the `snf-pithos-backend <snf-pithos-backend>`, to be able
1113
to handle image files stored on Pithos. It also needs `python-psycopg2` to be
1114
able to access the Pithos database. This is why, we also install them on *all*
1115
VM-capable Ganeti nodes.
1116

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

    
1122
After `snf-image` has been installed successfully, create the helper VM by
1123
running on *both* nodes:
1124

    
1125
.. code-block:: console
1126

    
1127
   # snf-image-update-helper
1128

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

    
1133
Configuration
1134
~~~~~~~~~~~~~
1135
snf-image supports native access to Images stored on Pithos. This means that
1136
it can talk directly to the Pithos backend, without the need of providing a
1137
public URL. More details, are described in the next section. For now, the only
1138
thing we need to do, is configure snf-image to access our Pithos backend.
1139

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

    
1143
.. code-block:: console
1144

    
1145
    PITHOS_DB="postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos"
1146

    
1147
    PITHOS_DATA="/srv/pithos/data"
1148

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

    
1152
If you would like to use Images that are also/only stored locally, you need to
1153
save them under ``IMAGE_DIR``, however this guide targets Images stored only on
1154
Pithos.
1155

    
1156
Testing
1157
~~~~~~~
1158
You can test that snf-image is successfully installed by running on the
1159
:ref:`GANETI-MASTER <GANETI_NODES>` (in our case node1):
1160

    
1161
.. code-block:: console
1162

    
1163
   # gnt-os diagnose
1164

    
1165
This should return ``valid`` for snf-image.
1166

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

    
1173
.. _snf-image-images:
1174

    
1175
Actual Images for snf-image
1176
---------------------------
1177

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

    
1184
:ref:`snf-image <snf-image>` also supports three (3) different locations for the
1185
above Images to be stored:
1186

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

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

    
1197
To do so, do the following:
1198

    
1199
a) Download the Image from the official snf-image page.
1200

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

    
1205
Once the Image is uploaded successfully, download the Image's metadata file
1206
from the official snf-image page. You will need it, for spawning a VM from
1207
Ganeti, in the next section.
1208

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

    
1213
.. _ganeti-with-pithos-images:
1214

    
1215
Spawning a VM from a Pithos Image, using Ganeti
1216
-----------------------------------------------
1217

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

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

    
1226
.. code-block:: console
1227

    
1228
   # gnt-instance add -o snf-image+default --os-parameters \
1229
                      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"}' \
1230
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1231
                      testvm1
1232

    
1233
In the above command:
1234

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

    
1246
If the ``gnt-instance add`` command returns successfully, then run:
1247

    
1248
.. code-block:: console
1249

    
1250
   # gnt-instance info testvm1 | grep "console connection"
1251

    
1252
to find out where to connect using VNC. If you can connect successfully and can
1253
login to your new instance using the root password ``my_vm_example_passw0rd``,
1254
then everything works as expected and you have your new Debian Base VM up and
1255
running.
1256

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

    
1266
If everything works, you have successfully connected Ganeti with Pithos. Let's
1267
move on to networking now.
1268

    
1269
.. warning::
1270

    
1271
    You can bypass the networking sections and go straight to
1272
    :ref:`Cyclades Ganeti tools <cyclades-gtools>`, if you do not want to setup
1273
    the Cyclades Network Service, but only the Cyclades Compute Service
1274
    (recommended for now).
1275

    
1276
Networking Setup Overview
1277
-------------------------
1278

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

    
1285
Since synnefo 0.11 all network actions are managed with the snf-manage
1286
network-* commands. This needs the underlying setup (Ganeti, nfdhcpd,
1287
snf-network, bridges, vlans) to be already configured correctly. The only
1288
actions needed in this point are:
1289

    
1290
a) Have Ganeti with IP pool management support installed.
1291

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

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

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

    
1300
.. _snf-network:
1301

    
1302
snf-network
1303
~~~~~~~~~~~
1304

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

    
1310
Install snf-network on all Ganeti nodes:
1311

    
1312
.. code-block:: console
1313

    
1314
   # apt-get install snf-network
1315

    
1316
Then, in :file:`/etc/default/snf-network` set:
1317

    
1318
.. code-block:: console
1319

    
1320
   MAC_MASK=ff:ff:f0:00:00:00
1321

    
1322
.. _nfdhcpd:
1323

    
1324
nfdhcpd
1325
~~~~~~~
1326

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

    
1332
.. code-block:: console
1333

    
1334
   # apt-get install nfqueue-bindings-python=0.3+physindev-1
1335
   # apt-get install nfdhcpd
1336

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

    
1342
.. code-block:: console
1343

    
1344
   # /etc/init.d/nfdhcpd restart
1345

    
1346
If you are using ``ferm``, then you need to run the following:
1347

    
1348
.. code-block:: console
1349

    
1350
   # echo "@include 'nfdhcpd.ferm';" >> /etc/ferm/ferm.conf
1351
   # /etc/init.d/ferm restart
1352

    
1353
or make sure to run after boot:
1354

    
1355
.. code-block:: console
1356

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

    
1359
and if you have IPv6 enabled:
1360

    
1361
.. code-block:: console
1362

    
1363
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 133 -j NFQUEUE --queue-num 43
1364
   # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 135 -j NFQUEUE --queue-num 44
1365

    
1366
You can check which clients are currently served by nfdhcpd by running:
1367

    
1368
.. code-block:: console
1369

    
1370
   # kill -SIGUSR1 `cat /var/run/nfdhcpd/nfdhcpd.pid`
1371

    
1372
When you run the above, then check ``/var/log/nfdhcpd/nfdhcpd.log``.
1373

    
1374
Public Network Setup
1375
--------------------
1376

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

    
1383
Physical Host Setup
1384
~~~~~~~~~~~~~~~~~~~
1385

    
1386
Assuming ``eth0`` on both hosts is the public interface (directly connected
1387
to the router), run on every node:
1388

    
1389
.. code-block:: console
1390

    
1391
   # apt-get install vlan
1392
   # brctl addbr br0
1393
   # ip link set br0 up
1394
   # vconfig add eth0 100
1395
   # ip link set eth0.100 up
1396
   # brctl addif br0 eth0.100
1397

    
1398

    
1399
Testing a Public Network
1400
~~~~~~~~~~~~~~~~~~~~~~~~
1401

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

    
1406
.. code-block:: console
1407

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

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

    
1413
.. code-block:: console
1414

    
1415
   # gnt-network connect test-net-public default bridged br0
1416

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

    
1422
.. code-block:: console
1423

    
1424
   # gnt-instance add -o snf-image+default --os-parameters \
1425
                      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"}' \
1426
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1427
                      --net 0:ip=pool,network=test-net-public \
1428
                      testvm2
1429

    
1430
If the above returns successfully, connect to the new VM and run:
1431

    
1432
.. code-block:: console
1433

    
1434
   root@testvm2:~ # ip addr
1435
   root@testvm2:~ # ip route
1436
   root@testvm2:~ # cat /etc/resolv.conf
1437

    
1438
to check IP address (5.6.7.2), IP routes (default via 5.6.7.1) and DNS config
1439
(nameserver option in nfdhcpd.conf). This shows correct configuration of
1440
ganeti, snf-network and nfdhcpd.
1441

    
1442
Now ping the outside world. If this works too, then you have also configured
1443
correctly your physical host and router.
1444

    
1445
Make sure everything works as expected, before proceeding with the Private
1446
Networks setup.
1447

    
1448
.. _private-networks-setup:
1449

    
1450
Private Networks Setup
1451
----------------------
1452

    
1453
Synnefo supports two types of private networks:
1454

    
1455
 - based on MAC filtering
1456
 - based on physical VLANs
1457

    
1458
Both types provide Layer 2 isolation to the end-user.
1459

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

    
1466
Physical Host Setup
1467
~~~~~~~~~~~~~~~~~~~
1468

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

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

    
1476
.. code-block:: console
1477

    
1478
   # modprobe 8021q
1479
   # $iface=eth0
1480
   # for prv in $(seq 0 20); do
1481
        vlan=$prv
1482
        bridge=prv$prv
1483
        vconfig add $iface $vlan
1484
        ifconfig $iface.$vlan up
1485
        brctl addbr $bridge
1486
        brctl setfd $bridge 0
1487
        brctl addif $bridge $iface.$vlan
1488
        ifconfig $bridge up
1489
      done
1490

    
1491
The above will do the following :
1492

    
1493
 * provision 21 new bridges: ``prv0`` - ``prv20``
1494
 * provision 21 new vlans: ``eth0.0`` - ``eth0.20``
1495
 * add the corresponding vlan to the equivalent bridge
1496

    
1497
You can run ``brctl show`` on both nodes to see if everything was setup
1498
correctly.
1499

    
1500
Testing the Private Networks
1501
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1502

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

    
1508
We run the same command as in the Public Network testing section, but with one
1509
more argument for the second NIC:
1510

    
1511
.. code-block:: console
1512

    
1513
   # 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
1514
   # gnt-network connect test-net-prv-mac default bridged prv0
1515

    
1516
   # gnt-network add --network=10.0.0.0/24 --tags=nfdhcpd --network-type=private test-net-prv-vlan
1517
   # gnt-network connect test-net-prv-vlan default bridged prv1
1518

    
1519
   # gnt-instance add -o snf-image+default --os-parameters \
1520
                      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"}' \
1521
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1522
                      --net 0:ip=pool,network=test-net-public \
1523
                      --net 1:ip=pool,network=test-net-prv-mac \
1524
                      --net 2:ip=none,network=test-net-prv-vlan \
1525
                      testvm3
1526

    
1527
   # gnt-instance add -o snf-image+default --os-parameters \
1528
                      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"}' \
1529
                      -t plain --disk 0:size=2G --no-name-check --no-ip-check \
1530
                      --net 0:ip=pool,network=test-net-public \
1531
                      --net 1:ip=pool,network=test-net-prv-mac \
1532
                      --net 2:ip=none,network=test-net-prv-vlan \
1533
                      testvm4
1534

    
1535
Above, we create two instances with first NIC connected to the internet, their
1536
second NIC connected to a MAC filtered private Network and their third NIC
1537
connected to the first Physical VLAN Private Network. Now, connect to the
1538
instances using VNC and make sure everything works as expected:
1539

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

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

    
1545
 c) ip link set ``eth1``/``eth2`` up
1546

    
1547
 d) dhclient ``eth1``/``eth2``
1548

    
1549
 e) On testvm3  ping 192.168.1.2/10.0.0.2
1550

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

    
1554
.. _cyclades-gtools:
1555

    
1556
Cyclades Ganeti tools
1557
---------------------
1558

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

    
1563
.. code-block:: console
1564

    
1565
   # apt-get install snf-cyclades-gtools
1566

    
1567
This will install the following:
1568

    
1569
 * ``snf-ganeti-eventd`` (daemon to publish Ganeti related messages on RabbitMQ)
1570
 * ``snf-ganeti-hook`` (all necessary hooks under ``/etc/ganeti/hooks``)
1571
 * ``snf-progress-monitor`` (used by ``snf-image`` to publish progress messages)
1572

    
1573
Configure ``snf-cyclades-gtools``
1574
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1575

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

    
1580
.. code-block:: console
1581

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

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

    
1587
Connect ``snf-image`` with ``snf-progress-monitor``
1588
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1589

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

    
1594
.. code-block:: console
1595

    
1596
   PROGRESS_MONITOR="snf-progress-monitor"
1597

    
1598
This file should be editted in all Ganeti nodes.
1599

    
1600
.. _rapi-user:
1601

    
1602
Synnefo RAPI user
1603
-----------------
1604

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

    
1610
.. code-block:: console
1611

    
1612
   # echo -n 'cyclades:Ganeti Remote API:example_rapi_passw0rd' | openssl md5
1613

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

    
1616
.. code-block:: console
1617

    
1618
   cyclades {HA1}55aec7050aa4e4b111ca43cb505a61a0 write
1619

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

    
1623
You have now finished with all needed Prerequisites for Cyclades. Let's move on
1624
to the actual Cyclades installation.
1625

    
1626

    
1627
Installation of Cyclades on node1
1628
=================================
1629

    
1630
This section describes the installation of Cyclades. Cyclades is Synnefo's
1631
Compute service. The Image Service will get installed automatically along with
1632
Cyclades, because it is contained in the same Synnefo component.
1633

    
1634
We will install Cyclades on node1. To do so, we install the corresponding
1635
package by running on node1:
1636

    
1637
.. code-block:: console
1638

    
1639
   # apt-get install snf-cyclades-app memcached python-memcache
1640

    
1641
If all packages install successfully, then Cyclades are installed and we
1642
proceed with their configuration.
1643

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

    
1651
Configuration of Cyclades
1652
=========================
1653

    
1654
Conf files
1655
----------
1656

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

    
1664
Edit ``/etc/synnefo/20-snf-cyclades-app-api.conf``:
1665

    
1666
.. code-block:: console
1667

    
1668
   CYCLADES_BASE_URL = 'https://node1.example.com/cyclades'
1669
   ASTAKOS_BASE_URL = 'https://node1.example.com/astakos'
1670

    
1671
   # Set to False if astakos & cyclades are on the same host
1672
   CYCLADES_PROXY_USER_SERVICES = False
1673

    
1674
   CYCLADES_SERVICE_TOKEN = 'cyclades_service_token22w'
1675

    
1676
The ``ASTAKOS_BASE_URL`` denotes the Astakos endpoint for Cyclades,
1677
which is used for all user management, including authentication.
1678
Since our Astakos, Cyclades, and Pithos installations belong together,
1679
they should all have identical ``ASTAKOS_BASE_URL`` setting
1680
(see also, :ref:`previously <conf-pithos>`).
1681

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

    
1685
.. code-block:: console
1686

    
1687
   # snf-manage component-list
1688

    
1689
The token has been generated automatically during the :ref:`Cyclades service
1690
registration <services-reg>`.
1691

    
1692
TODO: Document the Network Options here
1693

    
1694
Edit ``/etc/synnefo/20-snf-cyclades-app-cloudbar.conf``:
1695

    
1696
.. code-block:: console
1697

    
1698
   CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/'
1699
   CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services'
1700
   CLOUDBAR_MENU_URL = 'https://account.node1.example.com/astakos/ui/get_menu'
1701

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

    
1710
Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``:
1711

    
1712
.. code-block:: console
1713

    
1714
   BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
1715
   BACKEND_BLOCK_PATH = '/srv/pithos/data/'
1716

    
1717
In this file we configure the Image Service. ``BACKEND_DB_CONNECTION``
1718
denotes the Pithos database (where the Image files are stored). So we set that
1719
to point to our Pithos database. ``BACKEND_BLOCK_PATH`` denotes the actual
1720
Pithos data location.
1721

    
1722
Edit ``/etc/synnefo/20-snf-cyclades-app-queues.conf``:
1723

    
1724
.. code-block:: console
1725

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

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

    
1732
Edit ``/etc/synnefo/20-snf-cyclades-app-ui.conf``:
1733

    
1734
.. code-block:: console
1735

    
1736
   UI_LOGIN_URL = "https://node1.example.com/ui/login"
1737
   UI_LOGOUT_URL = "https://node1.example.com/ui/logout"
1738

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

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

    
1745
Edit ``/etc/synnefo/20-snf-cyclades-app-vmapi.conf``:
1746

    
1747
.. code-block:: console
1748

    
1749
   VMAPI_CACHE_BACKEND = "memcached://127.0.0.1:11211/?timeout=3600"
1750

    
1751
Edit ``/etc/default/vncauthproxy``:
1752

    
1753
.. code-block:: console
1754

    
1755
   CHUID="nobody:www-data"
1756

    
1757
We have now finished with the basic Cyclades configuration.
1758

    
1759
Database Initialization
1760
-----------------------
1761

    
1762
Once Cyclades is configured, we sync the database:
1763

    
1764
.. code-block:: console
1765

    
1766
   $ snf-manage syncdb
1767
   $ snf-manage migrate
1768

    
1769
and load the initial server flavors:
1770

    
1771
.. code-block:: console
1772

    
1773
   $ snf-manage loaddata flavors
1774

    
1775
If everything returns successfully, our database is ready.
1776

    
1777
Add the Ganeti backend
1778
----------------------
1779

    
1780
In our installation we assume that we only have one Ganeti cluster, the one we
1781
setup earlier.  At this point you have to add this backend (Ganeti cluster) to
1782
cyclades assuming that you have setup the :ref:`Rapi User <rapi-user>`
1783
correctly.
1784

    
1785
.. code-block:: console
1786

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

    
1789
You can see everything has been setup correctly by running:
1790

    
1791
.. code-block:: console
1792

    
1793
   $ snf-manage backend-list
1794

    
1795
Enable the new backend by running:
1796

    
1797
.. code-block::
1798

    
1799
   $ snf-manage backend-modify --drained False 1
1800

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

    
1807
If something is not set correctly, you can modify the backend with the
1808
``snf-manage backend-modify`` command. If something has gone wrong, you could
1809
modify the backend to reflect the Ganeti installation by running:
1810

    
1811
.. code-block:: console
1812

    
1813
   $ snf-manage backend-modify --clustername "ganeti.node1.example.com"
1814
                               --user=cyclades
1815
                               --pass=example_rapi_passw0rd
1816
                               1
1817

    
1818
``clustername`` denotes the Ganeti-cluster's name. We provide the corresponding
1819
domain that resolves to the master IP, than the IP itself, to ensure Cyclades
1820
can talk to Ganeti even after a Ganeti master-failover.
1821

    
1822
``user`` and ``pass`` denote the RAPI user's username and the RAPI user's
1823
password.  Once we setup the first backend to point at our Ganeti cluster, we
1824
update the Cyclades backends status by running:
1825

    
1826
.. code-block:: console
1827

    
1828
   $ snf-manage backend-update-status
1829

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

    
1834
Add a Public Network
1835
----------------------
1836

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

    
1843
.. code-block:: console
1844

    
1845
   $ snf-manage network-create --subnet=5.6.7.0/27 \
1846
                               --gateway=5.6.7.1 \
1847
                               --subnet6=2001:648:2FFC:1322::/64 \
1848
                               --gateway6=2001:648:2FFC:1322::1 \
1849
                               --public --dhcp --flavor=CUSTOM \
1850
                               --link=br0 --mode=bridged \
1851
                               --name=public_network \
1852
                               --backend-id=1
1853

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

    
1857
.. code-block:: console
1858

    
1859
   $ snf-manage reconcile-networks
1860

    
1861
You can see all available networks by running:
1862

    
1863
.. code-block:: console
1864

    
1865
   $ snf-manage network-list
1866

    
1867
and inspect each network's state by running:
1868

    
1869
.. code-block:: console
1870

    
1871
   $ snf-manage network-inspect <net_id>
1872

    
1873
Finally, you can see the networks from the Ganeti perspective by running on the
1874
Ganeti MASTER:
1875

    
1876
.. code-block:: console
1877

    
1878
   $ gnt-network list
1879
   $ gnt-network info <network_name>
1880

    
1881
Create pools for Private Networks
1882
---------------------------------
1883

    
1884
To prevent duplicate assignment of resources to different private networks,
1885
Cyclades supports two types of pools:
1886

    
1887
 - MAC prefix Pool
1888
 - Bridge Pool
1889

    
1890
As long as those resourses have been provisioned, admin has to define two
1891
these pools in Synnefo:
1892

    
1893

    
1894
.. code-block:: console
1895

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

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

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

    
1902
.. code-block:: console
1903

    
1904
   DEFAULT_MAC_FILTERED_BRIDGE = 'prv0'
1905

    
1906
Servers restart
1907
---------------
1908

    
1909
Restart gunicorn on node1:
1910

    
1911
.. code-block:: console
1912

    
1913
   # /etc/init.d/gunicorn restart
1914

    
1915
Now let's do the final connections of Cyclades with Ganeti.
1916

    
1917
``snf-dispatcher`` initialization
1918
---------------------------------
1919

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

    
1925
.. code-block:: console
1926

    
1927
   SNF_DSPTCH_ENABLE=true
1928

    
1929
and start the daemon:
1930

    
1931
.. code-block:: console
1932

    
1933
   # /etc/init.d/snf-dispatcher start
1934

    
1935
You can see that everything works correctly by tailing its log file
1936
``/var/log/synnefo/dispatcher.log``.
1937

    
1938
``snf-ganeti-eventd`` on GANETI MASTER
1939
--------------------------------------
1940

    
1941
The last step of the Cyclades setup is enabling the ``snf-ganeti-eventd``
1942
daemon (part of the :ref:`Cyclades Ganeti tools <cyclades-gtools>` package).
1943
The daemon is already installed on the GANETI MASTER (node1 in our case).
1944
``snf-ganeti-eventd`` is disabled by default during the ``snf-cyclades-gtools``
1945
installation, so we enable it in its configuration file
1946
``/etc/default/snf-ganeti-eventd``:
1947

    
1948
.. code-block:: console
1949

    
1950
   SNF_EVENTD_ENABLE=true
1951

    
1952
and start the daemon:
1953

    
1954
.. code-block:: console
1955

    
1956
   # /etc/init.d/snf-ganeti-eventd start
1957

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

    
1960
Apply Quota
1961
-----------
1962

    
1963
The following commands will check and fix the integrity of user quota.
1964
In a freshly installed system, these commands have no effect and can be
1965
skipped.
1966

    
1967
.. code-block:: console
1968

    
1969
   node1 # snf-manage quota --sync
1970
   node1 # snf-manage reconcile-resources-astakos --fix
1971
   node2 # snf-manage reconcile-resources-pithos --fix
1972
   node1 # snf-manage reconcile-resources-cyclades --fix
1973

    
1974
If all the above return successfully, then you have finished with the Cyclades
1975
installation and setup.
1976

    
1977
Let's test our installation now.
1978

    
1979

    
1980
Testing of Cyclades
1981
===================
1982

    
1983
Cyclades Web UI
1984
---------------
1985

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

    
1990
 `http://node1.example.com/cyclades/ui/`
1991

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

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

    
2002
Cyclades Images
2003
---------------
2004

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

    
2010
 * Upload an Image file to Pithos
2011
 * Register that Image file to Cyclades
2012
 * Spawn a new VM from that Image from the Cyclades Web UI
2013

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

    
2017
Installation of `kamaki`
2018
~~~~~~~~~~~~~~~~~~~~~~~~
2019

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

    
2027
.. code-block:: console
2028

    
2029
   # apt-get install kamaki
2030

    
2031
Configuration of kamaki
2032
~~~~~~~~~~~~~~~~~~~~~~~
2033

    
2034
Now we need to setup kamaki, by adding the appropriate URLs and tokens of our
2035
installation. We do this by running:
2036

    
2037
.. code-block:: console
2038

    
2039
   $ kamaki config set user.url "https://node1.example.com"
2040
   $ kamaki config set compute.url "https://node1.example.com/api/v1.1"
2041
   $ kamaki config set image.url "https://node1.example.com/image"
2042
   $ kamaki config set file.url "https://node2.example.com/v1"
2043
   $ kamaki config set token USER_TOKEN
2044

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

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

    
2050
.. code-block:: console
2051

    
2052
   $ kamaki config list
2053

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

    
2057
.. code-block:: console
2058

    
2059
  $ kamaki user authenticate
2060

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

    
2064
Upload an Image file to Pithos
2065
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2066

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

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

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

    
2079
We create the new ``images`` container by running:
2080

    
2081
.. code-block:: console
2082

    
2083
   $ kamaki file create images
2084

    
2085
To check if the container has been created, list all containers of your
2086
account:
2087

    
2088
.. code-block:: console
2089

    
2090
  $ kamaki file list
2091

    
2092
Then, we upload the Image file to that container:
2093

    
2094
.. code-block:: console
2095

    
2096
   $ kamaki file upload /srv/images/debian_base-6.0-7-x86_64.diskdump images
2097

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

    
2101
.. code-block:: console
2102

    
2103
  $ kamaki file list images
2104

    
2105
Alternatively check if the new container and file appear on the Pithos Web UI.
2106

    
2107
Register an existing Image file to Cyclades
2108
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2109

    
2110
For the purposes of the following example, we assume that the user UUID is
2111
``u53r-un1qu3-1d``.
2112

    
2113
Once the Image file has been successfully uploaded on Pithos then we register
2114
it to Cyclades, by running:
2115

    
2116
.. code-block:: console
2117

    
2118
   $ kamaki image register "Debian Base" \
2119
                           pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump \
2120
                           --public \
2121
                           --disk-format=diskdump \
2122
                           --property OSFAMILY=linux --property ROOT_PARTITION=1 \
2123
                           --property description="Debian Squeeze Base System" \
2124
                           --property size=451 --property kernel=2.6.32 --property GUI="No GUI" \
2125
                           --property sortorder=1 --property USERS=root --property OS=debian
2126

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

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

    
2142
Spawn a VM from the Cyclades Web UI
2143
-----------------------------------
2144

    
2145
If the registration completes successfully, then go to the Cyclades Web UI from
2146
your browser at:
2147

    
2148
 `https://node1.example.com/cyclades/ui/`
2149

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

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

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

    
2166
Congratulations. You have successfully installed the whole Synnefo stack and
2167
connected all components. Go ahead in the next section to test the Network
2168
functionality from inside Cyclades and discover even more features.
2169

    
2170
General Testing
2171
===============
2172

    
2173
Notes
2174
=====
2175