docs/source/installing.rst

   1 .. _installation:
   2
   3 Installation
   4 ============
   5
   6 Currently we have use `Fabric`, a tool for streamlining administration
   7 tasks, to deploy |gwm|.
   8
   9 Before installing |gwm|, make sure you have all the required
  10 :ref:`dependencies` installed.
  11
  12
  13 Installing
  14 ----------
  15
  16 #. Download and unpack the `latest
  17    release <http://code.osuosl.org/projects/ganeti-webmgr/files>`_,
  18    currently this is `0.9.2
  19    <https://code.osuosl.org/attachments/download/3231/ganeti-webmgr-0.9.2.tar.gz>`_.
  20
  21    ::
  22       # Use wget or curl to download from the command line.
  23       wget https://code.osuosl.org/attachements/download/3231/ganeti-webmgr-0.9.2.tar.gz
  24
  25 #. Change to the project directory.
  26
  27    ::
  28
  29        cd ganeti_webmgr
  30
  31 #. Run Fabric to automatically create a python virtual environment and
  32    install required dependencies. This may take a few minutes.
  33
  34    ::
  35
  36        # Deploy a production environment
  37        fab deploy
  38
  39    .. versionchanged:: 0.10
  40       `fab prod deploy` is now `fab deploy`. `fab dev deploy` is still
  41       the same.
  42
  43    .. Note:: If you would like a more noisy output, adding `v`, as in
  44              `fab v deploy`, will provide more verbosity.
  45
  46 #. While in the project root, copy the default settings file
  47    **settings.py.dist** to **settings.py**:
  48
  49    ::
  50
  51        cp settings.py.dist settings.py
  52
  53
  54 Minimum Configuration
  55 ---------------------
  56
  57 Getting |gwm| up and running requires a minimum configuration of a
  58 database server. If you don't have a database server available, and are
  59 fine using SQLite, you can skip this step.
  60
  61 #. Edit **settings.py** and change the database backend to your
  62    preferred database along with filling any any relevant details
  63    relating to your database setup.
  64
  65
  66    ::
  67
  68        'default': {
  69            # Add 'postgresql_psycopg2', 'postgresql', 'mysql',
  70            # 'sqlite3' or 'oracle'.
  71            'ENGINE': 'django.db.backends.',
  72
  73            # Or path to database file if using sqlite3.
  74            'NAME': 'ganeti.db',
  75
  76            # Not used with sqlite3.
  77            'USER':     '',
  78
  79            # Not used with sqlite3.
  80            'PASSWORD': '',
  81
  82            # Set to empty string for localhost. Not used with sqlite3.
  83            'HOST':     '',
  84
  85            # Set to empty string for default. Not used with sqlite3.
  86            'PORT':     '',
  87        }
  88
  89
  90 Initializing
  91 ------------
  92
  93 #. Initialize Database:
  94
  95    MySQL/SQLite:
  96
  97    ::
  98
  99        # Create new tables and migrate all apps using southdb
 100        ./manage.py syncdb --migrate
 101
 102    Postgres:
 103
 104    .. Note:: This assumes your doing a fresh install of |gwm| on a new Postgres database.
 105
 106    ::
 107
 108        ./manage.py syncdb --all
 109        ./manage.py migrate --fake
 110
 111 #. Build the search indexes
 112
 113    ::
 114
 115        ./manage.py rebuild_index
 116
 117    .. Note:: Running **./manage.py update\_index** on a regular basis
 118              ensures that the search indexes stay up-to-date when models change in
 119              Ganeti Web Manager.
 120
 121 Next Steps
 122 ----------
 123
 124 Congradulations! |gwm| is now installed and initialized. Next, you'll want
 125 to look into :ref:`configuring` and :ref:`deploying`, if you are going
 126 to be setting up a production instance. Otherwise, if you just want to
 127 play around with |gwm|, or are :ref:`developing <development>`, take a look at
 128 :ref:`test-server`.