root / docs / quick-install-admin-guide.rst @ 7ae4668e
History | View | Annotate | Download (77.2 kB)
1 | bdb83fd6 | cven | .. _quick-install-admin-guide: |
---|---|---|---|
2 | bdb83fd6 | cven | |
3 | 454dca28 | Constantinos Venetsanopoulos | Administrator's Installation Guide |
4 | 454dca28 | Constantinos Venetsanopoulos | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
5 | a96ec00f | Constantinos Venetsanopoulos | |
6 | 454dca28 | Constantinos Venetsanopoulos | This is the Administrator's installation guide. |
7 | a96ec00f | Constantinos Venetsanopoulos | |
8 | a96ec00f | Constantinos Venetsanopoulos | It describes how to install the whole synnefo stack on two (2) physical nodes, |
9 | a96ec00f | Constantinos Venetsanopoulos | with minimum configuration. It installs synnefo from Debian packages, and |
10 | a96ec00f | Constantinos Venetsanopoulos | assumes the nodes run Debian Squeeze. After successful installation, you will |
11 | a96ec00f | Constantinos Venetsanopoulos | have the following services running: |
12 | a96ec00f | Constantinos Venetsanopoulos | |
13 | d587329c | Konstantinos Tompoulidis | * Identity Management (Astakos) |
14 | e5d8df8c | Constantinos Venetsanopoulos | * Object Storage Service (Pithos) |
15 | d587329c | Konstantinos Tompoulidis | * Compute Service (Cyclades) |
16 | 73ebcd68 | Constantinos Venetsanopoulos | * Image Service (part of Cyclades) |
17 | 73ebcd68 | Constantinos Venetsanopoulos | * Network Service (part of Cyclades) |
18 | a96ec00f | Constantinos Venetsanopoulos | |
19 | a96ec00f | Constantinos Venetsanopoulos | and a single unified Web UI to manage them all. |
20 | a96ec00f | Constantinos Venetsanopoulos | |
21 | a96ec00f | Constantinos Venetsanopoulos | The Volume Storage Service (Archipelago) and the Billing Service (Aquarium) are |
22 | a96ec00f | Constantinos Venetsanopoulos | not released yet. |
23 | a96ec00f | Constantinos Venetsanopoulos | |
24 | e5d8df8c | Constantinos Venetsanopoulos | If you just want to install the Object Storage Service (Pithos), follow the |
25 | e5d8df8c | Constantinos Venetsanopoulos | guide and just stop after the "Testing of Pithos" section. |
26 | a96ec00f | Constantinos Venetsanopoulos | |
27 | a96ec00f | Constantinos Venetsanopoulos | |
28 | a96ec00f | Constantinos Venetsanopoulos | Installation of Synnefo / Introduction |
29 | a96ec00f | Constantinos Venetsanopoulos | ====================================== |
30 | a96ec00f | Constantinos Venetsanopoulos | |
31 | 73ebcd68 | Constantinos Venetsanopoulos | We will install the services with the above list's order. The last three |
32 | 73ebcd68 | Constantinos Venetsanopoulos | services will be installed in a single step (at the end), because at the moment |
33 | 73ebcd68 | Constantinos Venetsanopoulos | they are contained in the same software component (Cyclades). Furthermore, we |
34 | e5d8df8c | Constantinos Venetsanopoulos | will install all services in the first physical node, except Pithos which will |
35 | 73ebcd68 | Constantinos Venetsanopoulos | be installed in the second, due to a conflict between the snf-pithos-app and |
36 | 73ebcd68 | Constantinos Venetsanopoulos | snf-cyclades-app component (scheduled to be fixed in the next version). |
37 | a96ec00f | Constantinos Venetsanopoulos | |
38 | a96ec00f | Constantinos Venetsanopoulos | For the rest of the documentation we will refer to the first physical node as |
39 | a96ec00f | Constantinos Venetsanopoulos | "node1" and the second as "node2". We will also assume that their domain names |
40 | a96ec00f | Constantinos Venetsanopoulos | are "node1.example.com" and "node2.example.com" and their IPs are "4.3.2.1" and |
41 | a96ec00f | Constantinos Venetsanopoulos | "4.3.2.2" respectively. |
42 | a96ec00f | Constantinos Venetsanopoulos | |
43 | 04308336 | Ilias Tsitsimpis | .. note:: It is import that the two machines are under the same domain name. |
44 | 04308336 | Ilias Tsitsimpis | If they are not, you can do this by editting the file ``/etc/hosts`` |
45 | 04308336 | Ilias Tsitsimpis | on both machines, and add the following lines: |
46 | 04308336 | Ilias Tsitsimpis | |
47 | 04308336 | Ilias Tsitsimpis | .. code-block:: console |
48 | 04308336 | Ilias Tsitsimpis | |
49 | 04308336 | Ilias Tsitsimpis | 4.3.2.1 node1.example.com |
50 | 04308336 | Ilias Tsitsimpis | 4.3.2.2 node2.example.com |
51 | 04308336 | Ilias Tsitsimpis | |
52 | a96ec00f | Constantinos Venetsanopoulos | |
53 | a96ec00f | Constantinos Venetsanopoulos | General Prerequisites |
54 | a96ec00f | Constantinos Venetsanopoulos | ===================== |
55 | a96ec00f | Constantinos Venetsanopoulos | |
56 | a96ec00f | Constantinos Venetsanopoulos | These are the general synnefo prerequisites, that you need on node1 and node2 |
57 | e5d8df8c | Constantinos Venetsanopoulos | and are related to all the services (Astakos, Pithos, Cyclades). |
58 | a96ec00f | Constantinos Venetsanopoulos | |
59 | a96ec00f | Constantinos Venetsanopoulos | To be able to download all synnefo components you need to add the following |
60 | a96ec00f | Constantinos Venetsanopoulos | lines in your ``/etc/apt/sources.list`` file: |
61 | a96ec00f | Constantinos Venetsanopoulos | |
62 | 8c81d088 | Stratos Psomadakis | | ``deb http://apt.dev.grnet.gr squeeze/`` |
63 | 8c81d088 | Stratos Psomadakis | | ``deb-src http://apt.dev.grnet.gr squeeze/`` |
64 | a96ec00f | Constantinos Venetsanopoulos | |
65 | ec9862dd | Stratos Psomadakis | and import the repo's GPG key: |
66 | ec9862dd | Stratos Psomadakis | |
67 | ec9862dd | Stratos Psomadakis | | ``curl https://dev.grnet.gr/files/apt-grnetdev.pub | apt-key add -`` |
68 | ec9862dd | Stratos Psomadakis | |
69 | 169f7d38 | Vangelis Koukis | Also add the following line to enable the ``squeeze-backports`` repository, |
70 | 169f7d38 | Vangelis Koukis | which may provide more recent versions of certain packages. The repository |
71 | 169f7d38 | Vangelis Koukis | is deactivated by default and must be specified expicitly in ``apt-get`` |
72 | 169f7d38 | Vangelis Koukis | operations: |
73 | 169f7d38 | Vangelis Koukis | |
74 | 169f7d38 | Vangelis Koukis | | ``deb http://backports.debian.org/debian-backports squeeze-backports main`` |
75 | 169f7d38 | Vangelis Koukis | |
76 | e5d8df8c | Constantinos Venetsanopoulos | You also need a shared directory visible by both nodes. Pithos will save all |
77 | a96ec00f | Constantinos Venetsanopoulos | data inside this directory. By 'all data', we mean files, images, and pithos |
78 | a96ec00f | Constantinos Venetsanopoulos | specific mapping data. If you plan to upload more than one basic image, this |
79 | a96ec00f | Constantinos Venetsanopoulos | directory should have at least 50GB of free space. During this guide, we will |
80 | a96ec00f | Constantinos Venetsanopoulos | assume that node1 acts as an NFS server and serves the directory ``/srv/pithos`` |
81 | ba173277 | Ilias Tsitsimpis | to node2 (be sure to set no_root_squash flag). Node2 has this directory |
82 | ba173277 | Ilias Tsitsimpis | mounted under ``/srv/pithos``, too. |
83 | a96ec00f | Constantinos Venetsanopoulos | |
84 | a96ec00f | Constantinos Venetsanopoulos | Before starting the synnefo installation, you will need basic third party |
85 | a96ec00f | Constantinos Venetsanopoulos | software to be installed and configured on the physical nodes. We will describe |
86 | a96ec00f | Constantinos Venetsanopoulos | each node's general prerequisites separately. Any additional configuration, |
87 | a96ec00f | Constantinos Venetsanopoulos | specific to a synnefo service for each node, will be described at the service's |
88 | a96ec00f | Constantinos Venetsanopoulos | section. |
89 | a96ec00f | Constantinos Venetsanopoulos | |
90 | 7df5a742 | Christos Stavrakakis | Finally, it is required for Cyclades and Ganeti nodes to have synchronized |
91 | 7df5a742 | Christos Stavrakakis | system clocks (e.g. by running ntpd). |
92 | 7df5a742 | Christos Stavrakakis | |
93 | a96ec00f | Constantinos Venetsanopoulos | Node1 |
94 | a96ec00f | Constantinos Venetsanopoulos | ----- |
95 | a96ec00f | Constantinos Venetsanopoulos | |
96 | a96ec00f | Constantinos Venetsanopoulos | General Synnefo dependencies |
97 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
98 | a96ec00f | Constantinos Venetsanopoulos | |
99 | d587329c | Konstantinos Tompoulidis | * apache (http server) |
100 | d587329c | Konstantinos Tompoulidis | * gunicorn (WSGI http server) |
101 | d587329c | Konstantinos Tompoulidis | * postgresql (database) |
102 | d587329c | Konstantinos Tompoulidis | * rabbitmq (message queue) |
103 | d587329c | Konstantinos Tompoulidis | * ntp (NTP daemon) |
104 | d587329c | Konstantinos Tompoulidis | * gevent |
105 | a96ec00f | Constantinos Venetsanopoulos | |
106 | 7df5a742 | Christos Stavrakakis | You can install apache2, progresql and ntp by running: |
107 | a96ec00f | Constantinos Venetsanopoulos | |
108 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
109 | a96ec00f | Constantinos Venetsanopoulos | |
110 | 7df5a742 | Christos Stavrakakis | # apt-get install apache2 postgresql ntp |
111 | a96ec00f | Constantinos Venetsanopoulos | |
112 | 73ff1d54 | Constantinos Venetsanopoulos | Make sure to install gunicorn >= v0.12.2. You can do this by installing from |
113 | 73ff1d54 | Constantinos Venetsanopoulos | the official debian backports: |
114 | 73ff1d54 | Constantinos Venetsanopoulos | |
115 | 73ff1d54 | Constantinos Venetsanopoulos | .. code-block:: console |
116 | 73ff1d54 | Constantinos Venetsanopoulos | |
117 | 73ff1d54 | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install gunicorn |
118 | 73ff1d54 | Constantinos Venetsanopoulos | |
119 | 576e059b | Constantinos Venetsanopoulos | Also, make sure to install gevent >= 0.13.6. Again from the debian backports: |
120 | 576e059b | Constantinos Venetsanopoulos | |
121 | 576e059b | Constantinos Venetsanopoulos | .. code-block:: console |
122 | 576e059b | Constantinos Venetsanopoulos | |
123 | 576e059b | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install python-gevent |
124 | 576e059b | Constantinos Venetsanopoulos | |
125 | 73ff1d54 | Constantinos Venetsanopoulos | On node1, we will create our databases, so you will also need the |
126 | 73ff1d54 | Constantinos Venetsanopoulos | python-psycopg2 package: |
127 | a96ec00f | Constantinos Venetsanopoulos | |
128 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
129 | a96ec00f | Constantinos Venetsanopoulos | |
130 | a96ec00f | Constantinos Venetsanopoulos | # apt-get install python-psycopg2 |
131 | a96ec00f | Constantinos Venetsanopoulos | |
132 | 29291ebc | Christos Stavrakakis | To install RabbitMQ>=2.8.4, use the RabbitMQ APT repository by adding the |
133 | 29291ebc | Christos Stavrakakis | following line to ``/etc/apt/sources.list``: |
134 | 29291ebc | Christos Stavrakakis | |
135 | 29291ebc | Christos Stavrakakis | .. code-block:: console |
136 | 29291ebc | Christos Stavrakakis | |
137 | d587329c | Konstantinos Tompoulidis | deb http://www.rabbitmq.com/debian testing main |
138 | 29291ebc | Christos Stavrakakis | |
139 | 29291ebc | Christos Stavrakakis | Add RabbitMQ public key, to trusted key list: |
140 | 29291ebc | Christos Stavrakakis | |
141 | 29291ebc | Christos Stavrakakis | .. code-block:: console |
142 | 29291ebc | Christos Stavrakakis | |
143 | 29291ebc | Christos Stavrakakis | # wget http://www.rabbitmq.com/rabbitmq-signing-key-public.asc |
144 | 29291ebc | Christos Stavrakakis | # apt-key add rabbitmq-signing-key-public.asc |
145 | 29291ebc | Christos Stavrakakis | |
146 | 29291ebc | Christos Stavrakakis | Finally, to install the package run: |
147 | 29291ebc | Christos Stavrakakis | |
148 | 29291ebc | Christos Stavrakakis | .. code-block:: console |
149 | 29291ebc | Christos Stavrakakis | |
150 | 29291ebc | Christos Stavrakakis | # apt-get update |
151 | 29291ebc | Christos Stavrakakis | # apt-get install rabbitmq-server |
152 | 29291ebc | Christos Stavrakakis | |
153 | a96ec00f | Constantinos Venetsanopoulos | Database setup |
154 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
155 | a96ec00f | Constantinos Venetsanopoulos | |
156 | a96ec00f | Constantinos Venetsanopoulos | On node1, we create a database called ``snf_apps``, that will host all django |
157 | a96ec00f | Constantinos Venetsanopoulos | apps related tables. We also create the user ``synnefo`` and grant him all |
158 | a96ec00f | Constantinos Venetsanopoulos | privileges on the database. We do this by running: |
159 | a96ec00f | Constantinos Venetsanopoulos | |
160 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
161 | a96ec00f | Constantinos Venetsanopoulos | |
162 | d587329c | Konstantinos Tompoulidis | root@node1:~ # su - postgres |
163 | d587329c | Konstantinos Tompoulidis | postgres@node1:~ $ psql |
164 | d587329c | Konstantinos Tompoulidis | postgres=# CREATE DATABASE snf_apps WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0; |
165 | d587329c | Konstantinos Tompoulidis | postgres=# CREATE USER synnefo WITH PASSWORD 'example_passw0rd'; |
166 | d587329c | Konstantinos Tompoulidis | postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_apps TO synnefo; |
167 | a96ec00f | Constantinos Venetsanopoulos | |
168 | e5d8df8c | Constantinos Venetsanopoulos | We also create the database ``snf_pithos`` needed by the Pithos backend and |
169 | a96ec00f | Constantinos Venetsanopoulos | grant the ``synnefo`` user all privileges on the database. This database could |
170 | a96ec00f | Constantinos Venetsanopoulos | be created on node2 instead, but we do it on node1 for simplicity. We will |
171 | a96ec00f | Constantinos Venetsanopoulos | create all needed databases on node1 and then node2 will connect to them. |
172 | a96ec00f | Constantinos Venetsanopoulos | |
173 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
174 | a96ec00f | Constantinos Venetsanopoulos | |
175 | d587329c | Konstantinos Tompoulidis | postgres=# CREATE DATABASE snf_pithos WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0; |
176 | d587329c | Konstantinos Tompoulidis | postgres=# GRANT ALL PRIVILEGES ON DATABASE snf_pithos TO synnefo; |
177 | a96ec00f | Constantinos Venetsanopoulos | |
178 | a96ec00f | Constantinos Venetsanopoulos | Configure the database to listen to all network interfaces. You can do this by |
179 | a96ec00f | Constantinos Venetsanopoulos | editting the file ``/etc/postgresql/8.4/main/postgresql.conf`` and change |
180 | a96ec00f | Constantinos Venetsanopoulos | ``listen_addresses`` to ``'*'`` : |
181 | a96ec00f | Constantinos Venetsanopoulos | |
182 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
183 | a96ec00f | Constantinos Venetsanopoulos | |
184 | d587329c | Konstantinos Tompoulidis | listen_addresses = '*' |
185 | a96ec00f | Constantinos Venetsanopoulos | |
186 | a96ec00f | Constantinos Venetsanopoulos | Furthermore, edit ``/etc/postgresql/8.4/main/pg_hba.conf`` to allow node1 and |
187 | a96ec00f | Constantinos Venetsanopoulos | node2 to connect to the database. Add the following lines under ``#IPv4 local |
188 | a96ec00f | Constantinos Venetsanopoulos | connections:`` : |
189 | a96ec00f | Constantinos Venetsanopoulos | |
190 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
191 | a96ec00f | Constantinos Venetsanopoulos | |
192 | d587329c | Konstantinos Tompoulidis | host all all 4.3.2.1/32 md5 |
193 | d587329c | Konstantinos Tompoulidis | host all all 4.3.2.2/32 md5 |
194 | a96ec00f | Constantinos Venetsanopoulos | |
195 | a96ec00f | Constantinos Venetsanopoulos | Make sure to substitute "4.3.2.1" and "4.3.2.2" with node1's and node2's |
196 | a96ec00f | Constantinos Venetsanopoulos | actual IPs. Now, restart the server to apply the changes: |
197 | a96ec00f | Constantinos Venetsanopoulos | |
198 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
199 | a96ec00f | Constantinos Venetsanopoulos | |
200 | a96ec00f | Constantinos Venetsanopoulos | # /etc/init.d/postgresql restart |
201 | a96ec00f | Constantinos Venetsanopoulos | |
202 | a96ec00f | Constantinos Venetsanopoulos | Gunicorn setup |
203 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
204 | a96ec00f | Constantinos Venetsanopoulos | |
205 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/gunicorn.d/synnefo`` containing the following: |
206 | a96ec00f | Constantinos Venetsanopoulos | |
207 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
208 | a96ec00f | Constantinos Venetsanopoulos | |
209 | d587329c | Konstantinos Tompoulidis | CONFIG = { |
210 | d587329c | Konstantinos Tompoulidis | 'mode': 'django', |
211 | d587329c | Konstantinos Tompoulidis | 'environment': { |
212 | d587329c | Konstantinos Tompoulidis | 'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
213 | d587329c | Konstantinos Tompoulidis | }, |
214 | d587329c | Konstantinos Tompoulidis | 'working_dir': '/etc/synnefo', |
215 | d587329c | Konstantinos Tompoulidis | 'user': 'www-data', |
216 | d587329c | Konstantinos Tompoulidis | 'group': 'www-data', |
217 | d587329c | Konstantinos Tompoulidis | 'args': ( |
218 | d587329c | Konstantinos Tompoulidis | '--bind=127.0.0.1:8080', |
219 | d587329c | Konstantinos Tompoulidis | '--worker-class=gevent', |
220 | d587329c | Konstantinos Tompoulidis | '--workers=8', |
221 | d587329c | Konstantinos Tompoulidis | '--log-level=debug', |
222 | d587329c | Konstantinos Tompoulidis | ), |
223 | d587329c | Konstantinos Tompoulidis | } |
224 | a96ec00f | Constantinos Venetsanopoulos | |
225 | 0c40b4ac | Kostas Papadimitriou | .. warning:: Do NOT start the server yet, because it won't find the |
226 | d587329c | Konstantinos Tompoulidis | ``synnefo.settings`` module. Also, in case you are using ``/etc/hosts`` |
227 | d587329c | Konstantinos Tompoulidis | instead of a DNS to get the hostnames, change ``--worker-class=gevent`` to |
228 | d587329c | Konstantinos Tompoulidis | ``--worker-class=sync``. We will start the server after successful |
229 | 4de94e15 | Kostas Papadimitriou | installation of astakos. If the server is running:: |
230 | a96ec00f | Constantinos Venetsanopoulos | |
231 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/gunicorn stop |
232 | a96ec00f | Constantinos Venetsanopoulos | |
233 | a96ec00f | Constantinos Venetsanopoulos | Apache2 setup |
234 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~ |
235 | a96ec00f | Constantinos Venetsanopoulos | |
236 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/apache2/sites-available/synnefo`` containing the |
237 | d587329c | Konstantinos Tompoulidis | following: |
238 | a96ec00f | Constantinos Venetsanopoulos | |
239 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
240 | a96ec00f | Constantinos Venetsanopoulos | |
241 | d587329c | Konstantinos Tompoulidis | <VirtualHost *:80> |
242 | d587329c | Konstantinos Tompoulidis | ServerName node1.example.com |
243 | a96ec00f | Constantinos Venetsanopoulos | |
244 | d587329c | Konstantinos Tompoulidis | RewriteEngine On |
245 | d587329c | Konstantinos Tompoulidis | RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
246 | d587329c | Konstantinos Tompoulidis | RewriteRule ^(.*)$ - [F,L] |
247 | d587329c | Konstantinos Tompoulidis | RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
248 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
249 | a96ec00f | Constantinos Venetsanopoulos | |
250 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/apache2/sites-available/synnefo-ssl`` containing the |
251 | d587329c | Konstantinos Tompoulidis | following: |
252 | a96ec00f | Constantinos Venetsanopoulos | |
253 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
254 | a96ec00f | Constantinos Venetsanopoulos | |
255 | d587329c | Konstantinos Tompoulidis | <IfModule mod_ssl.c> |
256 | d587329c | Konstantinos Tompoulidis | <VirtualHost _default_:443> |
257 | d587329c | Konstantinos Tompoulidis | ServerName node1.example.com |
258 | a96ec00f | Constantinos Venetsanopoulos | |
259 | d587329c | Konstantinos Tompoulidis | Alias /static "/usr/share/synnefo/static" |
260 | a96ec00f | Constantinos Venetsanopoulos | |
261 | d587329c | Konstantinos Tompoulidis | # SetEnv no-gzip |
262 | d587329c | Konstantinos Tompoulidis | # SetEnv dont-vary |
263 | a96ec00f | Constantinos Venetsanopoulos | |
264 | d587329c | Konstantinos Tompoulidis | AllowEncodedSlashes On |
265 | 04427415 | Constantinos Venetsanopoulos | |
266 | d587329c | Konstantinos Tompoulidis | RequestHeader set X-Forwarded-Protocol "https" |
267 | a96ec00f | Constantinos Venetsanopoulos | |
268 | d587329c | Konstantinos Tompoulidis | <Proxy * > |
269 | d587329c | Konstantinos Tompoulidis | Order allow,deny |
270 | d587329c | Konstantinos Tompoulidis | Allow from all |
271 | d587329c | Konstantinos Tompoulidis | </Proxy> |
272 | a96ec00f | Constantinos Venetsanopoulos | |
273 | d587329c | Konstantinos Tompoulidis | SetEnv proxy-sendchunked |
274 | d587329c | Konstantinos Tompoulidis | SSLProxyEngine off |
275 | d587329c | Konstantinos Tompoulidis | ProxyErrorOverride off |
276 | a96ec00f | Constantinos Venetsanopoulos | |
277 | d587329c | Konstantinos Tompoulidis | ProxyPass /static ! |
278 | d587329c | Konstantinos Tompoulidis | ProxyPass / http://localhost:8080/ retry=0 |
279 | d587329c | Konstantinos Tompoulidis | ProxyPassReverse / http://localhost:8080/ |
280 | a96ec00f | Constantinos Venetsanopoulos | |
281 | d587329c | Konstantinos Tompoulidis | RewriteEngine On |
282 | d587329c | Konstantinos Tompoulidis | RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
283 | d587329c | Konstantinos Tompoulidis | RewriteRule ^(.*)$ - [F,L] |
284 | a96ec00f | Constantinos Venetsanopoulos | |
285 | d587329c | Konstantinos Tompoulidis | SSLEngine on |
286 | d587329c | Konstantinos Tompoulidis | SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem |
287 | d587329c | Konstantinos Tompoulidis | SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key |
288 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
289 | d587329c | Konstantinos Tompoulidis | </IfModule> |
290 | a96ec00f | Constantinos Venetsanopoulos | |
291 | a96ec00f | Constantinos Venetsanopoulos | Now enable sites and modules by running: |
292 | a96ec00f | Constantinos Venetsanopoulos | |
293 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
294 | a96ec00f | Constantinos Venetsanopoulos | |
295 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod ssl |
296 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod rewrite |
297 | a96ec00f | Constantinos Venetsanopoulos | # a2dissite default |
298 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo |
299 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo-ssl |
300 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod headers |
301 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod proxy_http |
302 | a96ec00f | Constantinos Venetsanopoulos | |
303 | 4de94e15 | Kostas Papadimitriou | .. warning:: Do NOT start/restart the server yet. If the server is running:: |
304 | a96ec00f | Constantinos Venetsanopoulos | |
305 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/apache2 stop |
306 | a96ec00f | Constantinos Venetsanopoulos | |
307 | 2c85833e | Constantinos Venetsanopoulos | .. _rabbitmq-setup: |
308 | 2c85833e | Constantinos Venetsanopoulos | |
309 | bdfd94c9 | Constantinos Venetsanopoulos | Message Queue setup |
310 | bdfd94c9 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~ |
311 | bdfd94c9 | Constantinos Venetsanopoulos | |
312 | bdfd94c9 | Constantinos Venetsanopoulos | The message queue will run on node1, so we need to create the appropriate |
313 | bdfd94c9 | Constantinos Venetsanopoulos | rabbitmq user. The user is named ``synnefo`` and gets full privileges on all |
314 | bdfd94c9 | Constantinos Venetsanopoulos | exchanges: |
315 | bdfd94c9 | Constantinos Venetsanopoulos | |
316 | bdfd94c9 | Constantinos Venetsanopoulos | .. code-block:: console |
317 | bdfd94c9 | Constantinos Venetsanopoulos | |
318 | 69aa7f21 | Ilias Tsitsimpis | # rabbitmqctl add_user synnefo "example_rabbitmq_passw0rd" |
319 | bdfd94c9 | Constantinos Venetsanopoulos | # rabbitmqctl set_permissions synnefo ".*" ".*" ".*" |
320 | bdfd94c9 | Constantinos Venetsanopoulos | |
321 | bdfd94c9 | Constantinos Venetsanopoulos | We do not need to initialize the exchanges. This will be done automatically, |
322 | bdfd94c9 | Constantinos Venetsanopoulos | during the Cyclades setup. |
323 | bdfd94c9 | Constantinos Venetsanopoulos | |
324 | e5d8df8c | Constantinos Venetsanopoulos | Pithos data directory setup |
325 | e5d8df8c | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
326 | a96ec00f | Constantinos Venetsanopoulos | |
327 | a96ec00f | Constantinos Venetsanopoulos | As mentioned in the General Prerequisites section, there is a directory called |
328 | a96ec00f | Constantinos Venetsanopoulos | ``/srv/pithos`` visible by both nodes. We create and setup the ``data`` |
329 | a96ec00f | Constantinos Venetsanopoulos | directory inside it: |
330 | a96ec00f | Constantinos Venetsanopoulos | |
331 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
332 | a96ec00f | Constantinos Venetsanopoulos | |
333 | a96ec00f | Constantinos Venetsanopoulos | # cd /srv/pithos |
334 | a96ec00f | Constantinos Venetsanopoulos | # mkdir data |
335 | a96ec00f | Constantinos Venetsanopoulos | # chown www-data:www-data data |
336 | a96ec00f | Constantinos Venetsanopoulos | # chmod g+ws data |
337 | a96ec00f | Constantinos Venetsanopoulos | |
338 | a96ec00f | Constantinos Venetsanopoulos | You are now ready with all general prerequisites concerning node1. Let's go to |
339 | a96ec00f | Constantinos Venetsanopoulos | node2. |
340 | a96ec00f | Constantinos Venetsanopoulos | |
341 | a96ec00f | Constantinos Venetsanopoulos | Node2 |
342 | a96ec00f | Constantinos Venetsanopoulos | ----- |
343 | a96ec00f | Constantinos Venetsanopoulos | |
344 | a96ec00f | Constantinos Venetsanopoulos | General Synnefo dependencies |
345 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
346 | a96ec00f | Constantinos Venetsanopoulos | |
347 | d587329c | Konstantinos Tompoulidis | * apache (http server) |
348 | d587329c | Konstantinos Tompoulidis | * gunicorn (WSGI http server) |
349 | d587329c | Konstantinos Tompoulidis | * postgresql (database) |
350 | d587329c | Konstantinos Tompoulidis | * ntp (NTP daemon) |
351 | d587329c | Konstantinos Tompoulidis | * gevent |
352 | a96ec00f | Constantinos Venetsanopoulos | |
353 | a96ec00f | Constantinos Venetsanopoulos | You can install the above by running: |
354 | a96ec00f | Constantinos Venetsanopoulos | |
355 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
356 | a96ec00f | Constantinos Venetsanopoulos | |
357 | 7df5a742 | Christos Stavrakakis | # apt-get install apache2 postgresql ntp |
358 | 73ff1d54 | Constantinos Venetsanopoulos | |
359 | 73ff1d54 | Constantinos Venetsanopoulos | Make sure to install gunicorn >= v0.12.2. You can do this by installing from |
360 | 73ff1d54 | Constantinos Venetsanopoulos | the official debian backports: |
361 | 73ff1d54 | Constantinos Venetsanopoulos | |
362 | 73ff1d54 | Constantinos Venetsanopoulos | .. code-block:: console |
363 | 73ff1d54 | Constantinos Venetsanopoulos | |
364 | 73ff1d54 | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install gunicorn |
365 | a96ec00f | Constantinos Venetsanopoulos | |
366 | 576e059b | Constantinos Venetsanopoulos | Also, make sure to install gevent >= 0.13.6. Again from the debian backports: |
367 | 576e059b | Constantinos Venetsanopoulos | |
368 | 576e059b | Constantinos Venetsanopoulos | .. code-block:: console |
369 | 576e059b | Constantinos Venetsanopoulos | |
370 | 576e059b | Constantinos Venetsanopoulos | # apt-get -t squeeze-backports install python-gevent |
371 | 576e059b | Constantinos Venetsanopoulos | |
372 | 73ff1d54 | Constantinos Venetsanopoulos | Node2 will connect to the databases on node1, so you will also need the |
373 | 73ff1d54 | Constantinos Venetsanopoulos | python-psycopg2 package: |
374 | a96ec00f | Constantinos Venetsanopoulos | |
375 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
376 | a96ec00f | Constantinos Venetsanopoulos | |
377 | a96ec00f | Constantinos Venetsanopoulos | # apt-get install python-psycopg2 |
378 | a96ec00f | Constantinos Venetsanopoulos | |
379 | a96ec00f | Constantinos Venetsanopoulos | Database setup |
380 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
381 | a96ec00f | Constantinos Venetsanopoulos | |
382 | a96ec00f | Constantinos Venetsanopoulos | All databases have been created and setup on node1, so we do not need to take |
383 | a96ec00f | Constantinos Venetsanopoulos | any action here. From node2, we will just connect to them. When you get familiar |
384 | a96ec00f | Constantinos Venetsanopoulos | with the software you may choose to run different databases on different nodes, |
385 | a96ec00f | Constantinos Venetsanopoulos | for performance/scalability/redundancy reasons, but those kind of setups are out |
386 | a96ec00f | Constantinos Venetsanopoulos | of the purpose of this guide. |
387 | a96ec00f | Constantinos Venetsanopoulos | |
388 | a96ec00f | Constantinos Venetsanopoulos | Gunicorn setup |
389 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~ |
390 | a96ec00f | Constantinos Venetsanopoulos | |
391 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/gunicorn.d/synnefo`` containing the following |
392 | a96ec00f | Constantinos Venetsanopoulos | (same contents as in node1; you can just copy/paste the file): |
393 | a96ec00f | Constantinos Venetsanopoulos | |
394 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
395 | a96ec00f | Constantinos Venetsanopoulos | |
396 | d587329c | Konstantinos Tompoulidis | CONFIG = { |
397 | d587329c | Konstantinos Tompoulidis | 'mode': 'django', |
398 | d587329c | Konstantinos Tompoulidis | 'environment': { |
399 | a96ec00f | Constantinos Venetsanopoulos | 'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
400 | d587329c | Konstantinos Tompoulidis | }, |
401 | d587329c | Konstantinos Tompoulidis | 'working_dir': '/etc/synnefo', |
402 | d587329c | Konstantinos Tompoulidis | 'user': 'www-data', |
403 | d587329c | Konstantinos Tompoulidis | 'group': 'www-data', |
404 | d587329c | Konstantinos Tompoulidis | 'args': ( |
405 | d587329c | Konstantinos Tompoulidis | '--bind=127.0.0.1:8080', |
406 | d587329c | Konstantinos Tompoulidis | '--worker-class=gevent', |
407 | d587329c | Konstantinos Tompoulidis | '--workers=4', |
408 | d587329c | Konstantinos Tompoulidis | '--log-level=debug', |
409 | d587329c | Konstantinos Tompoulidis | '--timeout=43200' |
410 | d587329c | Konstantinos Tompoulidis | ), |
411 | d587329c | Konstantinos Tompoulidis | } |
412 | a96ec00f | Constantinos Venetsanopoulos | |
413 | 0c40b4ac | Kostas Papadimitriou | .. warning:: Do NOT start the server yet, because it won't find the |
414 | d587329c | Konstantinos Tompoulidis | ``synnefo.settings`` module. Also, in case you are using ``/etc/hosts`` |
415 | d587329c | Konstantinos Tompoulidis | instead of a DNS to get the hostnames, change ``--worker-class=gevent`` to |
416 | d587329c | Konstantinos Tompoulidis | ``--worker-class=sync``. We will start the server after successful |
417 | 4de94e15 | Kostas Papadimitriou | installation of astakos. If the server is running:: |
418 | a96ec00f | Constantinos Venetsanopoulos | |
419 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/gunicorn stop |
420 | bdb83fd6 | cven | |
421 | a96ec00f | Constantinos Venetsanopoulos | Apache2 setup |
422 | a96ec00f | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~ |
423 | 5b6feb88 | Vangelis Koukis | |
424 | d587329c | Konstantinos Tompoulidis | Create the file ``/etc/apache2/sites-available/synnefo`` containing the |
425 | d587329c | Konstantinos Tompoulidis | following: |
426 | 5b6feb88 | Vangelis Koukis | |
427 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
428 | a96ec00f | Constantinos Venetsanopoulos | |
429 | d587329c | Konstantinos Tompoulidis | <VirtualHost *:80> |
430 | d587329c | Konstantinos Tompoulidis | ServerName node2.example.com |
431 | a96ec00f | Constantinos Venetsanopoulos | |
432 | d587329c | Konstantinos Tompoulidis | RewriteEngine On |
433 | d587329c | Konstantinos Tompoulidis | RewriteCond %{THE_REQUEST} ^.*(\\r|\\n|%0A|%0D).* [NC] |
434 | d587329c | Konstantinos Tompoulidis | RewriteRule ^(.*)$ - [F,L] |
435 | d587329c | Konstantinos Tompoulidis | RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} |
436 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
437 | a96ec00f | Constantinos Venetsanopoulos | |
438 | a96ec00f | Constantinos Venetsanopoulos | Create the file ``synnefo-ssl`` under ``/etc/apache2/sites-available/`` |
439 | a96ec00f | Constantinos Venetsanopoulos | containing the following: |
440 | a96ec00f | Constantinos Venetsanopoulos | |
441 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
442 | a96ec00f | Constantinos Venetsanopoulos | |
443 | d587329c | Konstantinos Tompoulidis | <IfModule mod_ssl.c> |
444 | d587329c | Konstantinos Tompoulidis | <VirtualHost _default_:443> |
445 | d587329c | Konstantinos Tompoulidis | ServerName node2.example.com |
446 | a96ec00f | Constantinos Venetsanopoulos | |
447 | d587329c | Konstantinos Tompoulidis | Alias /static "/usr/share/synnefo/static" |
448 | a96ec00f | Constantinos Venetsanopoulos | |
449 | d587329c | Konstantinos Tompoulidis | SetEnv no-gzip |
450 | d587329c | Konstantinos Tompoulidis | SetEnv dont-vary |
451 | d587329c | Konstantinos Tompoulidis | AllowEncodedSlashes On |
452 | a96ec00f | Constantinos Venetsanopoulos | |
453 | d587329c | Konstantinos Tompoulidis | RequestHeader set X-Forwarded-Protocol "https" |
454 | a96ec00f | Constantinos Venetsanopoulos | |
455 | d587329c | Konstantinos Tompoulidis | <Proxy * > |
456 | d587329c | Konstantinos Tompoulidis | Order allow,deny |
457 | d587329c | Konstantinos Tompoulidis | Allow from all |
458 | d587329c | Konstantinos Tompoulidis | </Proxy> |
459 | a96ec00f | Constantinos Venetsanopoulos | |
460 | d587329c | Konstantinos Tompoulidis | SetEnv proxy-sendchunked |
461 | d587329c | Konstantinos Tompoulidis | SSLProxyEngine off |
462 | d587329c | Konstantinos Tompoulidis | ProxyErrorOverride off |
463 | a96ec00f | Constantinos Venetsanopoulos | |
464 | d587329c | Konstantinos Tompoulidis | ProxyPass /static ! |
465 | d587329c | Konstantinos Tompoulidis | ProxyPass / http://localhost:8080/ retry=0 |
466 | d587329c | Konstantinos Tompoulidis | ProxyPassReverse / http://localhost:8080/ |
467 | a96ec00f | Constantinos Venetsanopoulos | |
468 | d587329c | Konstantinos Tompoulidis | SSLEngine on |
469 | d587329c | Konstantinos Tompoulidis | SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem |
470 | d587329c | Konstantinos Tompoulidis | SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key |
471 | d587329c | Konstantinos Tompoulidis | </VirtualHost> |
472 | d587329c | Konstantinos Tompoulidis | </IfModule> |
473 | a96ec00f | Constantinos Venetsanopoulos | |
474 | a96ec00f | Constantinos Venetsanopoulos | As in node1, enable sites and modules by running: |
475 | a96ec00f | Constantinos Venetsanopoulos | |
476 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
477 | a96ec00f | Constantinos Venetsanopoulos | |
478 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod ssl |
479 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod rewrite |
480 | a96ec00f | Constantinos Venetsanopoulos | # a2dissite default |
481 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo |
482 | a96ec00f | Constantinos Venetsanopoulos | # a2ensite synnefo-ssl |
483 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod headers |
484 | a96ec00f | Constantinos Venetsanopoulos | # a2enmod proxy_http |
485 | a96ec00f | Constantinos Venetsanopoulos | |
486 | 4de94e15 | Kostas Papadimitriou | .. warning:: Do NOT start/restart the server yet. If the server is running:: |
487 | a96ec00f | Constantinos Venetsanopoulos | |
488 | 4de94e15 | Kostas Papadimitriou | # /etc/init.d/apache2 stop |
489 | a96ec00f | Constantinos Venetsanopoulos | |
490 | a96ec00f | Constantinos Venetsanopoulos | We are now ready with all general prerequisites for node2. Now that we have |
491 | a96ec00f | Constantinos Venetsanopoulos | finished with all general prerequisites for both nodes, we can start installing |
492 | a96ec00f | Constantinos Venetsanopoulos | the services. First, let's install Astakos on node1. |
493 | a96ec00f | Constantinos Venetsanopoulos | |
494 | a96ec00f | Constantinos Venetsanopoulos | |
495 | a96ec00f | Constantinos Venetsanopoulos | Installation of Astakos on node1 |
496 | a96ec00f | Constantinos Venetsanopoulos | ================================ |
497 | a96ec00f | Constantinos Venetsanopoulos | |
498 | a96ec00f | Constantinos Venetsanopoulos | To install astakos, grab the package from our repository (make sure you made |
499 | a96ec00f | Constantinos Venetsanopoulos | the additions needed in your ``/etc/apt/sources.list`` file, as described |
500 | a96ec00f | Constantinos Venetsanopoulos | previously), by running: |
501 | a96ec00f | Constantinos Venetsanopoulos | |
502 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
503 | a96ec00f | Constantinos Venetsanopoulos | |
504 | b446c082 | Giorgos Korfiatis | # apt-get install snf-astakos-app snf-pithos-backend |
505 | a96ec00f | Constantinos Venetsanopoulos | |
506 | 04c1254b | Constantinos Venetsanopoulos | .. _conf-astakos: |
507 | 04c1254b | Constantinos Venetsanopoulos | |
508 | a96ec00f | Constantinos Venetsanopoulos | Configuration of Astakos |
509 | a96ec00f | Constantinos Venetsanopoulos | ======================== |
510 | a96ec00f | Constantinos Venetsanopoulos | |
511 | a96ec00f | Constantinos Venetsanopoulos | Conf Files |
512 | a96ec00f | Constantinos Venetsanopoulos | ---------- |
513 | a96ec00f | Constantinos Venetsanopoulos | |
514 | a96ec00f | Constantinos Venetsanopoulos | After astakos is successfully installed, you will find the directory |
515 | a96ec00f | Constantinos Venetsanopoulos | ``/etc/synnefo`` and some configuration files inside it. The files contain |
516 | a96ec00f | Constantinos Venetsanopoulos | commented configuration options, which are the default options. While installing |
517 | a96ec00f | Constantinos Venetsanopoulos | new snf-* components, new configuration files will appear inside the directory. |
518 | a96ec00f | Constantinos Venetsanopoulos | In this guide (and for all services), we will edit only the minimum necessary |
519 | a96ec00f | Constantinos Venetsanopoulos | configuration options, to reflect our setup. Everything else will remain as is. |
520 | a96ec00f | Constantinos Venetsanopoulos | |
521 | a96ec00f | Constantinos Venetsanopoulos | After getting familiar with synnefo, you will be able to customize the software |
522 | a96ec00f | Constantinos Venetsanopoulos | as you wish and fits your needs. Many options are available, to empower the |
523 | a96ec00f | Constantinos Venetsanopoulos | administrator with extensively customizable setups. |
524 | a96ec00f | Constantinos Venetsanopoulos | |
525 | a96ec00f | Constantinos Venetsanopoulos | For the snf-webproject component (installed as an astakos dependency), we |
526 | a96ec00f | Constantinos Venetsanopoulos | need the following: |
527 | a96ec00f | Constantinos Venetsanopoulos | |
528 | a96ec00f | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/10-snf-webproject-database.conf``. You will need to |
529 | a96ec00f | Constantinos Venetsanopoulos | uncomment and edit the ``DATABASES`` block to reflect our database: |
530 | a96ec00f | Constantinos Venetsanopoulos | |
531 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
532 | a96ec00f | Constantinos Venetsanopoulos | |
533 | d587329c | Konstantinos Tompoulidis | DATABASES = { |
534 | d587329c | Konstantinos Tompoulidis | 'default': { |
535 | d587329c | Konstantinos Tompoulidis | # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle' |
536 | d587329c | Konstantinos Tompoulidis | 'ENGINE': 'postgresql_psycopg2', |
537 | a96ec00f | Constantinos Venetsanopoulos | # ATTENTION: This *must* be the absolute path if using sqlite3. |
538 | a96ec00f | Constantinos Venetsanopoulos | # See: http://docs.djangoproject.com/en/dev/ref/settings/#name |
539 | d587329c | Konstantinos Tompoulidis | 'NAME': 'snf_apps', |
540 | d587329c | Konstantinos Tompoulidis | 'USER': 'synnefo', # Not used with sqlite3. |
541 | d587329c | Konstantinos Tompoulidis | 'PASSWORD': 'example_passw0rd', # Not used with sqlite3. |
542 | d587329c | Konstantinos Tompoulidis | # Set to empty string for localhost. Not used with sqlite3. |
543 | d587329c | Konstantinos Tompoulidis | 'HOST': '4.3.2.1', |
544 | d587329c | Konstantinos Tompoulidis | # Set to empty string for default. Not used with sqlite3. |
545 | d587329c | Konstantinos Tompoulidis | 'PORT': '5432', |
546 | d587329c | Konstantinos Tompoulidis | } |
547 | a96ec00f | Constantinos Venetsanopoulos | } |
548 | a96ec00f | Constantinos Venetsanopoulos | |
549 | a96ec00f | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/10-snf-webproject-deploy.conf``. Uncomment and edit |
550 | d587329c | Konstantinos Tompoulidis | ``SECRET_KEY``. This is a Django specific setting which is used to provide a |
551 | a96ec00f | Constantinos Venetsanopoulos | seed in secret-key hashing algorithms. Set this to a random string of your |
552 | a14f152f | Giorgos Korfiatis | choice and keep it private: |
553 | a96ec00f | Constantinos Venetsanopoulos | |
554 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
555 | a96ec00f | Constantinos Venetsanopoulos | |
556 | d587329c | Konstantinos Tompoulidis | SECRET_KEY = 'sy6)mw6a7x%n)-example_secret_key#zzk4jo6f2=uqu!1o%)' |
557 | a96ec00f | Constantinos Venetsanopoulos | |
558 | a96ec00f | Constantinos Venetsanopoulos | For astakos specific configuration, edit the following options in |
559 | 73ff1d54 | Constantinos Venetsanopoulos | ``/etc/synnefo/20-snf-astakos-app-settings.conf`` : |
560 | a96ec00f | Constantinos Venetsanopoulos | |
561 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
562 | a96ec00f | Constantinos Venetsanopoulos | |
563 | d587329c | Konstantinos Tompoulidis | ASTAKOS_COOKIE_DOMAIN = '.example.com' |
564 | a96ec00f | Constantinos Venetsanopoulos | |
565 | a14f152f | Giorgos Korfiatis | ASTAKOS_BASE_URL = 'https://node1.example.com/astakos' |
566 | a96ec00f | Constantinos Venetsanopoulos | |
567 | 4e3e3d24 | Constantinos Venetsanopoulos | The ``ASTAKOS_COOKIE_DOMAIN`` should be the base url of our domain (for all |
568 | 0d87ef78 | Giorgos Korfiatis | services). ``ASTAKOS_BASE_URL`` is the astakos top-level URL. Appending an |
569 | 0d87ef78 | Giorgos Korfiatis | extra path (``/astakos`` here) is recommended in order to distinguish |
570 | 0d87ef78 | Giorgos Korfiatis | components, if more than one are installed on the same machine. |
571 | 5b6feb88 | Vangelis Koukis | |
572 | 4e3e3d24 | Constantinos Venetsanopoulos | .. note:: For the purpose of this guide, we don't enable recaptcha authentication. |
573 | 4e3e3d24 | Constantinos Venetsanopoulos | If you would like to enable it, you have to edit the following options: |
574 | 319b615d | Ilias Tsitsimpis | |
575 | 319b615d | Ilias Tsitsimpis | .. code-block:: console |
576 | 319b615d | Ilias Tsitsimpis | |
577 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_PUBLIC_KEY = 'example_recaptcha_public_key!@#$%^&*(' |
578 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_PRIVATE_KEY = 'example_recaptcha_private_key!@#$%^&*(' |
579 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_USE_SSL = True |
580 | 319b615d | Ilias Tsitsimpis | ASTAKOS_RECAPTCHA_ENABLED = True |
581 | 319b615d | Ilias Tsitsimpis | |
582 | 319b615d | Ilias Tsitsimpis | For the ``ASTAKOS_RECAPTCHA_PUBLIC_KEY`` and ``ASTAKOS_RECAPTCHA_PRIVATE_KEY`` |
583 | 319b615d | Ilias Tsitsimpis | go to https://www.google.com/recaptcha/admin/create and create your own pair. |
584 | 5b6feb88 | Vangelis Koukis | |
585 | 610ff8cf | Constantinos Venetsanopoulos | Then edit ``/etc/synnefo/20-snf-astakos-app-cloudbar.conf`` : |
586 | 610ff8cf | Constantinos Venetsanopoulos | |
587 | 610ff8cf | Constantinos Venetsanopoulos | .. code-block:: console |
588 | 610ff8cf | Constantinos Venetsanopoulos | |
589 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
590 | 610ff8cf | Constantinos Venetsanopoulos | |
591 | a14f152f | Giorgos Korfiatis | CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services' |
592 | 610ff8cf | Constantinos Venetsanopoulos | |
593 | a14f152f | Giorgos Korfiatis | CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu' |
594 | 610ff8cf | Constantinos Venetsanopoulos | |
595 | d587329c | Konstantinos Tompoulidis | Those settings have to do with the black cloudbar endpoints and will be |
596 | d587329c | Konstantinos Tompoulidis | described in more detail later on in this guide. For now, just edit the domain |
597 | d587329c | Konstantinos Tompoulidis | to point at node1 which is where we have installed Astakos. |
598 | 610ff8cf | Constantinos Venetsanopoulos | |
599 | d587329c | Konstantinos Tompoulidis | If you are an advanced user and want to use the Shibboleth Authentication |
600 | d587329c | Konstantinos Tompoulidis | method, read the relative :ref:`section <shibboleth-auth>`. |
601 | d2a9f85f | Sofia Papagiannaki | |
602 | a68c2667 | Kostas Papadimitriou | .. _email-configuration: |
603 | 657f8ad7 | Kostas Papadimitriou | |
604 | 657f8ad7 | Kostas Papadimitriou | Email delivery configuration |
605 | 657f8ad7 | Kostas Papadimitriou | ---------------------------- |
606 | 657f8ad7 | Kostas Papadimitriou | |
607 | 657f8ad7 | Kostas Papadimitriou | Many of the ``astakos`` operations require server to notify service users and |
608 | 657f8ad7 | Kostas Papadimitriou | administrators via email. e.g. right after the signup process the service sents |
609 | 657f8ad7 | Kostas Papadimitriou | an email to the registered email address containing an email verification url, |
610 | 657f8ad7 | Kostas Papadimitriou | after the user verifies the email address astakos once again needs to notify |
611 | 657f8ad7 | Kostas Papadimitriou | administrators with a notice that a new account has just been verified. |
612 | 657f8ad7 | Kostas Papadimitriou | |
613 | 657f8ad7 | Kostas Papadimitriou | More specifically astakos sends emails in the following cases |
614 | 657f8ad7 | Kostas Papadimitriou | |
615 | 657f8ad7 | Kostas Papadimitriou | - An email containing a verification link after each signup process. |
616 | 657f8ad7 | Kostas Papadimitriou | - An email to the people listed in ``ADMINS`` setting after each email |
617 | 657f8ad7 | Kostas Papadimitriou | verification if ``ASTAKOS_MODERATION`` setting is ``True``. The email |
618 | 657f8ad7 | Kostas Papadimitriou | notifies administrators that an additional action is required in order to |
619 | 657f8ad7 | Kostas Papadimitriou | activate the user. |
620 | 657f8ad7 | Kostas Papadimitriou | - A welcome email to the user email and an admin notification to ``ADMINS`` |
621 | 657f8ad7 | Kostas Papadimitriou | right after each account activation. |
622 | 657f8ad7 | Kostas Papadimitriou | - Feedback messages submited from astakos contact view and astakos feedback |
623 | 657f8ad7 | Kostas Papadimitriou | API endpoint are sent to contacts listed in ``HELPDESK`` setting. |
624 | 657f8ad7 | Kostas Papadimitriou | - Project application request notifications to people included in ``HELPDESK`` |
625 | 657f8ad7 | Kostas Papadimitriou | and ``MANAGERS`` settings. |
626 | 657f8ad7 | Kostas Papadimitriou | - Notifications after each project members action (join request, membership |
627 | 657f8ad7 | Kostas Papadimitriou | accepted/declinde etc.) to project members or project owners. |
628 | 657f8ad7 | Kostas Papadimitriou | |
629 | 657f8ad7 | Kostas Papadimitriou | Astakos uses the Django internal email delivering mechanism to send email |
630 | 657f8ad7 | Kostas Papadimitriou | notifications. A simple configuration, using an external smtp server to |
631 | 657f8ad7 | Kostas Papadimitriou | deliver messages, is shown below. |
632 | 657f8ad7 | Kostas Papadimitriou | |
633 | 657f8ad7 | Kostas Papadimitriou | .. code-block:: python |
634 | 657f8ad7 | Kostas Papadimitriou | |
635 | 657f8ad7 | Kostas Papadimitriou | # /etc/synnefo/10-snf-common-admins.conf |
636 | 657f8ad7 | Kostas Papadimitriou | EMAIL_HOST = "mysmtp.server.synnefo.org" |
637 | 657f8ad7 | Kostas Papadimitriou | EMAIL_HOST_USER = "<smtpuser>" |
638 | 657f8ad7 | Kostas Papadimitriou | EMAIL_HOST_PASSWORD = "<smtppassword>" |
639 | 657f8ad7 | Kostas Papadimitriou | |
640 | 657f8ad7 | Kostas Papadimitriou | # this gets appended in all email subjects |
641 | 657f8ad7 | Kostas Papadimitriou | EMAIL_SUBJECT_PREFIX = "[example.synnefo.org] " |
642 | 657f8ad7 | Kostas Papadimitriou | |
643 | 657f8ad7 | Kostas Papadimitriou | # Address to use for outgoing emails |
644 | 657f8ad7 | Kostas Papadimitriou | DEFAULT_FROM_EMAIL = "server@example.synnefo.org" |
645 | 657f8ad7 | Kostas Papadimitriou | |
646 | 657f8ad7 | Kostas Papadimitriou | # Email where users can contact for support. This is used in html/email |
647 | 657f8ad7 | Kostas Papadimitriou | # templates. |
648 | 657f8ad7 | Kostas Papadimitriou | CONTACT_EMAIL = "server@example.synnefo.org" |
649 | 657f8ad7 | Kostas Papadimitriou | |
650 | 657f8ad7 | Kostas Papadimitriou | # The email address that error messages come from |
651 | 657f8ad7 | Kostas Papadimitriou | SERVER_EMAIL = "server-errors@example.synnefo.org" |
652 | 657f8ad7 | Kostas Papadimitriou | |
653 | 657f8ad7 | Kostas Papadimitriou | Notice that since email settings might be required by applications other than |
654 | 657f8ad7 | Kostas Papadimitriou | astakos they are defined in a different configuration file than the one |
655 | 657f8ad7 | Kostas Papadimitriou | previously used to set astakos specific settings. |
656 | 657f8ad7 | Kostas Papadimitriou | |
657 | 657f8ad7 | Kostas Papadimitriou | Refer to |
658 | 657f8ad7 | Kostas Papadimitriou | `Django documentation <https://docs.djangoproject.com/en/1.2/topics/email/>`_ |
659 | 657f8ad7 | Kostas Papadimitriou | for additional information on available email settings. |
660 | 657f8ad7 | Kostas Papadimitriou | |
661 | 657f8ad7 | Kostas Papadimitriou | As refered in the previous section, based on the operation that triggers |
662 | 657f8ad7 | Kostas Papadimitriou | an email notification, the recipients list differs. Specifically for |
663 | 657f8ad7 | Kostas Papadimitriou | emails whose recipients include contacts from your service team |
664 | 657f8ad7 | Kostas Papadimitriou | (administrators, managers, helpdesk etc) synnefo provides the following |
665 | 657f8ad7 | Kostas Papadimitriou | settings located in ``10-snf-common-admins.conf``: |
666 | 657f8ad7 | Kostas Papadimitriou | |
667 | 657f8ad7 | Kostas Papadimitriou | .. code-block:: python |
668 | 657f8ad7 | Kostas Papadimitriou | |
669 | 657f8ad7 | Kostas Papadimitriou | ADMINS = (('Admin name', 'admin@example.synnefo.org'), |
670 | 657f8ad7 | Kostas Papadimitriou | ('Admin2 name', 'admin2@example.synnefo.org)) |
671 | 657f8ad7 | Kostas Papadimitriou | MANAGERS = (('Manager name', 'manager@example.synnefo.org'),) |
672 | 657f8ad7 | Kostas Papadimitriou | HELPDESK = (('Helpdesk user name', 'helpdesk@example.synnefo.org'),) |
673 | 657f8ad7 | Kostas Papadimitriou | |
674 | 657f8ad7 | Kostas Papadimitriou | |
675 | 657f8ad7 | Kostas Papadimitriou | |
676 | 4e3e3d24 | Constantinos Venetsanopoulos | Enable Pooling |
677 | 4e3e3d24 | Constantinos Venetsanopoulos | -------------- |
678 | 4e3e3d24 | Constantinos Venetsanopoulos | |
679 | 4e3e3d24 | Constantinos Venetsanopoulos | This section can be bypassed, but we strongly recommend you apply the following, |
680 | 4e3e3d24 | Constantinos Venetsanopoulos | since they result in a significant performance boost. |
681 | 4e3e3d24 | Constantinos Venetsanopoulos | |
682 | 4e3e3d24 | Constantinos Venetsanopoulos | Synnefo includes a pooling DBAPI driver for PostgreSQL, as a thin wrapper |
683 | 4e3e3d24 | Constantinos Venetsanopoulos | around Psycopg2. This allows independent Django requests to reuse pooled DB |
684 | 4e3e3d24 | Constantinos Venetsanopoulos | connections, with significant performance gains. |
685 | 4e3e3d24 | Constantinos Venetsanopoulos | |
686 | 4e3e3d24 | Constantinos Venetsanopoulos | To use, first monkey-patch psycopg2. For Django, run this before the |
687 | 4e3e3d24 | Constantinos Venetsanopoulos | ``DATABASES`` setting in ``/etc/synnefo/10-snf-webproject-database.conf``: |
688 | 4e3e3d24 | Constantinos Venetsanopoulos | |
689 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
690 | 4e3e3d24 | Constantinos Venetsanopoulos | |
691 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2 |
692 | d587329c | Konstantinos Tompoulidis | monkey_patch_psycopg2() |
693 | 4e3e3d24 | Constantinos Venetsanopoulos | |
694 | 576e059b | Constantinos Venetsanopoulos | Since we are running with greenlets, we should modify psycopg2 behavior, so it |
695 | 576e059b | Constantinos Venetsanopoulos | works properly in a greenlet context: |
696 | 4e3e3d24 | Constantinos Venetsanopoulos | |
697 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
698 | 4e3e3d24 | Constantinos Venetsanopoulos | |
699 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.psyco_gevent import make_psycopg_green |
700 | d587329c | Konstantinos Tompoulidis | make_psycopg_green() |
701 | 4e3e3d24 | Constantinos Venetsanopoulos | |
702 | 4e3e3d24 | Constantinos Venetsanopoulos | Use the Psycopg2 driver as usual. For Django, this means using |
703 | 4e3e3d24 | Constantinos Venetsanopoulos | ``django.db.backends.postgresql_psycopg2`` without any modifications. To enable |
704 | 4e3e3d24 | Constantinos Venetsanopoulos | connection pooling, pass a nonzero ``synnefo_poolsize`` option to the DBAPI |
705 | d587329c | Konstantinos Tompoulidis | driver, through ``DATABASES.OPTIONS`` in Django. |
706 | 4e3e3d24 | Constantinos Venetsanopoulos | |
707 | 4e3e3d24 | Constantinos Venetsanopoulos | All the above will result in an ``/etc/synnefo/10-snf-webproject-database.conf`` |
708 | 4e3e3d24 | Constantinos Venetsanopoulos | file that looks like this: |
709 | 4e3e3d24 | Constantinos Venetsanopoulos | |
710 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
711 | 4e3e3d24 | Constantinos Venetsanopoulos | |
712 | d587329c | Konstantinos Tompoulidis | # Monkey-patch psycopg2 |
713 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.pooled_psycopg2 import monkey_patch_psycopg2 |
714 | d587329c | Konstantinos Tompoulidis | monkey_patch_psycopg2() |
715 | 4e3e3d24 | Constantinos Venetsanopoulos | |
716 | d587329c | Konstantinos Tompoulidis | # If running with greenlets |
717 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.psyco_gevent import make_psycopg_green |
718 | d587329c | Konstantinos Tompoulidis | make_psycopg_green() |
719 | 4e3e3d24 | Constantinos Venetsanopoulos | |
720 | d587329c | Konstantinos Tompoulidis | DATABASES = { |
721 | d587329c | Konstantinos Tompoulidis | 'default': { |
722 | d587329c | Konstantinos Tompoulidis | # 'postgresql_psycopg2', 'postgresql','mysql', 'sqlite3' or 'oracle' |
723 | d587329c | Konstantinos Tompoulidis | 'ENGINE': 'postgresql_psycopg2', |
724 | d587329c | Konstantinos Tompoulidis | 'OPTIONS': {'synnefo_poolsize': 8}, |
725 | 4e3e3d24 | Constantinos Venetsanopoulos | |
726 | 4e3e3d24 | Constantinos Venetsanopoulos | # ATTENTION: This *must* be the absolute path if using sqlite3. |
727 | 4e3e3d24 | Constantinos Venetsanopoulos | # See: http://docs.djangoproject.com/en/dev/ref/settings/#name |
728 | d587329c | Konstantinos Tompoulidis | 'NAME': 'snf_apps', |
729 | d587329c | Konstantinos Tompoulidis | 'USER': 'synnefo', # Not used with sqlite3. |
730 | d587329c | Konstantinos Tompoulidis | 'PASSWORD': 'example_passw0rd', # Not used with sqlite3. |
731 | d587329c | Konstantinos Tompoulidis | # Set to empty string for localhost. Not used with sqlite3. |
732 | d587329c | Konstantinos Tompoulidis | 'HOST': '4.3.2.1', |
733 | d587329c | Konstantinos Tompoulidis | # Set to empty string for default. Not used with sqlite3. |
734 | d587329c | Konstantinos Tompoulidis | 'PORT': '5432', |
735 | d587329c | Konstantinos Tompoulidis | } |
736 | 4e3e3d24 | Constantinos Venetsanopoulos | } |
737 | 5a2d4e43 | Christos Stavrakakis | |
738 | a96ec00f | Constantinos Venetsanopoulos | Database Initialization |
739 | a96ec00f | Constantinos Venetsanopoulos | ----------------------- |
740 | a96ec00f | Constantinos Venetsanopoulos | |
741 | de20a465 | Constantinos Venetsanopoulos | After configuration is done, we initialize the database by running: |
742 | 5b6feb88 | Vangelis Koukis | |
743 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
744 | a96ec00f | Constantinos Venetsanopoulos | |
745 | d587329c | Konstantinos Tompoulidis | # snf-manage syncdb |
746 | a96ec00f | Constantinos Venetsanopoulos | |
747 | a96ec00f | Constantinos Venetsanopoulos | At this example we don't need to create a django superuser, so we select |
748 | a96ec00f | Constantinos Venetsanopoulos | ``[no]`` to the question. After a successful sync, we run the migration needed |
749 | a96ec00f | Constantinos Venetsanopoulos | for astakos: |
750 | 5b6feb88 | Vangelis Koukis | |
751 | 5b6feb88 | Vangelis Koukis | .. code-block:: console |
752 | 5b6feb88 | Vangelis Koukis | |
753 | d587329c | Konstantinos Tompoulidis | # snf-manage migrate im |
754 | b446c082 | Giorgos Korfiatis | # snf-manage migrate quotaholder_app |
755 | a96ec00f | Constantinos Venetsanopoulos | |
756 | de20a465 | Constantinos Venetsanopoulos | Then, we load the pre-defined user groups |
757 | d2a9f85f | Sofia Papagiannaki | |
758 | d2a9f85f | Sofia Papagiannaki | .. code-block:: console |
759 | d2a9f85f | Sofia Papagiannaki | |
760 | d587329c | Konstantinos Tompoulidis | # snf-manage loaddata groups |
761 | d2a9f85f | Sofia Papagiannaki | |
762 | de20a465 | Constantinos Venetsanopoulos | .. _services-reg: |
763 | de20a465 | Constantinos Venetsanopoulos | |
764 | de20a465 | Constantinos Venetsanopoulos | Services Registration |
765 | de20a465 | Constantinos Venetsanopoulos | --------------------- |
766 | de20a465 | Constantinos Venetsanopoulos | |
767 | b446c082 | Giorgos Korfiatis | When the database is ready, we need to register the services. The following |
768 | 3f31a848 | Giorgos Korfiatis | command will ask you to register the standard Synnefo components (astakos, |
769 | 3f31a848 | Giorgos Korfiatis | cyclades, and pithos) along with the services they provide. Note that you |
770 | 3f31a848 | Giorgos Korfiatis | have to register at least astakos in order to have a usable authentication |
771 | 0d87ef78 | Giorgos Korfiatis | system. For each component, you will be asked to provide two URLs: its base |
772 | 0d87ef78 | Giorgos Korfiatis | URL and its UI URL. |
773 | 0d87ef78 | Giorgos Korfiatis | |
774 | 0d87ef78 | Giorgos Korfiatis | The former is the location where the component resides; it should equal |
775 | 0d87ef78 | Giorgos Korfiatis | the ``<component_name>_BASE_URL`` as specified in the respective component |
776 | 0d87ef78 | Giorgos Korfiatis | settings. For example, the base URL for astakos would be |
777 | 0d87ef78 | Giorgos Korfiatis | ``https://node1.example.com/astakos``. |
778 | 0d87ef78 | Giorgos Korfiatis | |
779 | 0d87ef78 | Giorgos Korfiatis | The latter is the URL that appears in the Cloudbar and leads to the |
780 | 0d87ef78 | Giorgos Korfiatis | component UI. If you want to follow the default setup, set |
781 | 0d87ef78 | Giorgos Korfiatis | the UI URL to ``<base_url>/ui/`` where ``base_url`` the component's base |
782 | 0d87ef78 | Giorgos Korfiatis | URL as explained before. (You can later change the UI URL with |
783 | 0d87ef78 | Giorgos Korfiatis | ``snf-manage component-modify <component_name> --url new_ui_url``.) |
784 | 0d87ef78 | Giorgos Korfiatis | |
785 | 0d87ef78 | Giorgos Korfiatis | The command will also register automatically the resource definitions |
786 | 3f31a848 | Giorgos Korfiatis | offered by the services. |
787 | de20a465 | Constantinos Venetsanopoulos | |
788 | de20a465 | Constantinos Venetsanopoulos | .. code-block:: console |
789 | de20a465 | Constantinos Venetsanopoulos | |
790 | b4109758 | Giorgos Korfiatis | # snf-component-register |
791 | 3f31a848 | Giorgos Korfiatis | |
792 | 3f31a848 | Giorgos Korfiatis | .. note:: |
793 | 3f31a848 | Giorgos Korfiatis | |
794 | 3f31a848 | Giorgos Korfiatis | This command is equivalent to running the following series of commands; |
795 | 3f31a848 | Giorgos Korfiatis | it registers the three components in astakos and then in each host it |
796 | 3f31a848 | Giorgos Korfiatis | exports the respective service definitions, copies the exported json file |
797 | 3f31a848 | Giorgos Korfiatis | to the astakos host, where it finally imports it: |
798 | 3f31a848 | Giorgos Korfiatis | |
799 | 3f31a848 | Giorgos Korfiatis | .. code-block:: console |
800 | 3f31a848 | Giorgos Korfiatis | |
801 | 3f31a848 | Giorgos Korfiatis | astakos-host$ snf-manage component-add astakos astakos_ui_url |
802 | 3f31a848 | Giorgos Korfiatis | astakos-host$ snf-manage component-add cyclades cyclades_ui_url |
803 | 3f31a848 | Giorgos Korfiatis | astakos-host$ snf-manage component-add pithos pithos_ui_url |
804 | 3f31a848 | Giorgos Korfiatis | astakos-host$ snf-manage service-export-astakos > astakos.json |
805 | 3f31a848 | Giorgos Korfiatis | astakos-host$ snf-manage service-import --json astakos.json |
806 | 3f31a848 | Giorgos Korfiatis | cyclades-host$ snf-manage service-export-cyclades > cyclades.json |
807 | 3f31a848 | Giorgos Korfiatis | # copy the file to astakos-host |
808 | 3f31a848 | Giorgos Korfiatis | astakos-host$ snf-manage service-import --json cyclades.json |
809 | 3f31a848 | Giorgos Korfiatis | pithos-host$ snf-manage service-export-pithos > pithos.json |
810 | 3f31a848 | Giorgos Korfiatis | # copy the file to astakos-host |
811 | 3f31a848 | Giorgos Korfiatis | astakos-host$ snf-manage service-import --json pithos.json |
812 | b446c082 | Giorgos Korfiatis | |
813 | b446c082 | Giorgos Korfiatis | Setting Default Base Quota for Resources |
814 | b446c082 | Giorgos Korfiatis | ---------------------------------------- |
815 | b446c082 | Giorgos Korfiatis | |
816 | b446c082 | Giorgos Korfiatis | We now have to specify the limit on resources that each user can employ |
817 | b446c082 | Giorgos Korfiatis | (exempting resources offered by projects). |
818 | b446c082 | Giorgos Korfiatis | |
819 | b446c082 | Giorgos Korfiatis | .. code-block:: console |
820 | b446c082 | Giorgos Korfiatis | |
821 | b446c082 | Giorgos Korfiatis | # snf-manage resource-modify --limit-interactive |
822 | b446c082 | Giorgos Korfiatis | |
823 | de20a465 | Constantinos Venetsanopoulos | |
824 | de20a465 | Constantinos Venetsanopoulos | Servers Initialization |
825 | de20a465 | Constantinos Venetsanopoulos | ---------------------- |
826 | de20a465 | Constantinos Venetsanopoulos | |
827 | de20a465 | Constantinos Venetsanopoulos | Finally, we initialize the servers on node1: |
828 | de20a465 | Constantinos Venetsanopoulos | |
829 | de20a465 | Constantinos Venetsanopoulos | .. code-block:: console |
830 | de20a465 | Constantinos Venetsanopoulos | |
831 | d587329c | Konstantinos Tompoulidis | root@node1:~ # /etc/init.d/gunicorn restart |
832 | d587329c | Konstantinos Tompoulidis | root@node1:~ # /etc/init.d/apache2 restart |
833 | de20a465 | Constantinos Venetsanopoulos | |
834 | de20a465 | Constantinos Venetsanopoulos | We have now finished the Astakos setup. Let's test it now. |
835 | a96ec00f | Constantinos Venetsanopoulos | |
836 | a96ec00f | Constantinos Venetsanopoulos | |
837 | a96ec00f | Constantinos Venetsanopoulos | Testing of Astakos |
838 | a96ec00f | Constantinos Venetsanopoulos | ================== |
839 | a96ec00f | Constantinos Venetsanopoulos | |
840 | a96ec00f | Constantinos Venetsanopoulos | Open your favorite browser and go to: |
841 | a96ec00f | Constantinos Venetsanopoulos | |
842 | a14f152f | Giorgos Korfiatis | ``http://node1.example.com/astakos`` |
843 | a96ec00f | Constantinos Venetsanopoulos | |
844 | a14f152f | Giorgos Korfiatis | If this redirects you to ``https://node1.example.com/astakos/ui/`` and you can see |
845 | a96ec00f | Constantinos Venetsanopoulos | the "welcome" door of Astakos, then you have successfully setup Astakos. |
846 | a96ec00f | Constantinos Venetsanopoulos | |
847 | a96ec00f | Constantinos Venetsanopoulos | Let's create our first user. At the homepage click the "CREATE ACCOUNT" button |
848 | a96ec00f | Constantinos Venetsanopoulos | and fill all your data at the sign up form. Then click "SUBMIT". You should now |
849 | a96ec00f | Constantinos Venetsanopoulos | see a green box on the top, which informs you that you made a successful request |
850 | d587329c | Konstantinos Tompoulidis | and the request has been sent to the administrators. So far so good, let's |
851 | d587329c | Konstantinos Tompoulidis | assume that you created the user with username ``user@example.com``. |
852 | a96ec00f | Constantinos Venetsanopoulos | |
853 | a96ec00f | Constantinos Venetsanopoulos | Now we need to activate that user. Return to a command prompt at node1 and run: |
854 | a96ec00f | Constantinos Venetsanopoulos | |
855 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
856 | a96ec00f | Constantinos Venetsanopoulos | |
857 | d587329c | Konstantinos Tompoulidis | root@node1:~ # snf-manage user-list |
858 | a96ec00f | Constantinos Venetsanopoulos | |
859 | a96ec00f | Constantinos Venetsanopoulos | This command should show you a list with only one user; the one we just created. |
860 | a14f152f | Giorgos Korfiatis | This user should have an id with a value of ``1`` and flag "active" and |
861 | a14f152f | Giorgos Korfiatis | "verified" set to False. Now run: |
862 | a96ec00f | Constantinos Venetsanopoulos | |
863 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
864 | a96ec00f | Constantinos Venetsanopoulos | |
865 | a14f152f | Giorgos Korfiatis | root@node1:~ # snf-manage user-modify 1 --verify --accept |
866 | a96ec00f | Constantinos Venetsanopoulos | |
867 | a14f152f | Giorgos Korfiatis | This verifies the user email and activates the user. |
868 | a96ec00f | Constantinos Venetsanopoulos | When running in production, the activation is done automatically with different |
869 | a96ec00f | Constantinos Venetsanopoulos | types of moderation, that Astakos supports. You can see the moderation methods |
870 | a96ec00f | Constantinos Venetsanopoulos | (by invitation, whitelists, matching regexp, etc.) at the Astakos specific |
871 | f846d8df | Constantinos Venetsanopoulos | documentation. In production, you can also manually activate a user, by sending |
872 | f846d8df | Constantinos Venetsanopoulos | him/her an activation email. See how to do this at the :ref:`User |
873 | f846d8df | Constantinos Venetsanopoulos | activation <user_activation>` section. |
874 | a96ec00f | Constantinos Venetsanopoulos | |
875 | a14f152f | Giorgos Korfiatis | Now let's go back to the homepage. Open ``http://node1.example.com/astkos/ui/`` with |
876 | a96ec00f | Constantinos Venetsanopoulos | your browser again. Try to sign in using your new credentials. If the astakos |
877 | a96ec00f | Constantinos Venetsanopoulos | menu appears and you can see your profile, then you have successfully setup |
878 | a96ec00f | Constantinos Venetsanopoulos | Astakos. |
879 | a96ec00f | Constantinos Venetsanopoulos | |
880 | e5d8df8c | Constantinos Venetsanopoulos | Let's continue to install Pithos now. |
881 | a96ec00f | Constantinos Venetsanopoulos | |
882 | a96ec00f | Constantinos Venetsanopoulos | |
883 | e5d8df8c | Constantinos Venetsanopoulos | Installation of Pithos on node2 |
884 | e5d8df8c | Constantinos Venetsanopoulos | =============================== |
885 | a96ec00f | Constantinos Venetsanopoulos | |
886 | e5d8df8c | Constantinos Venetsanopoulos | To install Pithos, grab the packages from our repository (make sure you made |
887 | a96ec00f | Constantinos Venetsanopoulos | the additions needed in your ``/etc/apt/sources.list`` file, as described |
888 | a96ec00f | Constantinos Venetsanopoulos | previously), by running: |
889 | a96ec00f | Constantinos Venetsanopoulos | |
890 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
891 | a96ec00f | Constantinos Venetsanopoulos | |
892 | d587329c | Konstantinos Tompoulidis | # apt-get install snf-pithos-app snf-pithos-backend |
893 | a96ec00f | Constantinos Venetsanopoulos | |
894 | fb5187f9 | Giorgos Korfiatis | Now, install the pithos web interface: |
895 | a96ec00f | Constantinos Venetsanopoulos | |
896 | 138253bc | Constantinos Venetsanopoulos | .. code-block:: console |
897 | 138253bc | Constantinos Venetsanopoulos | |
898 | 138253bc | Constantinos Venetsanopoulos | # apt-get install snf-pithos-webclient |
899 | 138253bc | Constantinos Venetsanopoulos | |
900 | 138253bc | Constantinos Venetsanopoulos | This package provides the standalone pithos web client. The web client is the |
901 | e5d8df8c | Constantinos Venetsanopoulos | web UI for Pithos and will be accessible by clicking "pithos" on the Astakos |
902 | 138253bc | Constantinos Venetsanopoulos | interface's cloudbar, at the top of the Astakos homepage. |
903 | a96ec00f | Constantinos Venetsanopoulos | |
904 | caa6c07d | Constantinos Venetsanopoulos | |
905 | 04c1254b | Constantinos Venetsanopoulos | .. _conf-pithos: |
906 | 04c1254b | Constantinos Venetsanopoulos | |
907 | e5d8df8c | Constantinos Venetsanopoulos | Configuration of Pithos |
908 | e5d8df8c | Constantinos Venetsanopoulos | ======================= |
909 | a96ec00f | Constantinos Venetsanopoulos | |
910 | a96ec00f | Constantinos Venetsanopoulos | Conf Files |
911 | a96ec00f | Constantinos Venetsanopoulos | ---------- |
912 | a96ec00f | Constantinos Venetsanopoulos | |
913 | e5d8df8c | Constantinos Venetsanopoulos | After Pithos is successfully installed, you will find the directory |
914 | a96ec00f | Constantinos Venetsanopoulos | ``/etc/synnefo`` and some configuration files inside it, as you did in node1 |
915 | a96ec00f | Constantinos Venetsanopoulos | after installation of astakos. Here, you will not have to change anything that |
916 | a96ec00f | Constantinos Venetsanopoulos | has to do with snf-common or snf-webproject. Everything is set at node1. You |
917 | e5d8df8c | Constantinos Venetsanopoulos | only need to change settings that have to do with Pithos. Specifically: |
918 | a96ec00f | Constantinos Venetsanopoulos | |
919 | a96ec00f | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-pithos-app-settings.conf``. There you need to set |
920 | 11c16930 | Ilias Tsitsimpis | this options: |
921 | a96ec00f | Constantinos Venetsanopoulos | |
922 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
923 | a96ec00f | Constantinos Venetsanopoulos | |
924 | a14f152f | Giorgos Korfiatis | ASTAKOS_BASE_URL = 'https://node1.example.com/astakos' |
925 | a96ec00f | Constantinos Venetsanopoulos | |
926 | a14f152f | Giorgos Korfiatis | PITHOS_BASE_URL = 'https://node2.example.com/pithos' |
927 | 4ab620b6 | Christos Stavrakakis | PITHOS_BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos' |
928 | a96ec00f | Constantinos Venetsanopoulos | PITHOS_BACKEND_BLOCK_PATH = '/srv/pithos/data' |
929 | bdfd94c9 | Constantinos Venetsanopoulos | |
930 | 26498848 | Giorgos Korfiatis | PITHOS_SERVICE_TOKEN = 'pithos_service_token22w' |
931 | d587329c | Konstantinos Tompoulidis | |
932 | d587329c | Konstantinos Tompoulidis | # Set to False if astakos & pithos are on the same host |
933 | aa28c84c | Georgios D. Tsoukalas | PITHOS_PROXY_USER_SERVICES = True |
934 | 02d94254 | Sofia Papagiannaki | |
935 | 3e6d0710 | Constantinos Venetsanopoulos | |
936 | e5d8df8c | Constantinos Venetsanopoulos | The ``PITHOS_BACKEND_DB_CONNECTION`` option tells to the Pithos app where to |
937 | e5d8df8c | Constantinos Venetsanopoulos | find the Pithos backend database. Above we tell Pithos that its database is |
938 | bdfd94c9 | Constantinos Venetsanopoulos | ``snf_pithos`` at node1 and to connect as user ``synnefo`` with password |
939 | bdfd94c9 | Constantinos Venetsanopoulos | ``example_passw0rd``. All those settings where setup during node1's "Database |
940 | bdfd94c9 | Constantinos Venetsanopoulos | setup" section. |
941 | a96ec00f | Constantinos Venetsanopoulos | |
942 | e5d8df8c | Constantinos Venetsanopoulos | The ``PITHOS_BACKEND_BLOCK_PATH`` option tells to the Pithos app where to find |
943 | e5d8df8c | Constantinos Venetsanopoulos | the Pithos backend data. Above we tell Pithos to store its data under |
944 | a96ec00f | Constantinos Venetsanopoulos | ``/srv/pithos/data``, which is visible by both nodes. We have already setup this |
945 | e5d8df8c | Constantinos Venetsanopoulos | directory at node1's "Pithos data directory setup" section. |
946 | a96ec00f | Constantinos Venetsanopoulos | |
947 | e3ff6830 | Georgios D. Tsoukalas | The ``ASTAKOS_BASE_URL`` option informs the Pithos app where Astakos is. |
948 | e3ff6830 | Georgios D. Tsoukalas | The Astakos service is used for user management (authentication, quotas, etc.) |
949 | 8f85321e | Sofia Papagiannaki | |
950 | a14f152f | Giorgos Korfiatis | The ``PITHOS_BASE_URL`` setting must point to the top-level Pithos URL. |
951 | a14f152f | Giorgos Korfiatis | |
952 | a14f152f | Giorgos Korfiatis | The ``PITHOS_SERVICE_TOKEN`` is the token used for authentication with astakos. |
953 | a14f152f | Giorgos Korfiatis | It can be retrieved by running on the Astakos node (node1 in our case): |
954 | 3e6d0710 | Constantinos Venetsanopoulos | |
955 | 3e6d0710 | Constantinos Venetsanopoulos | .. code-block:: console |
956 | 3e6d0710 | Constantinos Venetsanopoulos | |
957 | a14f152f | Giorgos Korfiatis | # snf-manage component-list |
958 | 3e6d0710 | Constantinos Venetsanopoulos | |
959 | e5d8df8c | Constantinos Venetsanopoulos | The token has been generated automatically during the :ref:`Pithos service |
960 | 3e6d0710 | Constantinos Venetsanopoulos | registration <services-reg>`. |
961 | 3e6d0710 | Constantinos Venetsanopoulos | |
962 | 591e1df0 | Sofia Papagiannaki | The ``PITHOS_UPDATE_MD5`` option by default disables the computation of the |
963 | 591e1df0 | Sofia Papagiannaki | object checksums. This results to improved performance during object uploading. |
964 | 591e1df0 | Sofia Papagiannaki | However, if compatibility with the OpenStack Object Storage API is important |
965 | 591e1df0 | Sofia Papagiannaki | then it should be changed to ``True``. |
966 | 591e1df0 | Sofia Papagiannaki | |
967 | 138253bc | Constantinos Venetsanopoulos | Then edit ``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf``, to connect the |
968 | e5d8df8c | Constantinos Venetsanopoulos | Pithos web UI with the astakos web UI (through the top cloudbar): |
969 | 138253bc | Constantinos Venetsanopoulos | |
970 | 138253bc | Constantinos Venetsanopoulos | .. code-block:: console |
971 | 138253bc | Constantinos Venetsanopoulos | |
972 | d587329c | Konstantinos Tompoulidis | CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
973 | a14f152f | Giorgos Korfiatis | CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services' |
974 | a14f152f | Giorgos Korfiatis | CLOUDBAR_MENU_URL = 'https://node1.example.com/astakos/ui/get_menu' |
975 | 138253bc | Constantinos Venetsanopoulos | |
976 | 138253bc | Constantinos Venetsanopoulos | The ``CLOUDBAR_LOCATION`` tells the client where to find the astakos common |
977 | 138253bc | Constantinos Venetsanopoulos | cloudbar. |
978 | 138253bc | Constantinos Venetsanopoulos | |
979 | 138253bc | Constantinos Venetsanopoulos | The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are used by the |
980 | e5d8df8c | Constantinos Venetsanopoulos | Pithos web client to get from astakos all the information needed to fill its |
981 | bdfd94c9 | Constantinos Venetsanopoulos | own cloudbar. So we put our astakos deployment urls there. |
982 | 138253bc | Constantinos Venetsanopoulos | |
983 | 4e3e3d24 | Constantinos Venetsanopoulos | Pooling and Greenlets |
984 | 4e3e3d24 | Constantinos Venetsanopoulos | --------------------- |
985 | 4e3e3d24 | Constantinos Venetsanopoulos | |
986 | 4e3e3d24 | Constantinos Venetsanopoulos | Pithos is pooling-ready without the need of further configuration, because it |
987 | 4e3e3d24 | Constantinos Venetsanopoulos | doesn't use a Django DB. It pools HTTP connections to Astakos and pithos |
988 | 4e3e3d24 | Constantinos Venetsanopoulos | backend objects for access to the Pithos DB. |
989 | 4e3e3d24 | Constantinos Venetsanopoulos | |
990 | 576e059b | Constantinos Venetsanopoulos | However, as in Astakos, since we are running with Greenlets, it is also |
991 | 576e059b | Constantinos Venetsanopoulos | recommended to modify psycopg2 behavior so it works properly in a greenlet |
992 | 576e059b | Constantinos Venetsanopoulos | context. This means adding the following lines at the top of your |
993 | 4e3e3d24 | Constantinos Venetsanopoulos | ``/etc/synnefo/10-snf-webproject-database.conf`` file: |
994 | 4e3e3d24 | Constantinos Venetsanopoulos | |
995 | 4e3e3d24 | Constantinos Venetsanopoulos | .. code-block:: console |
996 | 4e3e3d24 | Constantinos Venetsanopoulos | |
997 | d587329c | Konstantinos Tompoulidis | from synnefo.lib.db.psyco_gevent import make_psycopg_green |
998 | d587329c | Konstantinos Tompoulidis | make_psycopg_green() |
999 | d587329c | Konstantinos Tompoulidis | |
1000 | d587329c | Konstantinos Tompoulidis | Furthermore, add the ``--worker-class=gevent`` (or ``--worker-class=sync`` as |
1001 | d587329c | Konstantinos Tompoulidis | mentioned above, depending on your setup) argument on your |
1002 | d587329c | Konstantinos Tompoulidis | ``/etc/gunicorn.d/synnefo`` configuration file. The file should look something |
1003 | d587329c | Konstantinos Tompoulidis | like this: |
1004 | d587329c | Konstantinos Tompoulidis | |
1005 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
1006 | d587329c | Konstantinos Tompoulidis | |
1007 | d587329c | Konstantinos Tompoulidis | CONFIG = { |
1008 | d587329c | Konstantinos Tompoulidis | 'mode': 'django', |
1009 | d587329c | Konstantinos Tompoulidis | 'environment': { |
1010 | d587329c | Konstantinos Tompoulidis | 'DJANGO_SETTINGS_MODULE': 'synnefo.settings', |
1011 | d587329c | Konstantinos Tompoulidis | }, |
1012 | d587329c | Konstantinos Tompoulidis | 'working_dir': '/etc/synnefo', |
1013 | d587329c | Konstantinos Tompoulidis | 'user': 'www-data', |
1014 | d587329c | Konstantinos Tompoulidis | 'group': 'www-data', |
1015 | d587329c | Konstantinos Tompoulidis | 'args': ( |
1016 | d587329c | Konstantinos Tompoulidis | '--bind=127.0.0.1:8080', |
1017 | d587329c | Konstantinos Tompoulidis | '--workers=4', |
1018 | d587329c | Konstantinos Tompoulidis | '--worker-class=gevent', |
1019 | d587329c | Konstantinos Tompoulidis | '--log-level=debug', |
1020 | d587329c | Konstantinos Tompoulidis | '--timeout=43200' |
1021 | d587329c | Konstantinos Tompoulidis | ), |
1022 | d587329c | Konstantinos Tompoulidis | } |
1023 | 4e3e3d24 | Constantinos Venetsanopoulos | |
1024 | c17bd3a7 | Sofia Papagiannaki | Stamp Database Revision |
1025 | c17bd3a7 | Sofia Papagiannaki | ----------------------- |
1026 | c17bd3a7 | Sofia Papagiannaki | |
1027 | c17bd3a7 | Sofia Papagiannaki | Pithos uses the alembic_ database migrations tool. |
1028 | c17bd3a7 | Sofia Papagiannaki | |
1029 | c17bd3a7 | Sofia Papagiannaki | .. _alembic: http://alembic.readthedocs.org |
1030 | c17bd3a7 | Sofia Papagiannaki | |
1031 | 61c39121 | Giorgos Korfiatis | After a successful installation, we should stamp it at the most recent |
1032 | a33ee5d2 | Sofia Papagiannaki | revision, so that future migrations know where to start upgrading in |
1033 | a33ee5d2 | Sofia Papagiannaki | the migration history. |
1034 | c17bd3a7 | Sofia Papagiannaki | |
1035 | c17bd3a7 | Sofia Papagiannaki | .. code-block:: console |
1036 | c17bd3a7 | Sofia Papagiannaki | |
1037 | 61c39121 | Giorgos Korfiatis | root@node2:~ # pithos-migrate stamp head |
1038 | c17bd3a7 | Sofia Papagiannaki | |
1039 | a96ec00f | Constantinos Venetsanopoulos | Servers Initialization |
1040 | a96ec00f | Constantinos Venetsanopoulos | ---------------------- |
1041 | a96ec00f | Constantinos Venetsanopoulos | |
1042 | a96ec00f | Constantinos Venetsanopoulos | After configuration is done, we initialize the servers on node2: |
1043 | a96ec00f | Constantinos Venetsanopoulos | |
1044 | a96ec00f | Constantinos Venetsanopoulos | .. code-block:: console |
1045 | a96ec00f | Constantinos Venetsanopoulos | |
1046 | d587329c | Konstantinos Tompoulidis | root@node2:~ # /etc/init.d/gunicorn restart |
1047 | d587329c | Konstantinos Tompoulidis | root@node2:~ # /etc/init.d/apache2 restart |
1048 | a96ec00f | Constantinos Venetsanopoulos | |
1049 | e5d8df8c | Constantinos Venetsanopoulos | You have now finished the Pithos setup. Let's test it now. |
1050 | a96ec00f | Constantinos Venetsanopoulos | |
1051 | a96ec00f | Constantinos Venetsanopoulos | |
1052 | e5d8df8c | Constantinos Venetsanopoulos | Testing of Pithos |
1053 | e5d8df8c | Constantinos Venetsanopoulos | ================= |
1054 | a96ec00f | Constantinos Venetsanopoulos | |
1055 | bdfd94c9 | Constantinos Venetsanopoulos | Open your browser and go to the Astakos homepage: |
1056 | bdfd94c9 | Constantinos Venetsanopoulos | |
1057 | a14f152f | Giorgos Korfiatis | ``http://node1.example.com/astakos`` |
1058 | bdfd94c9 | Constantinos Venetsanopoulos | |
1059 | e5d8df8c | Constantinos Venetsanopoulos | Login, and you will see your profile page. Now, click the "pithos" link on the |
1060 | bdfd94c9 | Constantinos Venetsanopoulos | top black cloudbar. If everything was setup correctly, this will redirect you |
1061 | bdfd94c9 | Constantinos Venetsanopoulos | to: |
1062 | bdfd94c9 | Constantinos Venetsanopoulos | |
1063 | bdfd94c9 | Constantinos Venetsanopoulos | |
1064 | e5d8df8c | Constantinos Venetsanopoulos | and you will see the blue interface of the Pithos application. Click the |
1065 | bdfd94c9 | Constantinos Venetsanopoulos | orange "Upload" button and upload your first file. If the file gets uploaded |
1066 | e5d8df8c | Constantinos Venetsanopoulos | successfully, then this is your first sign of a successful Pithos installation. |
1067 | bdfd94c9 | Constantinos Venetsanopoulos | Go ahead and experiment with the interface to make sure everything works |
1068 | bdfd94c9 | Constantinos Venetsanopoulos | correctly. |
1069 | bdfd94c9 | Constantinos Venetsanopoulos | |
1070 | e5d8df8c | Constantinos Venetsanopoulos | You can also use the Pithos clients to sync data from your Windows PC or MAC. |
1071 | bdfd94c9 | Constantinos Venetsanopoulos | |
1072 | bdfd94c9 | Constantinos Venetsanopoulos | If you don't stumble on any problems, then you have successfully installed |
1073 | e5d8df8c | Constantinos Venetsanopoulos | Pithos, which you can use as a standalone File Storage Service. |
1074 | bdfd94c9 | Constantinos Venetsanopoulos | |
1075 | bdfd94c9 | Constantinos Venetsanopoulos | If you would like to do more, such as: |
1076 | bdfd94c9 | Constantinos Venetsanopoulos | |
1077 | d587329c | Konstantinos Tompoulidis | * Spawning VMs |
1078 | e5d8df8c | Constantinos Venetsanopoulos | * Spawning VMs from Images stored on Pithos |
1079 | e5d8df8c | Constantinos Venetsanopoulos | * Uploading your custom Images to Pithos |
1080 | d587329c | Konstantinos Tompoulidis | * Spawning VMs from those custom Images |
1081 | e5d8df8c | Constantinos Venetsanopoulos | * Registering existing Pithos files as Images |
1082 | d587329c | Konstantinos Tompoulidis | * Connect VMs to the Internet |
1083 | d587329c | Konstantinos Tompoulidis | * Create Private Networks |
1084 | d587329c | Konstantinos Tompoulidis | * Add VMs to Private Networks |
1085 | bdfd94c9 | Constantinos Venetsanopoulos | |
1086 | bdfd94c9 | Constantinos Venetsanopoulos | please continue with the rest of the guide. |
1087 | a96ec00f | Constantinos Venetsanopoulos | |
1088 | caa6c07d | Constantinos Venetsanopoulos | |
1089 | 73ebcd68 | Constantinos Venetsanopoulos | Cyclades Prerequisites |
1090 | 73ebcd68 | Constantinos Venetsanopoulos | ====================== |
1091 | bc055d09 | Constantinos Venetsanopoulos | |
1092 | 73ebcd68 | Constantinos Venetsanopoulos | Before proceeding with the Cyclades installation, make sure you have |
1093 | e5d8df8c | Constantinos Venetsanopoulos | successfully set up Astakos and Pithos first, because Cyclades depends on |
1094 | e5d8df8c | Constantinos Venetsanopoulos | them. If you don't have a working Astakos and Pithos installation yet, please |
1095 | 73ebcd68 | Constantinos Venetsanopoulos | return to the :ref:`top <quick-install-admin-guide>` of this guide. |
1096 | bc055d09 | Constantinos Venetsanopoulos | |
1097 | e5d8df8c | Constantinos Venetsanopoulos | Besides Astakos and Pithos, you will also need a number of additional working |
1098 | caa6c07d | Constantinos Venetsanopoulos | prerequisites, before you start the Cyclades installation. |
1099 | bc055d09 | Constantinos Venetsanopoulos | |
1100 | caa6c07d | Constantinos Venetsanopoulos | Ganeti |
1101 | 7a8df455 | Constantinos Venetsanopoulos | ------ |
1102 | bc055d09 | Constantinos Venetsanopoulos | |
1103 | caa6c07d | Constantinos Venetsanopoulos | `Ganeti <http://code.google.com/p/ganeti/>`_ handles the low level VM management |
1104 | caa6c07d | Constantinos Venetsanopoulos | for Cyclades, so Cyclades requires a working Ganeti installation at the backend. |
1105 | caa6c07d | Constantinos Venetsanopoulos | Please refer to the |
1106 | e332c1fd | Stratos Psomadakis | `ganeti documentation <http://docs.ganeti.org/ganeti/2.6/html>`_ for all the |
1107 | bc055d09 | Constantinos Venetsanopoulos | gory details. A successful Ganeti installation concludes with a working |
1108 | caa6c07d | Constantinos Venetsanopoulos | :ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs |
1109 | caa6c07d | Constantinos Venetsanopoulos | <GANETI_NODES>`. |
1110 | caa6c07d | Constantinos Venetsanopoulos | |
1111 | caa6c07d | Constantinos Venetsanopoulos | The above Ganeti cluster can run on different physical machines than node1 and |
1112 | caa6c07d | Constantinos Venetsanopoulos | node2 and can scale independently, according to your needs. |
1113 | caa6c07d | Constantinos Venetsanopoulos | |
1114 | caa6c07d | Constantinos Venetsanopoulos | For the purpose of this guide, we will assume that the :ref:`GANETI-MASTER |
1115 | caa6c07d | Constantinos Venetsanopoulos | <GANETI_NODES>` runs on node1 and is VM-capable. Also, node2 is a |
1116 | caa6c07d | Constantinos Venetsanopoulos | :ref:`GANETI-NODE <GANETI_NODES>` and is Master-capable and VM-capable too. |
1117 | caa6c07d | Constantinos Venetsanopoulos | |
1118 | caa6c07d | Constantinos Venetsanopoulos | We highly recommend that you read the official Ganeti documentation, if you are |
1119 | 576e059b | Constantinos Venetsanopoulos | not familiar with Ganeti. |
1120 | f1f5235e | Dimitris Aragiorgis | |
1121 | 576e059b | Constantinos Venetsanopoulos | Unfortunatelly, the current stable version of the stock Ganeti (v2.6.2) doesn't |
1122 | 576e059b | Constantinos Venetsanopoulos | support IP pool management. This feature will be available in Ganeti >= 2.7. |
1123 | 576e059b | Constantinos Venetsanopoulos | Synnefo depends on the IP pool functionality of Ganeti, so you have to use |
1124 | 576e059b | Constantinos Venetsanopoulos | GRNET provided packages until stable 2.7 is out. To do so: |
1125 | f1f5235e | Dimitris Aragiorgis | |
1126 | f1f5235e | Dimitris Aragiorgis | .. code-block:: console |
1127 | f1f5235e | Dimitris Aragiorgis | |
1128 | 576e059b | Constantinos Venetsanopoulos | # apt-get install snf-ganeti ganeti-htools |
1129 | d587329c | Konstantinos Tompoulidis | # rmmod -f drbd && modprobe drbd minor_count=255 usermode_helper=/bin/true |
1130 | cc16407a | Dimitris Aragiorgis | |
1131 | 576e059b | Constantinos Venetsanopoulos | You should have: |
1132 | cc16407a | Dimitris Aragiorgis | |
1133 | 576e059b | Constantinos Venetsanopoulos | Ganeti >= 2.6.2+ippool11+hotplug5+extstorage3+rdbfix1+kvmfix2-1 |
1134 | caa6c07d | Constantinos Venetsanopoulos | |
1135 | caa6c07d | Constantinos Venetsanopoulos | We assume that Ganeti will use the KVM hypervisor. After installing Ganeti on |
1136 | 92e4d1c6 | Dimitris Aragiorgis | both nodes, choose a domain name that resolves to a valid floating IP (let's |
1137 | 92e4d1c6 | Dimitris Aragiorgis | say it's ``ganeti.node1.example.com``). Make sure node1 and node2 have same |
1138 | 92e4d1c6 | Dimitris Aragiorgis | dsa/rsa keys and authorised_keys for password-less root ssh between each other. |
1139 | 92e4d1c6 | Dimitris Aragiorgis | If not then skip passing --no-ssh-init but be aware that it will replace |
1140 | 92e4d1c6 | Dimitris Aragiorgis | /root/.ssh/* related files and you might lose access to master node. Also, |
1141 | 92e4d1c6 | Dimitris Aragiorgis | make sure there is an lvm volume group named ``ganeti`` that will host your |
1142 | 92e4d1c6 | Dimitris Aragiorgis | VMs' disks. Finally, setup a bridge interface on the host machines (e.g: br0). |
1143 | 92e4d1c6 | Dimitris Aragiorgis | Then run on node1: |
1144 | caa6c07d | Constantinos Venetsanopoulos | |
1145 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1146 | caa6c07d | Constantinos Venetsanopoulos | |
1147 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster init --enabled-hypervisors=kvm --no-ssh-init \ |
1148 | d587329c | Konstantinos Tompoulidis | --no-etc-hosts --vg-name=ganeti --nic-parameters link=br0 \ |
1149 | d587329c | Konstantinos Tompoulidis | --master-netdev eth0 ganeti.node1.example.com |
1150 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --default-iallocator hail |
1151 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:kernel_path= |
1152 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --hypervisor-parameters kvm:vnc_bind_address=0.0.0.0 |
1153 | caa6c07d | Constantinos Venetsanopoulos | |
1154 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-node add --no-ssh-key-check --master-capable=yes \ |
1155 | d587329c | Konstantinos Tompoulidis | --vm-capable=yes node2.example.com |
1156 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-cluster modify --disk-parameters=drbd:metavg=ganeti |
1157 | d587329c | Konstantinos Tompoulidis | root@node1:~ # gnt-group modify --disk-parameters=drbd:metavg=ganeti default |
1158 | caa6c07d | Constantinos Venetsanopoulos | |
1159 | caa6c07d | Constantinos Venetsanopoulos | For any problems you may stumble upon installing Ganeti, please refer to the |
1160 | e332c1fd | Stratos Psomadakis | `official documentation <http://docs.ganeti.org/ganeti/2.6/html>`_. Installation |
1161 | caa6c07d | Constantinos Venetsanopoulos | of Ganeti is out of the scope of this guide. |
1162 | caa6c07d | Constantinos Venetsanopoulos | |
1163 | caa6c07d | Constantinos Venetsanopoulos | .. _cyclades-install-snfimage: |
1164 | caa6c07d | Constantinos Venetsanopoulos | |
1165 | caa6c07d | Constantinos Venetsanopoulos | snf-image |
1166 | 7a8df455 | Constantinos Venetsanopoulos | --------- |
1167 | caa6c07d | Constantinos Venetsanopoulos | |
1168 | caa6c07d | Constantinos Venetsanopoulos | Installation |
1169 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~ |
1170 | caa6c07d | Constantinos Venetsanopoulos | For :ref:`Cyclades <cyclades>` to be able to launch VMs from specified Images, |
1171 | caa6c07d | Constantinos Venetsanopoulos | you need the :ref:`snf-image <snf-image>` OS Definition installed on *all* |
1172 | caa6c07d | Constantinos Venetsanopoulos | VM-capable Ganeti nodes. This means we need :ref:`snf-image <snf-image>` on |
1173 | caa6c07d | Constantinos Venetsanopoulos | node1 and node2. You can do this by running on *both* nodes: |
1174 | caa6c07d | Constantinos Venetsanopoulos | |
1175 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1176 | caa6c07d | Constantinos Venetsanopoulos | |
1177 | d587329c | Konstantinos Tompoulidis | # apt-get install snf-image snf-pithos-backend python-psycopg2 |
1178 | 1a37da56 | Constantinos Venetsanopoulos | |
1179 | d587329c | Konstantinos Tompoulidis | snf-image also needs the `snf-pithos-backend <snf-pithos-backend>`, to be able |
1180 | e5d8df8c | Constantinos Venetsanopoulos | to handle image files stored on Pithos. It also needs `python-psycopg2` to be |
1181 | e5d8df8c | Constantinos Venetsanopoulos | able to access the Pithos database. This is why, we also install them on *all* |
1182 | 1a37da56 | Constantinos Venetsanopoulos | VM-capable Ganeti nodes. |
1183 | caa6c07d | Constantinos Venetsanopoulos | |
1184 | d587329c | Konstantinos Tompoulidis | .. warning:: snf-image uses ``curl`` for handling URLs. This means that it will |
1185 | d587329c | Konstantinos Tompoulidis | not work out of the box if you try to use URLs served by servers which do |
1186 | d587329c | Konstantinos Tompoulidis | not have a valid certificate. To circumvent this you should edit the file |
1187 | d587329c | Konstantinos Tompoulidis | ``/etc/default/snf-image``. Change ``#CURL="curl"`` to ``CURL="curl -k"``. |
1188 | d587329c | Konstantinos Tompoulidis | |
1189 | d587329c | Konstantinos Tompoulidis | After `snf-image` has been installed successfully, create the helper VM by |
1190 | caa6c07d | Constantinos Venetsanopoulos | running on *both* nodes: |
1191 | caa6c07d | Constantinos Venetsanopoulos | |
1192 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1193 | caa6c07d | Constantinos Venetsanopoulos | |
1194 | caa6c07d | Constantinos Venetsanopoulos | # snf-image-update-helper |
1195 | caa6c07d | Constantinos Venetsanopoulos | |
1196 | caa6c07d | Constantinos Venetsanopoulos | This will create all the needed files under ``/var/lib/snf-image/helper/`` for |
1197 | d587329c | Konstantinos Tompoulidis | snf-image to run successfully, and it may take a few minutes depending on your |
1198 | d587329c | Konstantinos Tompoulidis | Internet connection. |
1199 | caa6c07d | Constantinos Venetsanopoulos | |
1200 | caa6c07d | Constantinos Venetsanopoulos | Configuration |
1201 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~ |
1202 | e5d8df8c | Constantinos Venetsanopoulos | snf-image supports native access to Images stored on Pithos. This means that |
1203 | e5d8df8c | Constantinos Venetsanopoulos | it can talk directly to the Pithos backend, without the need of providing a |
1204 | d587329c | Konstantinos Tompoulidis | public URL. More details, are described in the next section. For now, the only |
1205 | e5d8df8c | Constantinos Venetsanopoulos | thing we need to do, is configure snf-image to access our Pithos backend. |
1206 | caa6c07d | Constantinos Venetsanopoulos | |
1207 | caa6c07d | Constantinos Venetsanopoulos | To do this, we need to set the corresponding variables in |
1208 | e5d8df8c | Constantinos Venetsanopoulos | ``/etc/default/snf-image``, to reflect our Pithos setup: |
1209 | caa6c07d | Constantinos Venetsanopoulos | |
1210 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1211 | caa6c07d | Constantinos Venetsanopoulos | |
1212 | d587329c | Konstantinos Tompoulidis | PITHOS_DB="postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos" |
1213 | caa6c07d | Constantinos Venetsanopoulos | |
1214 | d587329c | Konstantinos Tompoulidis | PITHOS_DATA="/srv/pithos/data" |
1215 | caa6c07d | Constantinos Venetsanopoulos | |
1216 | d587329c | Konstantinos Tompoulidis | If you have installed your Ganeti cluster on different nodes than node1 and |
1217 | d587329c | Konstantinos Tompoulidis | node2 make sure that ``/srv/pithos/data`` is visible by all of them. |
1218 | caa6c07d | Constantinos Venetsanopoulos | |
1219 | caa6c07d | Constantinos Venetsanopoulos | If you would like to use Images that are also/only stored locally, you need to |
1220 | caa6c07d | Constantinos Venetsanopoulos | save them under ``IMAGE_DIR``, however this guide targets Images stored only on |
1221 | e5d8df8c | Constantinos Venetsanopoulos | Pithos. |
1222 | caa6c07d | Constantinos Venetsanopoulos | |
1223 | caa6c07d | Constantinos Venetsanopoulos | Testing |
1224 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~ |
1225 | caa6c07d | Constantinos Venetsanopoulos | You can test that snf-image is successfully installed by running on the |
1226 | caa6c07d | Constantinos Venetsanopoulos | :ref:`GANETI-MASTER <GANETI_NODES>` (in our case node1): |
1227 | caa6c07d | Constantinos Venetsanopoulos | |
1228 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1229 | caa6c07d | Constantinos Venetsanopoulos | |
1230 | caa6c07d | Constantinos Venetsanopoulos | # gnt-os diagnose |
1231 | caa6c07d | Constantinos Venetsanopoulos | |
1232 | caa6c07d | Constantinos Venetsanopoulos | This should return ``valid`` for snf-image. |
1233 | caa6c07d | Constantinos Venetsanopoulos | |
1234 | caa6c07d | Constantinos Venetsanopoulos | If you are interested to learn more about snf-image's internals (and even use |
1235 | caa6c07d | Constantinos Venetsanopoulos | it alongside Ganeti without Synnefo), please see |
1236 | d587329c | Konstantinos Tompoulidis | `here <https://code.grnet.gr/projects/snf-image/wiki>`_ for information |
1237 | d587329c | Konstantinos Tompoulidis | concerning installation instructions, documentation on the design and |
1238 | d587329c | Konstantinos Tompoulidis | implementation, and supported Image formats. |
1239 | caa6c07d | Constantinos Venetsanopoulos | |
1240 | 8a4cd31b | Constantinos Venetsanopoulos | .. _snf-image-images: |
1241 | 8a4cd31b | Constantinos Venetsanopoulos | |
1242 | cd837dad | Constantinos Venetsanopoulos | Actual Images for snf-image |
1243 | cd837dad | Constantinos Venetsanopoulos | --------------------------- |
1244 | caa6c07d | Constantinos Venetsanopoulos | |
1245 | caa6c07d | Constantinos Venetsanopoulos | Now that snf-image is installed successfully we need to provide it with some |
1246 | caa6c07d | Constantinos Venetsanopoulos | Images. :ref:`snf-image <snf-image>` supports Images stored in ``extdump``, |
1247 | caa6c07d | Constantinos Venetsanopoulos | ``ntfsdump`` or ``diskdump`` format. We recommend the use of the ``diskdump`` |
1248 | cd837dad | Constantinos Venetsanopoulos | format. For more information about snf-image Image formats see `here |
1249 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki/Image_Format>`_. |
1250 | caa6c07d | Constantinos Venetsanopoulos | |
1251 | caa6c07d | Constantinos Venetsanopoulos | :ref:`snf-image <snf-image>` also supports three (3) different locations for the |
1252 | caa6c07d | Constantinos Venetsanopoulos | above Images to be stored: |
1253 | caa6c07d | Constantinos Venetsanopoulos | |
1254 | d587329c | Konstantinos Tompoulidis | * Under a local folder (usually an NFS mount, configurable as ``IMAGE_DIR`` |
1255 | d587329c | Konstantinos Tompoulidis | in :file:`/etc/default/snf-image`) |
1256 | d587329c | Konstantinos Tompoulidis | * On a remote host (accessible via public URL e.g: http://... or ftp://...) |
1257 | e5d8df8c | Constantinos Venetsanopoulos | * On Pithos (accessible natively, not only by its public URL) |
1258 | caa6c07d | Constantinos Venetsanopoulos | |
1259 | d587329c | Konstantinos Tompoulidis | For the purpose of this guide, we will use the Debian Squeeze Base Image found |
1260 | d587329c | Konstantinos Tompoulidis | on the official `snf-image page |
1261 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_. The image is |
1262 | e5d8df8c | Constantinos Venetsanopoulos | of type ``diskdump``. We will store it in our new Pithos installation. |
1263 | caa6c07d | Constantinos Venetsanopoulos | |
1264 | caa6c07d | Constantinos Venetsanopoulos | To do so, do the following: |
1265 | caa6c07d | Constantinos Venetsanopoulos | |
1266 | d587329c | Konstantinos Tompoulidis | a) Download the Image from the official snf-image page. |
1267 | caa6c07d | Constantinos Venetsanopoulos | |
1268 | e5d8df8c | Constantinos Venetsanopoulos | b) Upload the Image to your Pithos installation, either using the Pithos Web |
1269 | d587329c | Konstantinos Tompoulidis | UI or the command line client `kamaki |
1270 | 34e79416 | Constantinos Venetsanopoulos | <http://www.synnefo.org/docs/kamaki/latest/index.html>`_. |
1271 | caa6c07d | Constantinos Venetsanopoulos | |
1272 | caa6c07d | Constantinos Venetsanopoulos | Once the Image is uploaded successfully, download the Image's metadata file |
1273 | d587329c | Konstantinos Tompoulidis | from the official snf-image page. You will need it, for spawning a VM from |
1274 | d587329c | Konstantinos Tompoulidis | Ganeti, in the next section. |
1275 | caa6c07d | Constantinos Venetsanopoulos | |
1276 | d587329c | Konstantinos Tompoulidis | Of course, you can repeat the procedure to upload more Images, available from |
1277 | d587329c | Konstantinos Tompoulidis | the `official snf-image page |
1278 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki#Sample-Images>`_. |
1279 | caa6c07d | Constantinos Venetsanopoulos | |
1280 | 8a4cd31b | Constantinos Venetsanopoulos | .. _ganeti-with-pithos-images: |
1281 | 8a4cd31b | Constantinos Venetsanopoulos | |
1282 | e5d8df8c | Constantinos Venetsanopoulos | Spawning a VM from a Pithos Image, using Ganeti |
1283 | e5d8df8c | Constantinos Venetsanopoulos | ----------------------------------------------- |
1284 | caa6c07d | Constantinos Venetsanopoulos | |
1285 | caa6c07d | Constantinos Venetsanopoulos | Now, it is time to test our installation so far. So, we have Astakos and |
1286 | e5d8df8c | Constantinos Venetsanopoulos | Pithos installed, we have a working Ganeti installation, the snf-image |
1287 | caa6c07d | Constantinos Venetsanopoulos | definition installed on all VM-capable nodes and a Debian Squeeze Image on |
1288 | e5d8df8c | Constantinos Venetsanopoulos | Pithos. Make sure you also have the `metadata file |
1289 | caa6c07d | Constantinos Venetsanopoulos | <https://pithos.okeanos.grnet.gr/public/gwqcv>`_ for this image. |
1290 | caa6c07d | Constantinos Venetsanopoulos | |
1291 | caa6c07d | Constantinos Venetsanopoulos | Run on the :ref:`GANETI-MASTER's <GANETI_NODES>` (node1) command line: |
1292 | caa6c07d | Constantinos Venetsanopoulos | |
1293 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1294 | caa6c07d | Constantinos Venetsanopoulos | |
1295 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1296 | d587329c | Konstantinos Tompoulidis | 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"}' \ |
1297 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1298 | caa6c07d | Constantinos Venetsanopoulos | testvm1 |
1299 | caa6c07d | Constantinos Venetsanopoulos | |
1300 | caa6c07d | Constantinos Venetsanopoulos | In the above command: |
1301 | caa6c07d | Constantinos Venetsanopoulos | |
1302 | caa6c07d | Constantinos Venetsanopoulos | * ``img_passwd``: the arbitrary root password of your new instance |
1303 | caa6c07d | Constantinos Venetsanopoulos | * ``img_format``: set to ``diskdump`` to reflect the type of the uploaded Image |
1304 | e5d8df8c | Constantinos Venetsanopoulos | * ``img_id``: If you want to deploy an Image stored on Pithos (our case), this |
1305 | d587329c | Konstantinos Tompoulidis | should have the format ``pithos://<UUID>/<container>/<filename>``: |
1306 | 301294a9 | Constantinos Venetsanopoulos | * ``username``: ``user@example.com`` (defined during Astakos sign up) |
1307 | 301294a9 | Constantinos Venetsanopoulos | * ``container``: ``pithos`` (default, if the Web UI was used) |
1308 | 301294a9 | Constantinos Venetsanopoulos | * ``filename``: the name of file (visible also from the Web UI) |
1309 | caa6c07d | Constantinos Venetsanopoulos | * ``img_properties``: taken from the metadata file. Used only the two mandatory |
1310 | caa6c07d | Constantinos Venetsanopoulos | properties ``OSFAMILY`` and ``ROOT_PARTITION``. `Learn more |
1311 | caa6c07d | Constantinos Venetsanopoulos | <https://code.grnet.gr/projects/snf-image/wiki/Image_Format#Image-Properties>`_ |
1312 | caa6c07d | Constantinos Venetsanopoulos | |
1313 | caa6c07d | Constantinos Venetsanopoulos | If the ``gnt-instance add`` command returns successfully, then run: |
1314 | caa6c07d | Constantinos Venetsanopoulos | |
1315 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1316 | caa6c07d | Constantinos Venetsanopoulos | |
1317 | caa6c07d | Constantinos Venetsanopoulos | # gnt-instance info testvm1 | grep "console connection" |
1318 | caa6c07d | Constantinos Venetsanopoulos | |
1319 | caa6c07d | Constantinos Venetsanopoulos | to find out where to connect using VNC. If you can connect successfully and can |
1320 | caa6c07d | Constantinos Venetsanopoulos | login to your new instance using the root password ``my_vm_example_passw0rd``, |
1321 | caa6c07d | Constantinos Venetsanopoulos | then everything works as expected and you have your new Debian Base VM up and |
1322 | caa6c07d | Constantinos Venetsanopoulos | running. |
1323 | caa6c07d | Constantinos Venetsanopoulos | |
1324 | caa6c07d | Constantinos Venetsanopoulos | If ``gnt-instance add`` fails, make sure that snf-image is correctly configured |
1325 | e5d8df8c | Constantinos Venetsanopoulos | to access the Pithos database and the Pithos backend data (newer versions |
1326 | d587329c | Konstantinos Tompoulidis | require UUID instead of a username). Another issue you may encounter is that in |
1327 | d587329c | Konstantinos Tompoulidis | relatively slow setups, you may need to raise the default HELPER_*_TIMEOUTS in |
1328 | d587329c | Konstantinos Tompoulidis | /etc/default/snf-image. Also, make sure you gave the correct ``img_id`` and |
1329 | d587329c | Konstantinos Tompoulidis | ``img_properties``. If ``gnt-instance add`` succeeds but you cannot connect, |
1330 | d587329c | Konstantinos Tompoulidis | again find out what went wrong. Do *NOT* proceed to the next steps unless you |
1331 | d587329c | Konstantinos Tompoulidis | are sure everything works till this point. |
1332 | caa6c07d | Constantinos Venetsanopoulos | |
1333 | e5d8df8c | Constantinos Venetsanopoulos | If everything works, you have successfully connected Ganeti with Pithos. Let's |
1334 | 2f6143c9 | Constantinos Venetsanopoulos | move on to networking now. |
1335 | caa6c07d | Constantinos Venetsanopoulos | |
1336 | 2f6143c9 | Constantinos Venetsanopoulos | .. warning:: |
1337 | e4404297 | Christos Stavrakakis | |
1338 | 7a8df455 | Constantinos Venetsanopoulos | You can bypass the networking sections and go straight to |
1339 | 2c85833e | Constantinos Venetsanopoulos | :ref:`Cyclades Ganeti tools <cyclades-gtools>`, if you do not want to setup |
1340 | 2c85833e | Constantinos Venetsanopoulos | the Cyclades Network Service, but only the Cyclades Compute Service |
1341 | 2c85833e | Constantinos Venetsanopoulos | (recommended for now). |
1342 | 2f6143c9 | Constantinos Venetsanopoulos | |
1343 | cc16407a | Dimitris Aragiorgis | Networking Setup Overview |
1344 | cc16407a | Dimitris Aragiorgis | ------------------------- |
1345 | 2f6143c9 | Constantinos Venetsanopoulos | |
1346 | 2f6143c9 | Constantinos Venetsanopoulos | This part is deployment-specific and must be customized based on the specific |
1347 | 2f6143c9 | Constantinos Venetsanopoulos | needs of the system administrator. However, to do so, the administrator needs |
1348 | 2f6143c9 | Constantinos Venetsanopoulos | to understand how each level handles Virtual Networks, to be able to setup the |
1349 | b11446c1 | Constantinos Venetsanopoulos | backend appropriately, before installing Cyclades. To do so, please read the |
1350 | b11446c1 | Constantinos Venetsanopoulos | :ref:`Network <networks>` section before proceeding. |
1351 | 2f6143c9 | Constantinos Venetsanopoulos | |
1352 | cc16407a | Dimitris Aragiorgis | Since synnefo 0.11 all network actions are managed with the snf-manage |
1353 | cc16407a | Dimitris Aragiorgis | network-* commands. This needs the underlying setup (Ganeti, nfdhcpd, |
1354 | cc16407a | Dimitris Aragiorgis | snf-network, bridges, vlans) to be already configured correctly. The only |
1355 | cc16407a | Dimitris Aragiorgis | actions needed in this point are: |
1356 | cc16407a | Dimitris Aragiorgis | |
1357 | cc16407a | Dimitris Aragiorgis | a) Have Ganeti with IP pool management support installed. |
1358 | 2f6143c9 | Constantinos Venetsanopoulos | |
1359 | cc16407a | Dimitris Aragiorgis | b) Install :ref:`snf-network <snf-network>`, which provides a synnefo specific kvm-ifup script, etc. |
1360 | 2f6143c9 | Constantinos Venetsanopoulos | |
1361 | cc16407a | Dimitris Aragiorgis | c) Install :ref:`nfdhcpd <nfdhcpd>`, which serves DHCP requests of the VMs. |
1362 | 2f6143c9 | Constantinos Venetsanopoulos | |
1363 | cc16407a | Dimitris Aragiorgis | In order to test that everything is setup correctly before installing Cyclades, |
1364 | cc16407a | Dimitris Aragiorgis | we will make some testing actions in this section, and the actual setup will be |
1365 | cc16407a | Dimitris Aragiorgis | done afterwards with snf-manage commands. |
1366 | 2f6143c9 | Constantinos Venetsanopoulos | |
1367 | cc16407a | Dimitris Aragiorgis | .. _snf-network: |
1368 | 2f6143c9 | Constantinos Venetsanopoulos | |
1369 | cc16407a | Dimitris Aragiorgis | snf-network |
1370 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~ |
1371 | 2f6143c9 | Constantinos Venetsanopoulos | |
1372 | cc16407a | Dimitris Aragiorgis | snf-network includes `kvm-vif-bridge` script that is invoked every time |
1373 | cc16407a | Dimitris Aragiorgis | a tap (a VM's NIC) is created. Based on environment variables passed by |
1374 | cc16407a | Dimitris Aragiorgis | Ganeti it issues various commands depending on the network type the NIC is |
1375 | cc16407a | Dimitris Aragiorgis | connected to and sets up a corresponding dhcp lease. |
1376 | 2f6143c9 | Constantinos Venetsanopoulos | |
1377 | cc16407a | Dimitris Aragiorgis | Install snf-network on all Ganeti nodes: |
1378 | 2f6143c9 | Constantinos Venetsanopoulos | |
1379 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1380 | 2f6143c9 | Constantinos Venetsanopoulos | |
1381 | cc16407a | Dimitris Aragiorgis | # apt-get install snf-network |
1382 | 2f6143c9 | Constantinos Venetsanopoulos | |
1383 | cc16407a | Dimitris Aragiorgis | Then, in :file:`/etc/default/snf-network` set: |
1384 | 2f6143c9 | Constantinos Venetsanopoulos | |
1385 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1386 | 2f6143c9 | Constantinos Venetsanopoulos | |
1387 | cc16407a | Dimitris Aragiorgis | MAC_MASK=ff:ff:f0:00:00:00 |
1388 | 2f6143c9 | Constantinos Venetsanopoulos | |
1389 | cc16407a | Dimitris Aragiorgis | .. _nfdhcpd: |
1390 | 2f6143c9 | Constantinos Venetsanopoulos | |
1391 | cc16407a | Dimitris Aragiorgis | nfdhcpd |
1392 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~ |
1393 | 2f6143c9 | Constantinos Venetsanopoulos | |
1394 | cc16407a | Dimitris Aragiorgis | Each NIC's IP is chosen by Ganeti (with IP pool management support). |
1395 | cc16407a | Dimitris Aragiorgis | `kvm-vif-bridge` script sets up dhcp leases and when the VM boots and |
1396 | cc16407a | Dimitris Aragiorgis | makes a dhcp request, iptables will mangle the packet and `nfdhcpd` will |
1397 | cc16407a | Dimitris Aragiorgis | create a dhcp response. |
1398 | 2f6143c9 | Constantinos Venetsanopoulos | |
1399 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1400 | 2f6143c9 | Constantinos Venetsanopoulos | |
1401 | cc16407a | Dimitris Aragiorgis | # apt-get install nfqueue-bindings-python=0.3+physindev-1 |
1402 | 2f6143c9 | Constantinos Venetsanopoulos | # apt-get install nfdhcpd |
1403 | 2f6143c9 | Constantinos Venetsanopoulos | |
1404 | 2f6143c9 | Constantinos Venetsanopoulos | Edit ``/etc/nfdhcpd/nfdhcpd.conf`` to reflect your network configuration. At |
1405 | 2f6143c9 | Constantinos Venetsanopoulos | least, set the ``dhcp_queue`` variable to ``42`` and the ``nameservers`` |
1406 | 2f6143c9 | Constantinos Venetsanopoulos | variable to your DNS IP/s. Those IPs will be passed as the DNS IP/s of your new |
1407 | 2f6143c9 | Constantinos Venetsanopoulos | VMs. Once you are finished, restart the server on all nodes: |
1408 | 2f6143c9 | Constantinos Venetsanopoulos | |
1409 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1410 | 2f6143c9 | Constantinos Venetsanopoulos | |
1411 | 2f6143c9 | Constantinos Venetsanopoulos | # /etc/init.d/nfdhcpd restart |
1412 | 2f6143c9 | Constantinos Venetsanopoulos | |
1413 | 2f6143c9 | Constantinos Venetsanopoulos | If you are using ``ferm``, then you need to run the following: |
1414 | 2f6143c9 | Constantinos Venetsanopoulos | |
1415 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1416 | 2f6143c9 | Constantinos Venetsanopoulos | |
1417 | 2f6143c9 | Constantinos Venetsanopoulos | # echo "@include 'nfdhcpd.ferm';" >> /etc/ferm/ferm.conf |
1418 | 2f6143c9 | Constantinos Venetsanopoulos | # /etc/init.d/ferm restart |
1419 | 2f6143c9 | Constantinos Venetsanopoulos | |
1420 | cc16407a | Dimitris Aragiorgis | or make sure to run after boot: |
1421 | cc16407a | Dimitris Aragiorgis | |
1422 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1423 | cc16407a | Dimitris Aragiorgis | |
1424 | cc16407a | Dimitris Aragiorgis | # iptables -t mangle -A PREROUTING -p udp -m udp --dport 67 -j NFQUEUE --queue-num 42 |
1425 | cc16407a | Dimitris Aragiorgis | |
1426 | cc16407a | Dimitris Aragiorgis | and if you have IPv6 enabled: |
1427 | cc16407a | Dimitris Aragiorgis | |
1428 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1429 | cc16407a | Dimitris Aragiorgis | |
1430 | cc16407a | Dimitris Aragiorgis | # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 133 -j NFQUEUE --queue-num 43 |
1431 | cc16407a | Dimitris Aragiorgis | # ip6tables -t mangle -A PREROUTING -p ipv6-icmp -m icmp6 --icmpv6-type 135 -j NFQUEUE --queue-num 44 |
1432 | cc16407a | Dimitris Aragiorgis | |
1433 | cc16407a | Dimitris Aragiorgis | You can check which clients are currently served by nfdhcpd by running: |
1434 | cc16407a | Dimitris Aragiorgis | |
1435 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1436 | cc16407a | Dimitris Aragiorgis | |
1437 | cc16407a | Dimitris Aragiorgis | # kill -SIGUSR1 `cat /var/run/nfdhcpd/nfdhcpd.pid` |
1438 | cc16407a | Dimitris Aragiorgis | |
1439 | cc16407a | Dimitris Aragiorgis | When you run the above, then check ``/var/log/nfdhcpd/nfdhcpd.log``. |
1440 | cc16407a | Dimitris Aragiorgis | |
1441 | cc16407a | Dimitris Aragiorgis | Public Network Setup |
1442 | cc16407a | Dimitris Aragiorgis | -------------------- |
1443 | cc16407a | Dimitris Aragiorgis | |
1444 | cc16407a | Dimitris Aragiorgis | To achieve basic networking the simplest way is to have a common bridge (e.g. |
1445 | d587329c | Konstantinos Tompoulidis | ``br0``, on the same collision domain with the router) where all VMs will |
1446 | d587329c | Konstantinos Tompoulidis | connect to. Packets will be "forwarded" to the router and then to the Internet. |
1447 | d587329c | Konstantinos Tompoulidis | If you want a more advanced setup (ip-less routing and proxy-arp plese refer to |
1448 | cc16407a | Dimitris Aragiorgis | :ref:`Network <networks>` section). |
1449 | cc16407a | Dimitris Aragiorgis | |
1450 | cc16407a | Dimitris Aragiorgis | Physical Host Setup |
1451 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~~~~~~~~~ |
1452 | cc16407a | Dimitris Aragiorgis | |
1453 | cc16407a | Dimitris Aragiorgis | Assuming ``eth0`` on both hosts is the public interface (directly connected |
1454 | cc16407a | Dimitris Aragiorgis | to the router), run on every node: |
1455 | 2f6143c9 | Constantinos Venetsanopoulos | |
1456 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1457 | bc7e4f5f | Stratos Psomadakis | |
1458 | d587329c | Konstantinos Tompoulidis | # apt-get install vlan |
1459 | cc16407a | Dimitris Aragiorgis | # brctl addbr br0 |
1460 | cc16407a | Dimitris Aragiorgis | # ip link set br0 up |
1461 | cc16407a | Dimitris Aragiorgis | # vconfig add eth0 100 |
1462 | cc16407a | Dimitris Aragiorgis | # ip link set eth0.100 up |
1463 | cc16407a | Dimitris Aragiorgis | # brctl addif br0 eth0.100 |
1464 | cc16407a | Dimitris Aragiorgis | |
1465 | cc16407a | Dimitris Aragiorgis | |
1466 | cc16407a | Dimitris Aragiorgis | Testing a Public Network |
1467 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~~~~~~~~~~~~~~ |
1468 | cc16407a | Dimitris Aragiorgis | |
1469 | cc16407a | Dimitris Aragiorgis | Let's assume, that you want to assign IPs from the ``5.6.7.0/27`` range to you |
1470 | cc16407a | Dimitris Aragiorgis | new VMs, with ``5.6.7.1`` as the router's gateway. In Ganeti you can add the |
1471 | cc16407a | Dimitris Aragiorgis | network by running: |
1472 | cc16407a | Dimitris Aragiorgis | |
1473 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1474 | cc16407a | Dimitris Aragiorgis | |
1475 | cc16407a | Dimitris Aragiorgis | # gnt-network add --network=5.6.7.0/27 --gateway=5.6.7.1 --network-type=public --tags=nfdhcpd test-net-public |
1476 | 2f6143c9 | Constantinos Venetsanopoulos | |
1477 | cc16407a | Dimitris Aragiorgis | Then, connect the network to all your nodegroups. We assume that we only have |
1478 | cc16407a | Dimitris Aragiorgis | one nodegroup (``default``) in our Ganeti cluster: |
1479 | cc16407a | Dimitris Aragiorgis | |
1480 | cc16407a | Dimitris Aragiorgis | .. code-block:: console |
1481 | cc16407a | Dimitris Aragiorgis | |
1482 | cc16407a | Dimitris Aragiorgis | # gnt-network connect test-net-public default bridged br0 |
1483 | 2f6143c9 | Constantinos Venetsanopoulos | |
1484 | 2f6143c9 | Constantinos Venetsanopoulos | Now, it is time to test that the backend infrastracture is correctly setup for |
1485 | cc16407a | Dimitris Aragiorgis | the Public Network. We will add a new VM, the same way we did it on the |
1486 | cc16407a | Dimitris Aragiorgis | previous testing section. However, now will also add one NIC, configured to be |
1487 | cc16407a | Dimitris Aragiorgis | managed from our previously defined network. Run on the GANETI-MASTER (node1): |
1488 | 2f6143c9 | Constantinos Venetsanopoulos | |
1489 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1490 | 2f6143c9 | Constantinos Venetsanopoulos | |
1491 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1492 | d587329c | Konstantinos Tompoulidis | 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"}' \ |
1493 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1494 | cc16407a | Dimitris Aragiorgis | --net 0:ip=pool,network=test-net-public \ |
1495 | 2f6143c9 | Constantinos Venetsanopoulos | testvm2 |
1496 | 2f6143c9 | Constantinos Venetsanopoulos | |
1497 | 2f6143c9 | Constantinos Venetsanopoulos | If the above returns successfully, connect to the new VM and run: |
1498 | 2f6143c9 | Constantinos Venetsanopoulos | |
1499 | 2f6143c9 | Constantinos Venetsanopoulos | .. code-block:: console |
1500 | 2f6143c9 | Constantinos Venetsanopoulos | |
1501 | cc16407a | Dimitris Aragiorgis | root@testvm2:~ # ip addr |
1502 | cc16407a | Dimitris Aragiorgis | root@testvm2:~ # ip route |
1503 | cc16407a | Dimitris Aragiorgis | root@testvm2:~ # cat /etc/resolv.conf |
1504 | 2f6143c9 | Constantinos Venetsanopoulos | |
1505 | cc16407a | Dimitris Aragiorgis | to check IP address (5.6.7.2), IP routes (default via 5.6.7.1) and DNS config |
1506 | cc16407a | Dimitris Aragiorgis | (nameserver option in nfdhcpd.conf). This shows correct configuration of |
1507 | cc16407a | Dimitris Aragiorgis | ganeti, snf-network and nfdhcpd. |
1508 | 2f6143c9 | Constantinos Venetsanopoulos | |
1509 | 2f6143c9 | Constantinos Venetsanopoulos | Now ping the outside world. If this works too, then you have also configured |
1510 | cc16407a | Dimitris Aragiorgis | correctly your physical host and router. |
1511 | 547c78f6 | Constantinos Venetsanopoulos | |
1512 | 547c78f6 | Constantinos Venetsanopoulos | Make sure everything works as expected, before proceeding with the Private |
1513 | 2f6143c9 | Constantinos Venetsanopoulos | Networks setup. |
1514 | 2f6143c9 | Constantinos Venetsanopoulos | |
1515 | 04c1254b | Constantinos Venetsanopoulos | .. _private-networks-setup: |
1516 | 04c1254b | Constantinos Venetsanopoulos | |
1517 | cc16407a | Dimitris Aragiorgis | Private Networks Setup |
1518 | 7a8df455 | Constantinos Venetsanopoulos | ---------------------- |
1519 | 2f6143c9 | Constantinos Venetsanopoulos | |
1520 | cc16407a | Dimitris Aragiorgis | Synnefo supports two types of private networks: |
1521 | cc16407a | Dimitris Aragiorgis | |
1522 | cc16407a | Dimitris Aragiorgis | - based on MAC filtering |
1523 | cc16407a | Dimitris Aragiorgis | - based on physical VLANs |
1524 | cc16407a | Dimitris Aragiorgis | |
1525 | cc16407a | Dimitris Aragiorgis | Both types provide Layer 2 isolation to the end-user. |
1526 | 2f6143c9 | Constantinos Venetsanopoulos | |
1527 | d587329c | Konstantinos Tompoulidis | For the first type a common bridge (e.g. ``prv0``) is needed while for the |
1528 | d587329c | Konstantinos Tompoulidis | second a range of bridges (e.g. ``prv1..prv100``) each bridged on a different |
1529 | d587329c | Konstantinos Tompoulidis | physical VLAN. To this end to assure isolation among end-users' private networks |
1530 | d587329c | Konstantinos Tompoulidis | each has to have different MAC prefix (for the filtering to take place) or to be |
1531 | cc16407a | Dimitris Aragiorgis | "connected" to a different bridge (VLAN actually). |
1532 | 547c78f6 | Constantinos Venetsanopoulos | |
1533 | cc16407a | Dimitris Aragiorgis | Physical Host Setup |
1534 | cc16407a | Dimitris Aragiorgis | ~~~~~~~~~~~~~~~~~~~ |
1535 | cc16407a | Dimitris Aragiorgis | |
1536 | cc16407a | Dimitris Aragiorgis | In order to create the necessary VLAN/bridges, one for MAC filtered private |
1537 | cc16407a | Dimitris Aragiorgis | networks and various (e.g. 20) for private networks based on physical VLANs, |
1538 | cc16407a | Dimitris Aragiorgis | run on every node: |
1539 | 547c78f6 | Constantinos Venetsanopoulos | |
1540 | cc16407a | Dimitris Aragiorgis | Assuming ``eth0`` of both hosts are somehow (via cable/switch with VLANs |
1541 | cc16407a | Dimitris Aragiorgis | configured correctly) connected together, run on every node: |
1542 | 547c78f6 | Constantinos Venetsanopoulos | |
1543 | 547c78f6 | Constantinos Venetsanopoulos | .. code-block:: console |
1544 | 547c78f6 | Constantinos Venetsanopoulos | |
1545 | cc16407a | Dimitris Aragiorgis | # modprobe 8021q |
1546 | 547c78f6 | Constantinos Venetsanopoulos | # $iface=eth0 |
1547 | cc16407a | Dimitris Aragiorgis | # for prv in $(seq 0 20); do |
1548 | d587329c | Konstantinos Tompoulidis | vlan=$prv |
1549 | d587329c | Konstantinos Tompoulidis | bridge=prv$prv |
1550 | d587329c | Konstantinos Tompoulidis | vconfig add $iface $vlan |
1551 | d587329c | Konstantinos Tompoulidis | ifconfig $iface.$vlan up |
1552 | d587329c | Konstantinos Tompoulidis | brctl addbr $bridge |
1553 | d587329c | Konstantinos Tompoulidis | brctl setfd $bridge 0 |
1554 | d587329c | Konstantinos Tompoulidis | brctl addif $bridge $iface.$vlan |
1555 | d587329c | Konstantinos Tompoulidis | ifconfig $bridge up |
1556 | 547c78f6 | Constantinos Venetsanopoulos | done |
1557 | 547c78f6 | Constantinos Venetsanopoulos | |
1558 | cc16407a | Dimitris Aragiorgis | The above will do the following : |
1559 | 547c78f6 | Constantinos Venetsanopoulos | |
1560 | cc16407a | Dimitris Aragiorgis | * provision 21 new bridges: ``prv0`` - ``prv20`` |
1561 | cc16407a | Dimitris Aragiorgis | * provision 21 new vlans: ``eth0.0`` - ``eth0.20`` |
1562 | cc16407a | Dimitris Aragiorgis | * add the corresponding vlan to the equivalent bridge |
1563 | 547c78f6 | Constantinos Venetsanopoulos | |
1564 | 547c78f6 | Constantinos Venetsanopoulos | You can run ``brctl show`` on both nodes to see if everything was setup |
1565 | 547c78f6 | Constantinos Venetsanopoulos | correctly. |
1566 | 547c78f6 | Constantinos Venetsanopoulos | |
1567 | 2f6143c9 | Constantinos Venetsanopoulos | Testing the Private Networks |
1568 | 7a8df455 | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1569 | caa6c07d | Constantinos Venetsanopoulos | |
1570 | 547c78f6 | Constantinos Venetsanopoulos | To test the Private Networks, we will create two instances and put them in the |
1571 | cc16407a | Dimitris Aragiorgis | same Private Networks (one MAC Filtered and one Physical VLAN). This means |
1572 | cc16407a | Dimitris Aragiorgis | that the instances will have a second NIC connected to the ``prv0`` |
1573 | cc16407a | Dimitris Aragiorgis | pre-provisioned bridge and a third to ``prv1``. |
1574 | 547c78f6 | Constantinos Venetsanopoulos | |
1575 | 547c78f6 | Constantinos Venetsanopoulos | We run the same command as in the Public Network testing section, but with one |
1576 | 547c78f6 | Constantinos Venetsanopoulos | more argument for the second NIC: |
1577 | 547c78f6 | Constantinos Venetsanopoulos | |
1578 | 547c78f6 | Constantinos Venetsanopoulos | .. code-block:: console |
1579 | 547c78f6 | Constantinos Venetsanopoulos | |
1580 | cc16407a | Dimitris Aragiorgis | # 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 |
1581 | cc16407a | Dimitris Aragiorgis | # gnt-network connect test-net-prv-mac default bridged prv0 |
1582 | cc16407a | Dimitris Aragiorgis | |
1583 | cc16407a | Dimitris Aragiorgis | # gnt-network add --network=10.0.0.0/24 --tags=nfdhcpd --network-type=private test-net-prv-vlan |
1584 | cc16407a | Dimitris Aragiorgis | # gnt-network connect test-net-prv-vlan default bridged prv1 |
1585 | cc16407a | Dimitris Aragiorgis | |
1586 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1587 | d587329c | Konstantinos Tompoulidis | 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"}' \ |
1588 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1589 | cc16407a | Dimitris Aragiorgis | --net 0:ip=pool,network=test-net-public \ |
1590 | cc16407a | Dimitris Aragiorgis | --net 1:ip=pool,network=test-net-prv-mac \ |
1591 | cc16407a | Dimitris Aragiorgis | --net 2:ip=none,network=test-net-prv-vlan \ |
1592 | 547c78f6 | Constantinos Venetsanopoulos | testvm3 |
1593 | 547c78f6 | Constantinos Venetsanopoulos | |
1594 | cc16407a | Dimitris Aragiorgis | # gnt-instance add -o snf-image+default --os-parameters \ |
1595 | d587329c | Konstantinos Tompoulidis | 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"}' \ |
1596 | cc16407a | Dimitris Aragiorgis | -t plain --disk 0:size=2G --no-name-check --no-ip-check \ |
1597 | cc16407a | Dimitris Aragiorgis | --net 0:ip=pool,network=test-net-public \ |
1598 | cc16407a | Dimitris Aragiorgis | --net 1:ip=pool,network=test-net-prv-mac \ |
1599 | cc16407a | Dimitris Aragiorgis | --net 2:ip=none,network=test-net-prv-vlan \ |
1600 | 547c78f6 | Constantinos Venetsanopoulos | testvm4 |
1601 | 547c78f6 | Constantinos Venetsanopoulos | |
1602 | cc16407a | Dimitris Aragiorgis | Above, we create two instances with first NIC connected to the internet, their |
1603 | cc16407a | Dimitris Aragiorgis | second NIC connected to a MAC filtered private Network and their third NIC |
1604 | cc16407a | Dimitris Aragiorgis | connected to the first Physical VLAN Private Network. Now, connect to the |
1605 | cc16407a | Dimitris Aragiorgis | instances using VNC and make sure everything works as expected: |
1606 | 547c78f6 | Constantinos Venetsanopoulos | |
1607 | cc16407a | Dimitris Aragiorgis | a) The instances have access to the public internet through their first eth |
1608 | cc16407a | Dimitris Aragiorgis | interface (``eth0``), which has been automatically assigned a public IP. |
1609 | 547c78f6 | Constantinos Venetsanopoulos | |
1610 | cc16407a | Dimitris Aragiorgis | b) ``eth1`` will have mac prefix ``aa:00:55``, while ``eth2`` default one (``aa:00:00``) |
1611 | 547c78f6 | Constantinos Venetsanopoulos | |
1612 | cc16407a | Dimitris Aragiorgis | c) ip link set ``eth1``/``eth2`` up |
1613 | 547c78f6 | Constantinos Venetsanopoulos | |
1614 | cc16407a | Dimitris Aragiorgis | d) dhclient ``eth1``/``eth2`` |
1615 | 547c78f6 | Constantinos Venetsanopoulos | |
1616 | cc16407a | Dimitris Aragiorgis | e) On testvm3 ping 192.168.1.2/10.0.0.2 |
1617 | 547c78f6 | Constantinos Venetsanopoulos | |
1618 | 547c78f6 | Constantinos Venetsanopoulos | If everything works as expected, then you have finished the Network Setup at the |
1619 | 547c78f6 | Constantinos Venetsanopoulos | backend for both types of Networks (Public & Private). |
1620 | 547c78f6 | Constantinos Venetsanopoulos | |
1621 | 2c85833e | Constantinos Venetsanopoulos | .. _cyclades-gtools: |
1622 | 2c85833e | Constantinos Venetsanopoulos | |
1623 | 2c85833e | Constantinos Venetsanopoulos | Cyclades Ganeti tools |
1624 | 2c85833e | Constantinos Venetsanopoulos | --------------------- |
1625 | 2c85833e | Constantinos Venetsanopoulos | |
1626 | 2c85833e | Constantinos Venetsanopoulos | In order for Ganeti to be connected with Cyclades later on, we need the |
1627 | 2c85833e | Constantinos Venetsanopoulos | `Cyclades Ganeti tools` available on all Ganeti nodes (node1 & node2 in our |
1628 | 2c85833e | Constantinos Venetsanopoulos | case). You can install them by running in both nodes: |
1629 | 2c85833e | Constantinos Venetsanopoulos | |
1630 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1631 | 2c85833e | Constantinos Venetsanopoulos | |
1632 | 2c85833e | Constantinos Venetsanopoulos | # apt-get install snf-cyclades-gtools |
1633 | 2c85833e | Constantinos Venetsanopoulos | |
1634 | 2c85833e | Constantinos Venetsanopoulos | This will install the following: |
1635 | 2c85833e | Constantinos Venetsanopoulos | |
1636 | 2c85833e | Constantinos Venetsanopoulos | * ``snf-ganeti-eventd`` (daemon to publish Ganeti related messages on RabbitMQ) |
1637 | 2c85833e | Constantinos Venetsanopoulos | * ``snf-ganeti-hook`` (all necessary hooks under ``/etc/ganeti/hooks``) |
1638 | 2c85833e | Constantinos Venetsanopoulos | * ``snf-progress-monitor`` (used by ``snf-image`` to publish progress messages) |
1639 | 2c85833e | Constantinos Venetsanopoulos | |
1640 | 2c85833e | Constantinos Venetsanopoulos | Configure ``snf-cyclades-gtools`` |
1641 | 2c85833e | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1642 | 2c85833e | Constantinos Venetsanopoulos | |
1643 | d587329c | Konstantinos Tompoulidis | The package will install the ``/etc/synnefo/20-snf-cyclades-gtools-backend.conf`` |
1644 | 2c85833e | Constantinos Venetsanopoulos | configuration file. At least we need to set the RabbitMQ endpoint for all tools |
1645 | 2c85833e | Constantinos Venetsanopoulos | that need it: |
1646 | 2c85833e | Constantinos Venetsanopoulos | |
1647 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1648 | 2c85833e | Constantinos Venetsanopoulos | |
1649 | d587329c | Konstantinos Tompoulidis | AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"] |
1650 | 2c85833e | Constantinos Venetsanopoulos | |
1651 | 2c85833e | Constantinos Venetsanopoulos | The above variables should reflect your :ref:`Message Queue setup |
1652 | 2c85833e | Constantinos Venetsanopoulos | <rabbitmq-setup>`. This file should be editted in all Ganeti nodes. |
1653 | 2c85833e | Constantinos Venetsanopoulos | |
1654 | 2c85833e | Constantinos Venetsanopoulos | Connect ``snf-image`` with ``snf-progress-monitor`` |
1655 | 2c85833e | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
1656 | 2c85833e | Constantinos Venetsanopoulos | |
1657 | 2c85833e | Constantinos Venetsanopoulos | Finally, we need to configure ``snf-image`` to publish progress messages during |
1658 | 2c85833e | Constantinos Venetsanopoulos | the deployment of each Image. To do this, we edit ``/etc/default/snf-image`` and |
1659 | 2c85833e | Constantinos Venetsanopoulos | set the corresponding variable to ``snf-progress-monitor``: |
1660 | 2c85833e | Constantinos Venetsanopoulos | |
1661 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1662 | 2c85833e | Constantinos Venetsanopoulos | |
1663 | 2c85833e | Constantinos Venetsanopoulos | PROGRESS_MONITOR="snf-progress-monitor" |
1664 | 2c85833e | Constantinos Venetsanopoulos | |
1665 | 2c85833e | Constantinos Venetsanopoulos | This file should be editted in all Ganeti nodes. |
1666 | 2c85833e | Constantinos Venetsanopoulos | |
1667 | 7a8df455 | Constantinos Venetsanopoulos | .. _rapi-user: |
1668 | 7a8df455 | Constantinos Venetsanopoulos | |
1669 | caa6c07d | Constantinos Venetsanopoulos | Synnefo RAPI user |
1670 | 7a8df455 | Constantinos Venetsanopoulos | ----------------- |
1671 | caa6c07d | Constantinos Venetsanopoulos | |
1672 | 7a8df455 | Constantinos Venetsanopoulos | As a last step before installing Cyclades, create a new RAPI user that will |
1673 | caa6c07d | Constantinos Venetsanopoulos | have ``write`` access. Cyclades will use this user to issue commands to Ganeti, |
1674 | 2c85833e | Constantinos Venetsanopoulos | so we will call the user ``cyclades`` with password ``example_rapi_passw0rd``. |
1675 | 2c85833e | Constantinos Venetsanopoulos | You can do this, by first running: |
1676 | 2c85833e | Constantinos Venetsanopoulos | |
1677 | 2c85833e | Constantinos Venetsanopoulos | .. code-block:: console |
1678 | 2c85833e | Constantinos Venetsanopoulos | |
1679 | 2c85833e | Constantinos Venetsanopoulos | # echo -n 'cyclades:Ganeti Remote API:example_rapi_passw0rd' | openssl md5 |
1680 | 2c85833e | Constantinos Venetsanopoulos | |
1681 | 2c85833e | Constantinos Venetsanopoulos | and then putting the output in ``/var/lib/ganeti/rapi/users`` as follows: |
1682 | caa6c07d | Constantinos Venetsanopoulos | |
1683 | caa6c07d | Constantinos Venetsanopoulos | .. code-block:: console |
1684 | caa6c07d | Constantinos Venetsanopoulos | |
1685 | 2c85833e | Constantinos Venetsanopoulos | cyclades {HA1}55aec7050aa4e4b111ca43cb505a61a0 write |
1686 | caa6c07d | Constantinos Venetsanopoulos | |
1687 | caa6c07d | Constantinos Venetsanopoulos | More about Ganeti's RAPI users `here. |
1688 | e332c1fd | Stratos Psomadakis | <http://docs.ganeti.org/ganeti/2.6/html/rapi.html#introduction>`_ |
1689 | bc055d09 | Constantinos Venetsanopoulos | |
1690 | 73ebcd68 | Constantinos Venetsanopoulos | You have now finished with all needed Prerequisites for Cyclades. Let's move on |
1691 | 73ebcd68 | Constantinos Venetsanopoulos | to the actual Cyclades installation. |
1692 | 7a8df455 | Constantinos Venetsanopoulos | |
1693 | 7a8df455 | Constantinos Venetsanopoulos | |
1694 | 73ebcd68 | Constantinos Venetsanopoulos | Installation of Cyclades on node1 |
1695 | 73ebcd68 | Constantinos Venetsanopoulos | ================================= |
1696 | 7a8df455 | Constantinos Venetsanopoulos | |
1697 | 7a8df455 | Constantinos Venetsanopoulos | This section describes the installation of Cyclades. Cyclades is Synnefo's |
1698 | 73ebcd68 | Constantinos Venetsanopoulos | Compute service. The Image Service will get installed automatically along with |
1699 | 73ebcd68 | Constantinos Venetsanopoulos | Cyclades, because it is contained in the same Synnefo component. |
1700 | 7a8df455 | Constantinos Venetsanopoulos | |
1701 | 73ebcd68 | Constantinos Venetsanopoulos | We will install Cyclades on node1. To do so, we install the corresponding |
1702 | 73ebcd68 | Constantinos Venetsanopoulos | package by running on node1: |
1703 | 04c1254b | Constantinos Venetsanopoulos | |
1704 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1705 | 04c1254b | Constantinos Venetsanopoulos | |
1706 | d587329c | Konstantinos Tompoulidis | # apt-get install snf-cyclades-app memcached python-memcache |
1707 | 04c1254b | Constantinos Venetsanopoulos | |
1708 | 73ebcd68 | Constantinos Venetsanopoulos | If all packages install successfully, then Cyclades are installed and we |
1709 | 73ebcd68 | Constantinos Venetsanopoulos | proceed with their configuration. |
1710 | 04c1254b | Constantinos Venetsanopoulos | |
1711 | d587329c | Konstantinos Tompoulidis | Since version 0.13, Synnefo uses the VMAPI in order to prevent sensitive data |
1712 | d587329c | Konstantinos Tompoulidis | needed by 'snf-image' to be stored in Ganeti configuration (e.g. VM password). |
1713 | d587329c | Konstantinos Tompoulidis | This is achieved by storing all sensitive information to a CACHE backend and |
1714 | d587329c | Konstantinos Tompoulidis | exporting it via VMAPI. The cache entries are invalidated after the first |
1715 | d587329c | Konstantinos Tompoulidis | request. Synnefo uses `memcached <http://memcached.org/>`_ as a |
1716 | d587329c | Konstantinos Tompoulidis | `Django <https://www.djangoproject.com/>`_ cache backend. |
1717 | bc055d09 | Constantinos Venetsanopoulos | |
1718 | 73ebcd68 | Constantinos Venetsanopoulos | Configuration of Cyclades |
1719 | 73ebcd68 | Constantinos Venetsanopoulos | ========================= |
1720 | 5b6feb88 | Vangelis Koukis | |
1721 | 04c1254b | Constantinos Venetsanopoulos | Conf files |
1722 | 04c1254b | Constantinos Venetsanopoulos | ---------- |
1723 | bc055d09 | Constantinos Venetsanopoulos | |
1724 | 04c1254b | Constantinos Venetsanopoulos | After installing Cyclades, a number of new configuration files will appear under |
1725 | d587329c | Konstantinos Tompoulidis | ``/etc/synnefo/`` prefixed with ``20-snf-cyclades-app-``. We will describe here |
1726 | d587329c | Konstantinos Tompoulidis | only the minimal needed changes to result with a working system. In general, |
1727 | d587329c | Konstantinos Tompoulidis | sane defaults have been chosen for the most of the options, to cover most of the |
1728 | 04c1254b | Constantinos Venetsanopoulos | common scenarios. However, if you want to tweak Cyclades feel free to do so, |
1729 | 04c1254b | Constantinos Venetsanopoulos | once you get familiar with the different options. |
1730 | bc055d09 | Constantinos Venetsanopoulos | |
1731 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-api.conf``: |
1732 | bc055d09 | Constantinos Venetsanopoulos | |
1733 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1734 | 04c1254b | Constantinos Venetsanopoulos | |
1735 | e3ff6830 | Georgios D. Tsoukalas | CYCLADES_BASE_URL = 'https://node1.example.com/cyclades' |
1736 | e3ff6830 | Georgios D. Tsoukalas | ASTAKOS_BASE_URL = 'https://node1.example.com/astakos' |
1737 | 04c1254b | Constantinos Venetsanopoulos | |
1738 | d587329c | Konstantinos Tompoulidis | # Set to False if astakos & cyclades are on the same host |
1739 | d587329c | Konstantinos Tompoulidis | CYCLADES_PROXY_USER_SERVICES = False |
1740 | d587329c | Konstantinos Tompoulidis | |
1741 | 26498848 | Giorgos Korfiatis | CYCLADES_SERVICE_TOKEN = 'cyclades_service_token22w' |
1742 | a14f152f | Giorgos Korfiatis | |
1743 | e3ff6830 | Georgios D. Tsoukalas | The ``ASTAKOS_BASE_URL`` denotes the Astakos endpoint for Cyclades, |
1744 | e3ff6830 | Georgios D. Tsoukalas | which is used for all user management, including authentication. |
1745 | e3ff6830 | Georgios D. Tsoukalas | Since our Astakos, Cyclades, and Pithos installations belong together, |
1746 | e3ff6830 | Georgios D. Tsoukalas | they should all have identical ``ASTAKOS_BASE_URL`` setting |
1747 | e3ff6830 | Georgios D. Tsoukalas | (see also, :ref:`previously <conf-pithos>`). |
1748 | d587329c | Konstantinos Tompoulidis | |
1749 | 0d87ef78 | Giorgos Korfiatis | The ``CYCLADES_BASE_URL`` setting must point to the top-level Cyclades URL. |
1750 | 0d87ef78 | Giorgos Korfiatis | Appending an extra path (``/cyclades`` here) is recommended in order to |
1751 | 0d87ef78 | Giorgos Korfiatis | distinguish components, if more than one are installed on the same machine. |
1752 | 0d87ef78 | Giorgos Korfiatis | |
1753 | a14f152f | Giorgos Korfiatis | The ``CYCLADES_SERVICE_TOKEN`` is the token used for authentication with astakos. |
1754 | a14f152f | Giorgos Korfiatis | It can be retrieved by running on the Astakos node (node1 in our case): |
1755 | a14f152f | Giorgos Korfiatis | |
1756 | a14f152f | Giorgos Korfiatis | .. code-block:: console |
1757 | a14f152f | Giorgos Korfiatis | |
1758 | a14f152f | Giorgos Korfiatis | # snf-manage component-list |
1759 | a14f152f | Giorgos Korfiatis | |
1760 | a14f152f | Giorgos Korfiatis | The token has been generated automatically during the :ref:`Cyclades service |
1761 | a14f152f | Giorgos Korfiatis | registration <services-reg>`. |
1762 | a14f152f | Giorgos Korfiatis | |
1763 | 053d0dfc | Constantinos Venetsanopoulos | TODO: Document the Network Options here |
1764 | 04c1254b | Constantinos Venetsanopoulos | |
1765 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-cloudbar.conf``: |
1766 | 04c1254b | Constantinos Venetsanopoulos | |
1767 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1768 | 04c1254b | Constantinos Venetsanopoulos | |
1769 | bc3a7b5a | Constantinos Venetsanopoulos | CLOUDBAR_LOCATION = 'https://node1.example.com/static/im/cloudbar/' |
1770 | a14f152f | Giorgos Korfiatis | CLOUDBAR_SERVICES_URL = 'https://node1.example.com/astakos/ui/get_services' |
1771 | a14f152f | Giorgos Korfiatis | CLOUDBAR_MENU_URL = 'https://account.node1.example.com/astakos/ui/get_menu' |
1772 | 04c1254b | Constantinos Venetsanopoulos | |
1773 | 04c1254b | Constantinos Venetsanopoulos | ``CLOUDBAR_LOCATION`` tells the client where to find the Astakos common |
1774 | 04c1254b | Constantinos Venetsanopoulos | cloudbar. The ``CLOUDBAR_SERVICES_URL`` and ``CLOUDBAR_MENU_URL`` options are |
1775 | 04c1254b | Constantinos Venetsanopoulos | used by the Cyclades Web UI to get from Astakos all the information needed to |
1776 | 04c1254b | Constantinos Venetsanopoulos | fill its own cloudbar. So, we put our Astakos deployment urls there. All the |
1777 | 04c1254b | Constantinos Venetsanopoulos | above should have the same values we put in the corresponding variables in |
1778 | 04c1254b | Constantinos Venetsanopoulos | ``/etc/synnefo/20-snf-pithos-webclient-cloudbar.conf`` on the previous |
1779 | 04c1254b | Constantinos Venetsanopoulos | :ref:`Pithos configuration <conf-pithos>` section. |
1780 | 04c1254b | Constantinos Venetsanopoulos | |
1781 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``: |
1782 | 04c1254b | Constantinos Venetsanopoulos | |
1783 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1784 | 04c1254b | Constantinos Venetsanopoulos | |
1785 | 04c1254b | Constantinos Venetsanopoulos | BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos' |
1786 | 04c1254b | Constantinos Venetsanopoulos | BACKEND_BLOCK_PATH = '/srv/pithos/data/' |
1787 | 04c1254b | Constantinos Venetsanopoulos | |
1788 | 73ebcd68 | Constantinos Venetsanopoulos | In this file we configure the Image Service. ``BACKEND_DB_CONNECTION`` |
1789 | e5d8df8c | Constantinos Venetsanopoulos | denotes the Pithos database (where the Image files are stored). So we set that |
1790 | e5d8df8c | Constantinos Venetsanopoulos | to point to our Pithos database. ``BACKEND_BLOCK_PATH`` denotes the actual |
1791 | e5d8df8c | Constantinos Venetsanopoulos | Pithos data location. |
1792 | 04c1254b | Constantinos Venetsanopoulos | |
1793 | 04c1254b | Constantinos Venetsanopoulos | Edit ``/etc/synnefo/20-snf-cyclades-app-queues.conf``: |
1794 | 04c1254b | Constantinos Venetsanopoulos | |
1795 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1796 | 04c1254b | Constantinos Venetsanopoulos | |
1797 | ad003186 | Constantinos Venetsanopoulos | AMQP_HOSTS=["amqp://synnefo:example_rabbitmq_passw0rd@node1.example.com:5672"] |
1798 | 04c1254b | Constantinos Venetsanopoulos | |
1799 | 04c1254b | Constantinos Venetsanopoulos | The above settings denote the Message Queue. Those settings should have the same |
1800 | 04c1254b | Constantinos Venetsanopoulos | values as in ``/etc/synnefo/10-snf-cyclades-gtools-backend.conf`` file, and |
1801 | 04c1254b | Constantinos Venetsanopoulos | reflect our :ref:`Message Queue setup <rabbitmq-setup>`. |
1802 | 04c1254b | Constantinos Venetsanopoulos | |
1803 | d587329c | Konstantinos Tompoulidis | Edit ``/etc/synnefo/20-snf-cyclades-app-vmapi.conf``: |
1804 | d587329c | Konstantinos Tompoulidis | |
1805 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
1806 | d587329c | Konstantinos Tompoulidis | |
1807 | d587329c | Konstantinos Tompoulidis | VMAPI_CACHE_BACKEND = "memcached://127.0.0.1:11211/?timeout=3600" |
1808 | d587329c | Konstantinos Tompoulidis | |
1809 | 053d0dfc | Constantinos Venetsanopoulos | Edit ``/etc/default/vncauthproxy``: |
1810 | 053d0dfc | Constantinos Venetsanopoulos | |
1811 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1812 | 053d0dfc | Constantinos Venetsanopoulos | |
1813 | d5426b9b | Stratos Psomadakis | CHUID="nobody:www-data" |
1814 | 053d0dfc | Constantinos Venetsanopoulos | |
1815 | 73ebcd68 | Constantinos Venetsanopoulos | We have now finished with the basic Cyclades configuration. |
1816 | 04c1254b | Constantinos Venetsanopoulos | |
1817 | 04c1254b | Constantinos Venetsanopoulos | Database Initialization |
1818 | 04c1254b | Constantinos Venetsanopoulos | ----------------------- |
1819 | 04c1254b | Constantinos Venetsanopoulos | |
1820 | 04c1254b | Constantinos Venetsanopoulos | Once Cyclades is configured, we sync the database: |
1821 | bc055d09 | Constantinos Venetsanopoulos | |
1822 | bc055d09 | Constantinos Venetsanopoulos | .. code-block:: console |
1823 | bc055d09 | Constantinos Venetsanopoulos | |
1824 | bc055d09 | Constantinos Venetsanopoulos | $ snf-manage syncdb |
1825 | bc055d09 | Constantinos Venetsanopoulos | $ snf-manage migrate |
1826 | bc055d09 | Constantinos Venetsanopoulos | |
1827 | 04c1254b | Constantinos Venetsanopoulos | and load the initial server flavors: |
1828 | bc055d09 | Constantinos Venetsanopoulos | |
1829 | bc055d09 | Constantinos Venetsanopoulos | .. code-block:: console |
1830 | bc055d09 | Constantinos Venetsanopoulos | |
1831 | bc055d09 | Constantinos Venetsanopoulos | $ snf-manage loaddata flavors |
1832 | bc055d09 | Constantinos Venetsanopoulos | |
1833 | 04c1254b | Constantinos Venetsanopoulos | If everything returns successfully, our database is ready. |
1834 | 04c1254b | Constantinos Venetsanopoulos | |
1835 | 053d0dfc | Constantinos Venetsanopoulos | Add the Ganeti backend |
1836 | 053d0dfc | Constantinos Venetsanopoulos | ---------------------- |
1837 | 053d0dfc | Constantinos Venetsanopoulos | |
1838 | 7a3439cf | Constantinos Venetsanopoulos | In our installation we assume that we only have one Ganeti cluster, the one we |
1839 | b2764de1 | Dimitris Aragiorgis | setup earlier. At this point you have to add this backend (Ganeti cluster) to |
1840 | b2764de1 | Dimitris Aragiorgis | cyclades assuming that you have setup the :ref:`Rapi User <rapi-user>` |
1841 | b2764de1 | Dimitris Aragiorgis | correctly. |
1842 | b2764de1 | Dimitris Aragiorgis | |
1843 | b2764de1 | Dimitris Aragiorgis | .. code-block:: console |
1844 | b2764de1 | Dimitris Aragiorgis | |
1845 | 69aa7f21 | Ilias Tsitsimpis | $ snf-manage backend-add --clustername=ganeti.node1.example.com --user=cyclades --pass=example_rapi_passw0rd |
1846 | b2764de1 | Dimitris Aragiorgis | |
1847 | b2764de1 | Dimitris Aragiorgis | You can see everything has been setup correctly by running: |
1848 | 053d0dfc | Constantinos Venetsanopoulos | |
1849 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1850 | 053d0dfc | Constantinos Venetsanopoulos | |
1851 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage backend-list |
1852 | 053d0dfc | Constantinos Venetsanopoulos | |
1853 | d587329c | Konstantinos Tompoulidis | Enable the new backend by running: |
1854 | d587329c | Konstantinos Tompoulidis | |
1855 | d587329c | Konstantinos Tompoulidis | .. code-block:: |
1856 | d587329c | Konstantinos Tompoulidis | |
1857 | d587329c | Konstantinos Tompoulidis | $ snf-manage backend-modify --drained False 1 |
1858 | d587329c | Konstantinos Tompoulidis | |
1859 | d587329c | Konstantinos Tompoulidis | .. warning:: Since version 0.13, the backend is set to "drained" by default. |
1860 | d587329c | Konstantinos Tompoulidis | This means that you cannot add VMs to it. The reason for this is that the |
1861 | d587329c | Konstantinos Tompoulidis | nodes should be unavailable to Synnefo until the Administrator explicitly |
1862 | d587329c | Konstantinos Tompoulidis | releases them. To change this setting, use ``snf-manage backend-modify |
1863 | d587329c | Konstantinos Tompoulidis | --drained False <backend-id>``. |
1864 | d587329c | Konstantinos Tompoulidis | |
1865 | 7a3439cf | Constantinos Venetsanopoulos | If something is not set correctly, you can modify the backend with the |
1866 | 7a3439cf | Constantinos Venetsanopoulos | ``snf-manage backend-modify`` command. If something has gone wrong, you could |
1867 | 7a3439cf | Constantinos Venetsanopoulos | modify the backend to reflect the Ganeti installation by running: |
1868 | 053d0dfc | Constantinos Venetsanopoulos | |
1869 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1870 | 053d0dfc | Constantinos Venetsanopoulos | |
1871 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage backend-modify --clustername "ganeti.node1.example.com" |
1872 | 7a3439cf | Constantinos Venetsanopoulos | --user=cyclades |
1873 | 7a3439cf | Constantinos Venetsanopoulos | --pass=example_rapi_passw0rd |
1874 | 053d0dfc | Constantinos Venetsanopoulos | 1 |
1875 | 053d0dfc | Constantinos Venetsanopoulos | |
1876 | 053d0dfc | Constantinos Venetsanopoulos | ``clustername`` denotes the Ganeti-cluster's name. We provide the corresponding |
1877 | 053d0dfc | Constantinos Venetsanopoulos | domain that resolves to the master IP, than the IP itself, to ensure Cyclades |
1878 | 053d0dfc | Constantinos Venetsanopoulos | can talk to Ganeti even after a Ganeti master-failover. |
1879 | 053d0dfc | Constantinos Venetsanopoulos | |
1880 | 7a3439cf | Constantinos Venetsanopoulos | ``user`` and ``pass`` denote the RAPI user's username and the RAPI user's |
1881 | b2764de1 | Dimitris Aragiorgis | password. Once we setup the first backend to point at our Ganeti cluster, we |
1882 | b2764de1 | Dimitris Aragiorgis | update the Cyclades backends status by running: |
1883 | 053d0dfc | Constantinos Venetsanopoulos | |
1884 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1885 | 053d0dfc | Constantinos Venetsanopoulos | |
1886 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage backend-update-status |
1887 | 053d0dfc | Constantinos Venetsanopoulos | |
1888 | 7a3439cf | Constantinos Venetsanopoulos | Cyclades can manage multiple Ganeti backends, but for the purpose of this |
1889 | 7a3439cf | Constantinos Venetsanopoulos | guide,we won't get into more detail regarding mulitple backends. If you want to |
1890 | 7a3439cf | Constantinos Venetsanopoulos | learn more please see /*TODO*/. |
1891 | 7a3439cf | Constantinos Venetsanopoulos | |
1892 | 7a3439cf | Constantinos Venetsanopoulos | Add a Public Network |
1893 | 053d0dfc | Constantinos Venetsanopoulos | ---------------------- |
1894 | 053d0dfc | Constantinos Venetsanopoulos | |
1895 | 7a3439cf | Constantinos Venetsanopoulos | Cyclades supports different Public Networks on different Ganeti backends. |
1896 | cc16407a | Dimitris Aragiorgis | After connecting Cyclades with our Ganeti cluster, we need to setup a Public |
1897 | cc16407a | Dimitris Aragiorgis | Network for this Ganeti backend (`id = 1`). The basic setup is to bridge every |
1898 | cc16407a | Dimitris Aragiorgis | created NIC on a bridge. After having a bridge (e.g. br0) created in every |
1899 | cc16407a | Dimitris Aragiorgis | backend node edit Synnefo setting CUSTOM_BRIDGED_BRIDGE to 'br0': |
1900 | 053d0dfc | Constantinos Venetsanopoulos | |
1901 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1902 | 053d0dfc | Constantinos Venetsanopoulos | |
1903 | 69aa7f21 | Ilias Tsitsimpis | $ snf-manage network-create --subnet=5.6.7.0/27 \ |
1904 | 69aa7f21 | Ilias Tsitsimpis | --gateway=5.6.7.1 \ |
1905 | 69aa7f21 | Ilias Tsitsimpis | --subnet6=2001:648:2FFC:1322::/64 \ |
1906 | 69aa7f21 | Ilias Tsitsimpis | --gateway6=2001:648:2FFC:1322::1 \ |
1907 | 18e300b2 | Christos Stavrakakis | --public --dhcp --flavor=CUSTOM \ |
1908 | 92e4d1c6 | Dimitris Aragiorgis | --link=br0 --mode=bridged \ |
1909 | 69aa7f21 | Ilias Tsitsimpis | --name=public_network \ |
1910 | 7a3439cf | Constantinos Venetsanopoulos | --backend-id=1 |
1911 | 053d0dfc | Constantinos Venetsanopoulos | |
1912 | 053d0dfc | Constantinos Venetsanopoulos | This will create the Public Network on both Cyclades and the Ganeti backend. To |
1913 | 053d0dfc | Constantinos Venetsanopoulos | make sure everything was setup correctly, also run: |
1914 | 053d0dfc | Constantinos Venetsanopoulos | |
1915 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1916 | 053d0dfc | Constantinos Venetsanopoulos | |
1917 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage reconcile-networks |
1918 | 053d0dfc | Constantinos Venetsanopoulos | |
1919 | 053d0dfc | Constantinos Venetsanopoulos | You can see all available networks by running: |
1920 | 053d0dfc | Constantinos Venetsanopoulos | |
1921 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1922 | 053d0dfc | Constantinos Venetsanopoulos | |
1923 | 7a3439cf | Constantinos Venetsanopoulos | $ snf-manage network-list |
1924 | 053d0dfc | Constantinos Venetsanopoulos | |
1925 | 053d0dfc | Constantinos Venetsanopoulos | and inspect each network's state by running: |
1926 | 053d0dfc | Constantinos Venetsanopoulos | |
1927 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1928 | 053d0dfc | Constantinos Venetsanopoulos | |
1929 | 053d0dfc | Constantinos Venetsanopoulos | $ snf-manage network-inspect <net_id> |
1930 | 053d0dfc | Constantinos Venetsanopoulos | |
1931 | 053d0dfc | Constantinos Venetsanopoulos | Finally, you can see the networks from the Ganeti perspective by running on the |
1932 | 053d0dfc | Constantinos Venetsanopoulos | Ganeti MASTER: |
1933 | 053d0dfc | Constantinos Venetsanopoulos | |
1934 | 053d0dfc | Constantinos Venetsanopoulos | .. code-block:: console |
1935 | 053d0dfc | Constantinos Venetsanopoulos | |
1936 | 053d0dfc | Constantinos Venetsanopoulos | $ gnt-network list |
1937 | 053d0dfc | Constantinos Venetsanopoulos | $ gnt-network info <network_name> |
1938 | 053d0dfc | Constantinos Venetsanopoulos | |
1939 | 19425707 | Christos Stavrakakis | Create pools for Private Networks |
1940 | d587329c | Konstantinos Tompoulidis | --------------------------------- |
1941 | 19425707 | Christos Stavrakakis | |
1942 | 19425707 | Christos Stavrakakis | To prevent duplicate assignment of resources to different private networks, |
1943 | 19425707 | Christos Stavrakakis | Cyclades supports two types of pools: |
1944 | 19425707 | Christos Stavrakakis | |
1945 | 19425707 | Christos Stavrakakis | - MAC prefix Pool |
1946 | 19425707 | Christos Stavrakakis | - Bridge Pool |
1947 | 19425707 | Christos Stavrakakis | |
1948 | 19425707 | Christos Stavrakakis | As long as those resourses have been provisioned, admin has to define two |
1949 | 19425707 | Christos Stavrakakis | these pools in Synnefo: |
1950 | 19425707 | Christos Stavrakakis | |
1951 | 19425707 | Christos Stavrakakis | |
1952 | 19425707 | Christos Stavrakakis | .. code-block:: console |
1953 | 19425707 | Christos Stavrakakis | |
1954 | 19425707 | Christos Stavrakakis | root@testvm1:~ # snf-manage pool-create --type=mac-prefix --base=aa:00:0 --size=65536 |
1955 | 19425707 | Christos Stavrakakis | |
1956 | 19425707 | Christos Stavrakakis | root@testvm1:~ # snf-manage pool-create --type=bridge --base=prv --size=20 |
1957 | 19425707 | Christos Stavrakakis | |
1958 | 19425707 | Christos Stavrakakis | Also, change the Synnefo setting in :file:`20-snf-cyclades-app-api.conf`: |
1959 | 19425707 | Christos Stavrakakis | |
1960 | 19425707 | Christos Stavrakakis | .. code-block:: console |
1961 | 19425707 | Christos Stavrakakis | |
1962 | 18e300b2 | Christos Stavrakakis | DEFAULT_MAC_FILTERED_BRIDGE = 'prv0' |
1963 | 19425707 | Christos Stavrakakis | |
1964 | 04c1254b | Constantinos Venetsanopoulos | Servers restart |
1965 | 04c1254b | Constantinos Venetsanopoulos | --------------- |
1966 | 04c1254b | Constantinos Venetsanopoulos | |
1967 | 053d0dfc | Constantinos Venetsanopoulos | Restart gunicorn on node1: |
1968 | 04c1254b | Constantinos Venetsanopoulos | |
1969 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1970 | bc055d09 | Constantinos Venetsanopoulos | |
1971 | 04c1254b | Constantinos Venetsanopoulos | # /etc/init.d/gunicorn restart |
1972 | bc055d09 | Constantinos Venetsanopoulos | |
1973 | 04c1254b | Constantinos Venetsanopoulos | Now let's do the final connections of Cyclades with Ganeti. |
1974 | bc055d09 | Constantinos Venetsanopoulos | |
1975 | 04c1254b | Constantinos Venetsanopoulos | ``snf-dispatcher`` initialization |
1976 | 04c1254b | Constantinos Venetsanopoulos | --------------------------------- |
1977 | 04c1254b | Constantinos Venetsanopoulos | |
1978 | 04c1254b | Constantinos Venetsanopoulos | ``snf-dispatcher`` dispatches all messages published to the Message Queue and |
1979 | 04c1254b | Constantinos Venetsanopoulos | manages the Cyclades database accordingly. It also initializes all exchanges. By |
1980 | 04c1254b | Constantinos Venetsanopoulos | default it is not enabled during installation of Cyclades, so let's enable it in |
1981 | 04c1254b | Constantinos Venetsanopoulos | its configuration file ``/etc/default/snf-dispatcher``: |
1982 | 04c1254b | Constantinos Venetsanopoulos | |
1983 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1984 | 04c1254b | Constantinos Venetsanopoulos | |
1985 | 04c1254b | Constantinos Venetsanopoulos | SNF_DSPTCH_ENABLE=true |
1986 | 04c1254b | Constantinos Venetsanopoulos | |
1987 | 04c1254b | Constantinos Venetsanopoulos | and start the daemon: |
1988 | 04c1254b | Constantinos Venetsanopoulos | |
1989 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
1990 | 04c1254b | Constantinos Venetsanopoulos | |
1991 | 04c1254b | Constantinos Venetsanopoulos | # /etc/init.d/snf-dispatcher start |
1992 | 04c1254b | Constantinos Venetsanopoulos | |
1993 | 04c1254b | Constantinos Venetsanopoulos | You can see that everything works correctly by tailing its log file |
1994 | 04c1254b | Constantinos Venetsanopoulos | ``/var/log/synnefo/dispatcher.log``. |
1995 | 04c1254b | Constantinos Venetsanopoulos | |
1996 | 04c1254b | Constantinos Venetsanopoulos | ``snf-ganeti-eventd`` on GANETI MASTER |
1997 | 04c1254b | Constantinos Venetsanopoulos | -------------------------------------- |
1998 | 04c1254b | Constantinos Venetsanopoulos | |
1999 | 04c1254b | Constantinos Venetsanopoulos | The last step of the Cyclades setup is enabling the ``snf-ganeti-eventd`` |
2000 | 04c1254b | Constantinos Venetsanopoulos | daemon (part of the :ref:`Cyclades Ganeti tools <cyclades-gtools>` package). |
2001 | 04c1254b | Constantinos Venetsanopoulos | The daemon is already installed on the GANETI MASTER (node1 in our case). |
2002 | 04c1254b | Constantinos Venetsanopoulos | ``snf-ganeti-eventd`` is disabled by default during the ``snf-cyclades-gtools`` |
2003 | 04c1254b | Constantinos Venetsanopoulos | installation, so we enable it in its configuration file |
2004 | 04c1254b | Constantinos Venetsanopoulos | ``/etc/default/snf-ganeti-eventd``: |
2005 | 04c1254b | Constantinos Venetsanopoulos | |
2006 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
2007 | 04c1254b | Constantinos Venetsanopoulos | |
2008 | 04c1254b | Constantinos Venetsanopoulos | SNF_EVENTD_ENABLE=true |
2009 | 04c1254b | Constantinos Venetsanopoulos | |
2010 | 04c1254b | Constantinos Venetsanopoulos | and start the daemon: |
2011 | 04c1254b | Constantinos Venetsanopoulos | |
2012 | 04c1254b | Constantinos Venetsanopoulos | .. code-block:: console |
2013 | bc055d09 | Constantinos Venetsanopoulos | |
2014 | 04c1254b | Constantinos Venetsanopoulos | # /etc/init.d/snf-ganeti-eventd start |
2015 | bc055d09 | Constantinos Venetsanopoulos | |
2016 | 04c1254b | Constantinos Venetsanopoulos | .. warning:: Make sure you start ``snf-ganeti-eventd`` *ONLY* on GANETI MASTER |
2017 | bc055d09 | Constantinos Venetsanopoulos | |
2018 | b446c082 | Giorgos Korfiatis | Apply Quota |
2019 | b446c082 | Giorgos Korfiatis | ----------- |
2020 | b446c082 | Giorgos Korfiatis | |
2021 | b446c082 | Giorgos Korfiatis | The following commands will check and fix the integrity of user quota. |
2022 | b446c082 | Giorgos Korfiatis | In a freshly installed system, these commands have no effect and can be |
2023 | b446c082 | Giorgos Korfiatis | skipped. |
2024 | d587329c | Konstantinos Tompoulidis | |
2025 | d587329c | Konstantinos Tompoulidis | .. code-block:: console |
2026 | d587329c | Konstantinos Tompoulidis | |
2027 | 075b91de | Giorgos Korfiatis | node1 # snf-manage quota --sync |
2028 | b446c082 | Giorgos Korfiatis | node1 # snf-manage reconcile-resources-astakos --fix |
2029 | b446c082 | Giorgos Korfiatis | node2 # snf-manage reconcile-resources-pithos --fix |
2030 | 62c86226 | Christos Stavrakakis | node1 # snf-manage reconcile-resources-cyclades --fix |
2031 | d587329c | Konstantinos Tompoulidis | |
2032 | 04c1254b | Constantinos Venetsanopoulos | If all the above return successfully, then you have finished with the Cyclades |
2033 | 73ebcd68 | Constantinos Venetsanopoulos | installation and setup. |
2034 | d587329c | Konstantinos Tompoulidis | |
2035 | d587329c | Konstantinos Tompoulidis | Let's test our installation now. |
2036 | bc055d09 | Constantinos Venetsanopoulos | |
2037 | 5b6feb88 | Vangelis Koukis | |
2038 | 73ebcd68 | Constantinos Venetsanopoulos | Testing of Cyclades |
2039 | 73ebcd68 | Constantinos Venetsanopoulos | =================== |
2040 | 5b6feb88 | Vangelis Koukis | |
2041 | 8a4cd31b | Constantinos Venetsanopoulos | Cyclades Web UI |
2042 | 8a4cd31b | Constantinos Venetsanopoulos | --------------- |
2043 | 8a4cd31b | Constantinos Venetsanopoulos | |
2044 | 8a4cd31b | Constantinos Venetsanopoulos | First of all we need to test that our Cyclades Web UI works correctly. Open your |
2045 | 8a4cd31b | Constantinos Venetsanopoulos | browser and go to the Astakos home page. Login and then click 'cyclades' on the |
2046 | 8a4cd31b | Constantinos Venetsanopoulos | top cloud bar. This should redirect you to: |
2047 | 8a4cd31b | Constantinos Venetsanopoulos | |
2048 | a14f152f | Giorgos Korfiatis | `http://node1.example.com/cyclades/ui/` |
2049 | 8a4cd31b | Constantinos Venetsanopoulos | |
2050 | 8a4cd31b | Constantinos Venetsanopoulos | and the Cyclades home page should appear. If not, please go back and find what |
2051 | 8a4cd31b | Constantinos Venetsanopoulos | went wrong. Do not proceed if you don't see the Cyclades home page. |
2052 | 8a4cd31b | Constantinos Venetsanopoulos | |
2053 | 8a4cd31b | Constantinos Venetsanopoulos | If the Cyclades home page appears, click on the orange button 'New machine'. The |
2054 | 8a4cd31b | Constantinos Venetsanopoulos | first step of the 'New machine wizard' will appear. This step shows all the |
2055 | 8a4cd31b | Constantinos Venetsanopoulos | available Images from which you can spawn new VMs. The list should be currently |
2056 | 8a4cd31b | Constantinos Venetsanopoulos | empty, as we haven't registered any Images yet. Close the wizard and browse the |
2057 | 8a4cd31b | Constantinos Venetsanopoulos | interface (not many things to see yet). If everything seems to work, let's |
2058 | 8a4cd31b | Constantinos Venetsanopoulos | register our first Image file. |
2059 | 8a4cd31b | Constantinos Venetsanopoulos | |
2060 | 8a4cd31b | Constantinos Venetsanopoulos | Cyclades Images |
2061 | 8a4cd31b | Constantinos Venetsanopoulos | --------------- |
2062 | 8a4cd31b | Constantinos Venetsanopoulos | |
2063 | e5d8df8c | Constantinos Venetsanopoulos | To test our Cyclades installation, we will use an Image stored on Pithos to |
2064 | 73ebcd68 | Constantinos Venetsanopoulos | spawn a new VM from the Cyclades interface. We will describe all steps, even |
2065 | e5d8df8c | Constantinos Venetsanopoulos | though you may already have uploaded an Image on Pithos from a :ref:`previous |
2066 | 73ebcd68 | Constantinos Venetsanopoulos | <snf-image-images>` section: |
2067 | 8a4cd31b | Constantinos Venetsanopoulos | |
2068 | e5d8df8c | Constantinos Venetsanopoulos | * Upload an Image file to Pithos |
2069 | 73ebcd68 | Constantinos Venetsanopoulos | * Register that Image file to Cyclades |
2070 | 8a4cd31b | Constantinos Venetsanopoulos | * Spawn a new VM from that Image from the Cyclades Web UI |
2071 | 8a4cd31b | Constantinos Venetsanopoulos | |
2072 | 34e79416 | Constantinos Venetsanopoulos | We will use the `kamaki <http://www.synnefo.org/docs/kamaki/latest/index.html>`_ |
2073 | 8a4cd31b | Constantinos Venetsanopoulos | command line client to do the uploading and registering of the Image. |
2074 | 8a4cd31b | Constantinos Venetsanopoulos | |
2075 | 8a4cd31b | Constantinos Venetsanopoulos | Installation of `kamaki` |
2076 | 8a4cd31b | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~ |
2077 | 8a4cd31b | Constantinos Venetsanopoulos | |
2078 | 8a4cd31b | Constantinos Venetsanopoulos | You can install `kamaki` anywhere you like, since it is a standalone client of |
2079 | 8a4cd31b | Constantinos Venetsanopoulos | the APIs and talks to the installation over `http`. For the purpose of this |
2080 | 8a4cd31b | Constantinos Venetsanopoulos | guide we will assume that we have downloaded the `Debian Squeeze Base Image |
2081 | 8a4cd31b | Constantinos Venetsanopoulos | <https://pithos.okeanos.grnet.gr/public/9epgb>`_ and stored it under node1's |
2082 | 8a4cd31b | Constantinos Venetsanopoulos | ``/srv/images`` directory. For that reason we will install `kamaki` on node1, |
2083 | 8a4cd31b | Constantinos Venetsanopoulos | too. We do this by running: |
2084 | 8a4cd31b | Constantinos Venetsanopoulos | |
2085 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2086 | 8a4cd31b | Constantinos Venetsanopoulos | |
2087 | 8a4cd31b | Constantinos Venetsanopoulos | # apt-get install kamaki |
2088 | 8a4cd31b | Constantinos Venetsanopoulos | |
2089 | 8a4cd31b | Constantinos Venetsanopoulos | Configuration of kamaki |
2090 | 8a4cd31b | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~ |
2091 | 8a4cd31b | Constantinos Venetsanopoulos | |
2092 | 8a4cd31b | Constantinos Venetsanopoulos | Now we need to setup kamaki, by adding the appropriate URLs and tokens of our |
2093 | 8a4cd31b | Constantinos Venetsanopoulos | installation. We do this by running: |
2094 | 8a4cd31b | Constantinos Venetsanopoulos | |
2095 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2096 | 8a4cd31b | Constantinos Venetsanopoulos | |
2097 | ebf463a5 | Stavros Sachtouris | $ kamaki config set user.url "https://node1.example.com" |
2098 | 69aa7f21 | Ilias Tsitsimpis | $ kamaki config set compute.url "https://node1.example.com/api/v1.1" |
2099 | 73ebcd68 | Constantinos Venetsanopoulos | $ kamaki config set image.url "https://node1.example.com/image" |
2100 | ebf463a5 | Stavros Sachtouris | $ kamaki config set file.url "https://node2.example.com/v1" |
2101 | ebf463a5 | Stavros Sachtouris | $ kamaki config set token USER_TOKEN |
2102 | 8a4cd31b | Constantinos Venetsanopoulos | |
2103 | ebf463a5 | Stavros Sachtouris | The USER_TOKEN appears on the user's `Profile` web page on the Astakos Web UI. |
2104 | 8a4cd31b | Constantinos Venetsanopoulos | |
2105 | c0d88cf3 | Constantinos Venetsanopoulos | You can see that the new configuration options have been applied correctly, |
2106 | c0d88cf3 | Constantinos Venetsanopoulos | either by checking the editable file ``~/.kamakirc`` or by running: |
2107 | 8a4cd31b | Constantinos Venetsanopoulos | |
2108 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2109 | 8a4cd31b | Constantinos Venetsanopoulos | |
2110 | 8a4cd31b | Constantinos Venetsanopoulos | $ kamaki config list |
2111 | 8a4cd31b | Constantinos Venetsanopoulos | |
2112 | c0d88cf3 | Constantinos Venetsanopoulos | A quick test to check that kamaki is configured correctly, is to try to |
2113 | c0d88cf3 | Constantinos Venetsanopoulos | authenticate a user based on his/her token (in this case the user is you): |
2114 | ebf463a5 | Stavros Sachtouris | |
2115 | ebf463a5 | Stavros Sachtouris | .. code-block:: console |
2116 | ebf463a5 | Stavros Sachtouris | |
2117 | ebf463a5 | Stavros Sachtouris | $ kamaki user authenticate |
2118 | ebf463a5 | Stavros Sachtouris | |
2119 | c0d88cf3 | Constantinos Venetsanopoulos | The above operation provides various user information, e.g. UUID (the unique |
2120 | c0d88cf3 | Constantinos Venetsanopoulos | user id) which might prove useful in some operations. |
2121 | ebf463a5 | Stavros Sachtouris | |
2122 | e5d8df8c | Constantinos Venetsanopoulos | Upload an Image file to Pithos |
2123 | e5d8df8c | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
2124 | 8a4cd31b | Constantinos Venetsanopoulos | |
2125 | 8a4cd31b | Constantinos Venetsanopoulos | Now, that we have set up `kamaki` we will upload the Image that we have |
2126 | 8a4cd31b | Constantinos Venetsanopoulos | downloaded and stored under ``/srv/images/``. Although we can upload the Image |
2127 | 8a4cd31b | Constantinos Venetsanopoulos | under the root ``Pithos`` container (as you may have done when uploading the |
2128 | e5d8df8c | Constantinos Venetsanopoulos | Image from the Pithos Web UI), we will create a new container called ``images`` |
2129 | 8a4cd31b | Constantinos Venetsanopoulos | and store the Image under that container. We do this for two reasons: |
2130 | 8a4cd31b | Constantinos Venetsanopoulos | |
2131 | 8a4cd31b | Constantinos Venetsanopoulos | a) To demonstrate how to create containers other than the default ``Pithos``. |
2132 | 8a4cd31b | Constantinos Venetsanopoulos | This can be done only with the `kamaki` client and not through the Web UI. |
2133 | 8a4cd31b | Constantinos Venetsanopoulos | |
2134 | 8a4cd31b | Constantinos Venetsanopoulos | b) As a best organization practise, so that you won't have your Image files |
2135 | e5d8df8c | Constantinos Venetsanopoulos | tangled along with all your other Pithos files and directory structures. |
2136 | 8a4cd31b | Constantinos Venetsanopoulos | |
2137 | 8a4cd31b | Constantinos Venetsanopoulos | We create the new ``images`` container by running: |
2138 | 8a4cd31b | Constantinos Venetsanopoulos | |
2139 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2140 | 8a4cd31b | Constantinos Venetsanopoulos | |
2141 | ebf463a5 | Stavros Sachtouris | $ kamaki file create images |
2142 | ebf463a5 | Stavros Sachtouris | |
2143 | c0d88cf3 | Constantinos Venetsanopoulos | To check if the container has been created, list all containers of your |
2144 | c0d88cf3 | Constantinos Venetsanopoulos | account: |
2145 | ebf463a5 | Stavros Sachtouris | |
2146 | ebf463a5 | Stavros Sachtouris | .. code-block:: console |
2147 | ebf463a5 | Stavros Sachtouris | |
2148 | ebf463a5 | Stavros Sachtouris | $ kamaki file list |
2149 | 8a4cd31b | Constantinos Venetsanopoulos | |
2150 | 8a4cd31b | Constantinos Venetsanopoulos | Then, we upload the Image file to that container: |
2151 | 8a4cd31b | Constantinos Venetsanopoulos | |
2152 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2153 | 8a4cd31b | Constantinos Venetsanopoulos | |
2154 | ebf463a5 | Stavros Sachtouris | $ kamaki file upload /srv/images/debian_base-6.0-7-x86_64.diskdump images |
2155 | 8a4cd31b | Constantinos Venetsanopoulos | |
2156 | e5d8df8c | Constantinos Venetsanopoulos | The first is the local path and the second is the remote container on Pithos. |
2157 | c0d88cf3 | Constantinos Venetsanopoulos | Check if the file has been uploaded, by listing the container contents: |
2158 | ebf463a5 | Stavros Sachtouris | |
2159 | ebf463a5 | Stavros Sachtouris | .. code-block:: console |
2160 | ebf463a5 | Stavros Sachtouris | |
2161 | ebf463a5 | Stavros Sachtouris | $ kamaki file list images |
2162 | ebf463a5 | Stavros Sachtouris | |
2163 | e5d8df8c | Constantinos Venetsanopoulos | Alternatively check if the new container and file appear on the Pithos Web UI. |
2164 | 8a4cd31b | Constantinos Venetsanopoulos | |
2165 | 73ebcd68 | Constantinos Venetsanopoulos | Register an existing Image file to Cyclades |
2166 | 8a4cd31b | Constantinos Venetsanopoulos | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
2167 | 8a4cd31b | Constantinos Venetsanopoulos | |
2168 | c0d88cf3 | Constantinos Venetsanopoulos | For the purposes of the following example, we assume that the user UUID is |
2169 | c0d88cf3 | Constantinos Venetsanopoulos | ``u53r-un1qu3-1d``. |
2170 | ebf463a5 | Stavros Sachtouris | |
2171 | e5d8df8c | Constantinos Venetsanopoulos | Once the Image file has been successfully uploaded on Pithos then we register |
2172 | 73ebcd68 | Constantinos Venetsanopoulos | it to Cyclades, by running: |
2173 | 8a4cd31b | Constantinos Venetsanopoulos | |
2174 | 8a4cd31b | Constantinos Venetsanopoulos | .. code-block:: console |
2175 | 8a4cd31b | Constantinos Venetsanopoulos | |
2176 | 69aa7f21 | Ilias Tsitsimpis | $ kamaki image register "Debian Base" \ |
2177 | c0d88cf3 | Constantinos Venetsanopoulos | pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump \ |
2178 | 69aa7f21 | Ilias Tsitsimpis | --public \ |
2179 | 69aa7f21 | Ilias Tsitsimpis | --disk-format=diskdump \ |
2180 | 69aa7f21 | Ilias Tsitsimpis | --property OSFAMILY=linux --property ROOT_PARTITION=1 \ |
2181 | 69aa7f21 | Ilias Tsitsimpis | --property description="Debian Squeeze Base System" \ |
2182 | 69aa7f21 | Ilias Tsitsimpis | --property size=451 --property kernel=2.6.32 --property GUI="No GUI" \ |
2183 | 8a4cd31b | Constantinos Venetsanopoulos | --property sortorder=1 --property USERS=root --property OS=debian |
2184 | 8a4cd31b | Constantinos Venetsanopoulos | |
2185 | e5d8df8c | Constantinos Venetsanopoulos | This command registers the Pithos file |
2186 | ebf463a5 | Stavros Sachtouris | ``pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump`` as an |
2187 | 73ebcd68 | Constantinos Venetsanopoulos | Image in Cyclades. This Image will be public (``--public``), so all users will |
2188 | 8a4cd31b | Constantinos Venetsanopoulos | be able to spawn VMs from it and is of type ``diskdump``. The first two |
2189 | 8a4cd31b | Constantinos Venetsanopoulos | properties (``OSFAMILY`` and ``ROOT_PARTITION``) are mandatory. All the rest |
2190 | 8a4cd31b | Constantinos Venetsanopoulos | properties are optional, but recommended, so that the Images appear nicely on |
2191 | 8a4cd31b | Constantinos Venetsanopoulos | the Cyclades Web UI. ``Debian Base`` will appear as the name of this Image. The |
2192 | 8a4cd31b | Constantinos Venetsanopoulos | ``OS`` property's valid values may be found in the ``IMAGE_ICONS`` variable |
2193 | 8a4cd31b | Constantinos Venetsanopoulos | inside the ``20-snf-cyclades-app-ui.conf`` configuration file. |
2194 | 8a4cd31b | Constantinos Venetsanopoulos | |
2195 | 8a4cd31b | Constantinos Venetsanopoulos | ``OSFAMILY`` and ``ROOT_PARTITION`` are mandatory because they will be passed |
2196 | 73ebcd68 | Constantinos Venetsanopoulos | from Cyclades to Ganeti and then `snf-image` (also see |
2197 | 8a4cd31b | Constantinos Venetsanopoulos | :ref:`previous section <ganeti-with-pithos-images>`). All other properties are |
2198 | 8a4cd31b | Constantinos Venetsanopoulos | used to show information on the Cyclades UI. |
2199 | 8a4cd31b | Constantinos Venetsanopoulos | |
2200 | 8a4cd31b | Constantinos Venetsanopoulos | Spawn a VM from the Cyclades Web UI |
2201 | 8a4cd31b | Constantinos Venetsanopoulos | ----------------------------------- |
2202 | 8a4cd31b | Constantinos Venetsanopoulos | |
2203 | 8a4cd31b | Constantinos Venetsanopoulos | If the registration completes successfully, then go to the Cyclades Web UI from |
2204 | 8a4cd31b | Constantinos Venetsanopoulos | your browser at: |
2205 | 8a4cd31b | Constantinos Venetsanopoulos | |
2206 | a14f152f | Giorgos Korfiatis | `https://node1.example.com/cyclades/ui/` |
2207 | 8a4cd31b | Constantinos Venetsanopoulos | |
2208 | 8a4cd31b | Constantinos Venetsanopoulos | Click on the 'New Machine' button and the first step of the wizard will appear. |
2209 | 8a4cd31b | Constantinos Venetsanopoulos | Click on 'My Images' (right after 'System' Images) on the left pane of the |
2210 | 8a4cd31b | Constantinos Venetsanopoulos | wizard. Your previously registered Image "Debian Base" should appear under |
2211 | 8a4cd31b | Constantinos Venetsanopoulos | 'Available Images'. If not, something has gone wrong with the registration. Make |
2212 | e5d8df8c | Constantinos Venetsanopoulos | sure you can see your Image file on the Pithos Web UI and ``kamaki image |
2213 | 8a4cd31b | Constantinos Venetsanopoulos | register`` returns successfully with all options and properties as shown above. |
2214 | 8a4cd31b | Constantinos Venetsanopoulos | |
2215 | 8a4cd31b | Constantinos Venetsanopoulos | If the Image appears on the list, select it and complete the wizard by selecting |
2216 | 8a4cd31b | Constantinos Venetsanopoulos | a flavor and a name for your VM. Then finish by clicking 'Create'. Make sure you |
2217 | 8a4cd31b | Constantinos Venetsanopoulos | write down your password, because you *WON'T* be able to retrieve it later. |
2218 | 8a4cd31b | Constantinos Venetsanopoulos | |
2219 | 8a4cd31b | Constantinos Venetsanopoulos | If everything was setup correctly, after a few minutes your new machine will go |
2220 | 8a4cd31b | Constantinos Venetsanopoulos | to state 'Running' and you will be able to use it. Click 'Console' to connect |
2221 | 8a4cd31b | Constantinos Venetsanopoulos | through VNC out of band, or click on the machine's icon to connect directly via |
2222 | 8a4cd31b | Constantinos Venetsanopoulos | SSH or RDP (for windows machines). |
2223 | 8a4cd31b | Constantinos Venetsanopoulos | |
2224 | 8a4cd31b | Constantinos Venetsanopoulos | Congratulations. You have successfully installed the whole Synnefo stack and |
2225 | 8a4cd31b | Constantinos Venetsanopoulos | connected all components. Go ahead in the next section to test the Network |
2226 | 8a4cd31b | Constantinos Venetsanopoulos | functionality from inside Cyclades and discover even more features. |
2227 | 8a4cd31b | Constantinos Venetsanopoulos | |
2228 | a96ec00f | Constantinos Venetsanopoulos | General Testing |
2229 | a96ec00f | Constantinos Venetsanopoulos | =============== |
2230 | 5b6feb88 | Vangelis Koukis | |
2231 | a96ec00f | Constantinos Venetsanopoulos | Notes |
2232 | a96ec00f | Constantinos Venetsanopoulos | ===== |