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