Merge pull request #25 from Alignak-monitoring/update

Update installation procedure
Alignak-monitoring · Jan 29, 2017 · 1d59e22 · 1d59e22
2 parents b6e8ba6 + 027266b
commit 1d59e22
Show file tree

Hide file tree

Showing 4 changed files with 145 additions and 104 deletions.
diff --git a/source/02_installation/index.rst b/source/02_installation/index.rst
@@ -13,14 +13,19 @@ Installation
     \newpage
 
 Installing Alignak is an easy process thanks to the different packagings and available procedures.
-A complete tutorial exists on the `SysAdmin.cool web site <http://sysadmin.cool/>`_.
 
 .. toctree::
    :maxdepth: 2
 
    deb_packages
    rpm_packages
-   pip
-   sources
+   sources-pip
+
+What the Alignak installation script does explained:
+
+.. toctree::
+   :maxdepth: 2
+
    what_is_it
 
+A complete tutorial exists in the `Alignak demo repository <https://github.com/Alignak-monitoring-contrib/alignak-demo>`_ or on the `SysAdmin.cool web site <http://sysadmin.cool/>`_. The Alignak demo repository is maintained up-to-date with the most recent Alignak developments whereas the tutorial is mode dedicated to a production environment.
diff --git a/source/02_installation/sources-pip.rst b/source/02_installation/sources-pip.rst
@@ -0,0 +1,91 @@
+.. _Installation/sources:
+
+========================
+Installation from source
+========================
+
+Requirements
+============
+
+Some requirements are needed to install from source:
+
+* python 2.6 or 2.7 (recommanded)
+* python-dev
+* pip
+* setuptools
+* git (only for installing from the git repository)
+
+
+Installation from the git repository
+====================================
+
+This procedure is useful only if you want to be able to hack the code base. For only installing, use the next chapter.
+
+Follow these steps:
+
+* Create user *alignak* member of group *alignak*
+* Add this user to the sudoers
+* Login with this user account::
+
+  adduser alignak
+  adduser alignak sudo
+  su - alignak
+
+* Clone the Alignak repository::
+
+    git clone https://github.com/Alignak-monitoring/alignak
+
+* cd to alignak folder::
+
+    cd alignak
+
+* Install with python (sudo needed)::
+
+    sudo pip install .
+
+
+Installation from the source
+============================
+
+Follow these steps:
+
+* Create user *alignak* member of group *alignak*
+* Add this user to the sudoers
+* Login with this user account::
+
+  adduser alignak
+  adduser alignak sudo
+  su - alignak
+
+* Get source archive on this page: https://github.com/Alignak-monitoring/alignak/releases ::
+
+    wget https://github.com/Alignak-monitoring/alignak/archive/0.2.tar.gz
+
+* Uncompress the archive ::
+
+    tar -xvf 0.2.tar.gz
+
+* cd to alignak folder ::
+
+    cd alignak-0.2
+
+* Install with python (sudo needed)::
+
+    sudo pip install .
+
+
+Install as a python lib
+=======================
+
+In a virtualenv ::
+
+  virtualenv env
+  source env/bin/activate
+  python setup.py install_lib
+  python -c 'from alignak.bin import VERSION; print(VERSION)'
+
+Or directly on your system ::
+
+  sudo python setup.py install_lib
+  python -c 'from alignak.bin import VERSION; print(VERSION)'
+
diff --git a/source/02_installation/sources.rst b/source/02_installation/sources.rst
diff --git a/source/02_installation/what_is_it.rst b/source/02_installation/what_is_it.rst
@@ -9,69 +9,74 @@ The setup script
 
 The python *setup.py* script used by Alignak does the following:
 
-* test if an `alignak` user and an `alignak` users group exist on the system
+* test if an ``alignak`` user and an ``alignak`` users group exist on the system
 
-* determine the installation directory according to the system (setuptools inner method)
+* determine the installation directory ``prefix`` according to the system (most often it is */usr/local*)
 
-* create a */etc/default/alignak* main configuration file (only on non FreeBSD platform):
-    - copy the *bin/default/alignak.in* file
-    - update the main variable directories according to the used installation directory
+* copy the alignak default configuration files in *prefix/etc/alignak* and update some files:
 
