Revision c1e8fbc4 docs/src/install.rst

b/docs/src/install.rst
4 4
This document describes the basic steps to obtain a basic, working Synnefo
5 5
deployment. 
6 6

  
7
The Synnefo Django project needs to be installed on nodes of type `APISERVER`_, 
8
`LOGIC`_ and `WEBAPP`_ nodes with properly configured  :ref:`settings`. 
7
The Synnefo package needs to be installed on nodes of type :ref:`APISERVER_NODE`, 
8
:ref:`LOGIC_NODE` and :ref:`WEBAPP_NODE` nodes with properly configured  
9
:ref:`settings <configuration>`. 
9 10

  
11
This guide also covers in some detail instructions on how to set up additional
12
additional software required by Synnefo to run properly.
10 13

  
11 14

  
12 15
Prerequisites
......
18 21
of Ganeti is not covered by this document, please refer to
19 22
`ganeti documentation <http://docs.ganeti.org/ganeti/current/html>`_ for all the 
20 23
gory details. A successful Ganeti installation concludes with a working 
21
`GANETI-MASTER`_ and a number of `GANETI-NODEs`_.
24
:ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs <GANETI_NODES>`.
22 25

  
23 26

  
24 27
Ganeti monitoring daemon
......
350 353
    $ python setup.py install
351 354

  
352 355
this should be enough for synnefo to get installed in your system-wide or
353
``virtualenv`` python packages.
356
``virtualenv`` python installation and the following commands should be 
357
available from the command line::
354 358

  
359
    $ synnefo-manage
360
    $ synnefo-dispatcher
361
    $ synnefo-admin
362

  
363
Notice that Synnefo installation does not handle the creation of
364
``/etc/synnefo/`` directory which is the place where custom configuration 
365
files are loaded from. You are encouraged to create this directory and place a 
366
file named ``settings.conf`` containing the following:
367

  
368
.. code-block:: python
369
    
370
    # database configuration
371
    DATABASES = {
372
        'default': {
373
            'ENGINE': 'django.db.backends.', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
374
            'NAME': '',                      # Or path to database file if using sqlite3.
375
            'USER': '',                      # Not used with sqlite3.
376
            'PASSWORD': '',                  # Not used with sqlite3.
377
            'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
378
            'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
379
        }
380
    }
381
    
382
    # where synnefo static files exist
383
    MEDIA_ROOT = '/var/lib/synnefo/static/'
384
    
385
    # rabitmq configuration
386
    RABBIT_HOST = ""
387
    RABBIT_USERNAME = ""
388
    RABBIT_PASSWORD = ""
389
    RABBIT_VHOST = "/"
390

  
391
    GANETI_MASTER_IP = ""
392
    GANETI_CLUSTER_INFO = (GANETI_MASTER_IP, 5080, "<username>", "<password>")
393

  
394
    # This prefix gets used when determining the instance names
395
    # of Synnefo VMs at the Ganeti backend.
396
    # The dash must always appear in the name!
397
    BACKEND_PREFIX_ID = "<prefix>-"
398

  
399
this is just to get you started on how to configure your Synnefo installation.
400
From this point you can continue your read to the `Initial configuration`_ section 
401
in this document which contains quickstart instructions for some of the initial
402
configuration required for Synnefo to get up and running.
403

  
404
For additional instructions about Synnefo settings files and what the available 
405
options are, you can refer to the :ref:`configuration` guide.
355 406

  
356 407
Initial configuration
357 408
---------------------
358 409

  
359
.. todo:: write some documentation here
410
Synnefo comes with most of the required settings predefined with values that 
411
would cover many of the most common installation scenarios. However some basic
412
settings must be set be set before running Synnefo for the first time.
360 413

  
361 414
Database
362 415
********
363 416

  
364
.. todo:: write some documentation here
417
See :ref:`database-configuration`
365 418

  
366 419
Backend
367 420
*******

Also available in: Unified diff