-* copy the alignak default configuration files in */etc/alignak* and update some files:
+    - update the *alignak.ini* file according to the used installation directory
     - update the *alignak.cfg* file according to the used installation directory
     - update the *daemons/*.ini* files according to the used installation directory
     - update the *paths.cfg* file with the Alignak plugins directory
 
-Files / directories lists
-=========================
+Installation procedure
+======================
 
-All the variables introduced here are prefixed with the installation directory. Most often, this intallation directory is */usr/local*.
+First step - installation directories
+-------------------------------------
 
-Variables to update *default/alignak*::
+Some variables are used by the installation script to update some of the installed files. All these variables are prefixed with the installation directory ``prefix``, except for the ``USER`` and ``GROUP`` variables.
 
-    'ETC': '/etc/alignak',
-    'VAR': '/var/lib/alignak',
+Default variables values::
+
+    'USER': 'alignak',
+    'GROUP': 'alignak',
     'BIN': '/bin',
+    'ETC': '/etc/alignak',
+    'VAR': '/var/libexec/alignak',
     'RUN': '/var/run/alignak',
-    'LOG': '/var/log/alignak',
-    'LIB': '/var/libexec/alignak',
-
-
-Variables to update *alignak.cfg* and *daemons.ini* files::
+    'LOG': '/var/log/alignak'
 
-    'workdir': '/var/run/alignak',
-    'logdir': '/var/log/alignak',
-    'modules_dir': '/var/lib/alignak/modules',
-    'plugins_dir': '/var/libexec/alignak',
+If it exists an */etc/default/alignak* or */usr/local/etc/default/alignak* file on the system, the the variables are updated with their existing respective values defined in this file. This file may exist from a former installation of Alignak on a system using the init.d script system. Most often, this file will not exist on your system and the variables will keep their default values!
 
-    'lock_file': '/var/run/alignak/arbiterd.pid',
-    'local_log': '/var/log/alignak/arbiterd.log',
-    'pidfile': '/var/run/alignak/arbiterd.pid',
+Second step - updating macro definitions
+----------------------------------------
 
-    'pack_distribution_file': '/var/lib/alignak/pack_distribution.dat'
+All the **.cfg* files located in the *etc/alignak* directory and its sub-directories are parsed to be updated. If they contain a line starting with a macro declaration for one of the script variables, this line is replaced with the variable value. As an example:
+::
 
-    'ca_cert': '/etc/alignak/certs/ca.pem',
-    'server_cert': '/etc/alignak/certs/server.cert',
-    'server_key': '/etc/alignak/certs/server.key',
+    #-- Alignak main directories
+    #-- Those macros are automatically updated during the Alignak installation
+    #-- process (eg. python setup.py install)
+    $BIN$=/usr/local/bin
+    $ETC$=/usr/local/alignak/etc
+    $VAR$=/usr/local/var
+    $RUN$=$VAR$/run
+    $LOG$=$VAR$/log
 
-**Note:** The last three variables concern SSL and they are replaced and stay commented in the configuration files.
+    $USER$=alignak
+    $GROUP$=alignak
 
+This allows to add those macro definition in any configuration located in the Alignak configuration. Currently, only the *etc/alignak/arbiter/resource.d/paths.cfg* file is including those macros.
 
-Variables to update *alignak.cfg* and *daemons.ini* files with user credentials::
 
-    'alignak_user'
-    'alignak_group'
-    'user'
-    'group'
-    'ALIGNAKUSER'
-    'ALIGNAKGROUP'
+Third step - updating configuration
+-----------------------------------
 
-**Note:** Those variables are intended for macro definition and they are replaced with *$name$*.
+All the **.in* files located in the *etc/alignak* directory are parsed to be updated. If they contain a line starting with one of the script variables, this line is replaced with the variable value. As an example:
+::
 
+    [DEFAULT]
+    BIN=../alignak/bin
+    ETC=../etc
+    VAR=/tmp
+    RUN=/tmp
+    LOG=/tmp
+    USER=alignak
+    GROUP=alignak
 
-Variables to update *resource.d/paths.cfg*::
 
-    'LOGSDIR': '/var/log/alignak',
-    'PLUGINSDIR': '/var/libexec/alignak',
+This allows to add those macro definition in any configuration located in the Alignak configuration. Currently, only the *etc/alignak/alignak.ini* file and all the files located in the *etc/aligank/daemons* directory are concerned.
 
-**Note:** Those variables are intended for macro definition and they are replaced with *$name$*.
+**Note:** For the **.ini* files, the script also replaces the *workdir* , *logdir* and *etcdir* variables and they are respectively replaced with *RUN*, *LOG* and *ETC* variables values.