From 1dbba93297557b0ca1421cefbb624effda6ee23c Mon Sep 17 00:00:00 2001 From: Laurent Pinsivy Date: Mon, 22 May 2017 08:54:20 +0100 Subject: [PATCH 1/2] Correct make html warning/error for EN documentation --- doc/en/administration_guide/02e.rst | 1 + .../03stats.rst | 0 doc/en/administration_guide/backup.rst | 20 +- doc/en/administration_guide/index.rst | 3 +- .../partitioning/index.rst | 1 - doc/en/api/clapi/objects/engine_cfg.rst | 3 +- doc/en/api/clapi/objects/index.rst | 5 +- .../api/clapi/objects/service_templates.rst | 4 +- doc/en/api/restApi/index.rst | 17 -- .../advanced_configuration/macros.rst | 1 + .../advanced_configuration/metaservices.rst | 1 + doc/en/configuration_guide/category.rst | 2 + doc/en/configuration_guide/imp/index.rst | 2 +- .../configuration_guide/poller/03wizards.rst | 3 - doc/en/developer/index.rst | 1 - doc/en/exploitation_guide/general/index.rst | 2 - .../exploitation_guide/monitoring/index.rst | 12 - doc/en/extendcentreon/index.rst | 11 - doc/en/extendcentreon/writemodule.rst | 132 --------- doc/en/extendcentreon/writewidget.rst | 253 ------------------ doc/en/installation/from_centreon.rst | 4 +- doc/en/installation/from_packages.rst | 29 +- doc/en/installation/from_sources.rst | 12 +- doc/en/installation/index.rst | 1 - doc/en/installation/prerequisites.rst | 1 + doc/en/life_cycle.rst | 2 +- doc/en/migration/index.rst | 2 - doc/en/quick_start/add_host.rst | 1 + doc/en/quick_start/add_host_from_template.rst | 1 + doc/en/quick_start/login.rst | 1 + doc/en/release_notes/centreon-2.4/index.rst | 1 - .../centreon-2.5/centreon-2.5.1.rst | 8 +- .../centreon-2.7/centreon-2.7.0.rst | 15 +- .../centreon-2.8/centreon-2.8.6.rst | 2 +- doc/en/release_notes/centreon-2.8/index.rst | 1 + 35 files changed, 64 insertions(+), 491 deletions(-) rename doc/en/{exploitation_guide => administration_guide}/03stats.rst (100%) delete mode 100644 doc/en/api/restApi/index.rst delete mode 100644 doc/en/exploitation_guide/monitoring/index.rst delete mode 100644 doc/en/extendcentreon/index.rst delete mode 100644 doc/en/extendcentreon/writemodule.rst delete mode 100644 doc/en/extendcentreon/writewidget.rst diff --git a/doc/en/administration_guide/02e.rst b/doc/en/administration_guide/02e.rst index 750c149ec94..e97d8915758 100644 --- a/doc/en/administration_guide/02e.rst +++ b/doc/en/administration_guide/02e.rst @@ -1,4 +1,5 @@ .. _centreon_parameters: + =============================================== Administration options of the Centreon platform =============================================== diff --git a/doc/en/exploitation_guide/03stats.rst b/doc/en/administration_guide/03stats.rst similarity index 100% rename from doc/en/exploitation_guide/03stats.rst rename to doc/en/administration_guide/03stats.rst diff --git a/doc/en/administration_guide/backup.rst b/doc/en/administration_guide/backup.rst index 6462fd6d08c..67f1b71301e 100644 --- a/doc/en/administration_guide/backup.rst +++ b/doc/en/administration_guide/backup.rst @@ -59,7 +59,7 @@ This part covers the configuration of centreon-backup. The following window is displayed: .. image:: /images/guide_exploitation/backup.png -:align: center + :align: center * **Backup enabled** Enable/Disable backup * **Backup directory** Directory where backup will be stored @@ -79,18 +79,16 @@ The following window is displayed: * **Remote directory** Remote directory for SCP export .. warning:: - **Temporary directory** can not be a folder of **Backup directory**. - ********************************** Restore of Centreon central server ********************************** Restore process is divided in two main steps: -* Re-install the Centreon platform following the installation documentation. Do not forget to upgrade system. -* Restore Centreon-Engines configuration files and Centreon databases +* Re-install the Centreon platform following the installation documentation. Do not forget to upgrade system. +* Restore Centreon-Engines configuration files and Centreon databases Configurations file restore =========================== @@ -120,13 +118,13 @@ Once Centreon server reinstalled (**same Centreon version**), unzip centreon and # gzip -d YYYY-MM-DD-centreon_storage.sql.gz # mysql centreon_storage < YYYY-MM-DD-centreon_storage.sql -.. note:: -Password is stored in configuration files previously restored. For example **$mysql_passwd** field in file "/etc/centreon/conf.pm". +This may take a while due to the size of "centreon_storage" databases. -Chis may take a while due to the size of "centreon_storage" databases. +.. note:: + Password is stored in configuration files previously restored. For example **$mysql_passwd** field in file "/etc/centreon/conf.pm". .. note:: -The default configuration does not define any password for mysql root user. That's why we can connect to database using only command "mysql". + The default configuration does not define any password for mysql root user. That's why we can connect to database using only command "mysql". SSH keys restore ================ @@ -150,7 +148,7 @@ Connection test from central to poller:: Answer "Yes" to the ask question. This is about add poller print on the central server. .. note:: -You have to do this operations only if you work with a distributed environment. + You have to do this operations only if you work with a distributed environment. Plugins restore =============== @@ -189,7 +187,7 @@ In case you're using NRPE or NSCA agents, you have to reinstall and then restore # cp nsca.cfg /etc/centreon-engine/ .. note:: -You have to do this only if you're using the monitoring agents. + You have to do this only if you're using the monitoring agents. Generate Centreon-Engine configuration files within centreon ============================================================ diff --git a/doc/en/administration_guide/index.rst b/doc/en/administration_guide/index.rst index 3761091b62e..932588f6dbe 100644 --- a/doc/en/administration_guide/index.rst +++ b/doc/en/administration_guide/index.rst @@ -8,13 +8,11 @@ Administration :maxdepth: 2 :glob: - 02a 02b 02c 02d 02e 02f - 02g 02h 02i 02j @@ -22,3 +20,4 @@ Administration 02l backup partitioning/index + 03stats diff --git a/doc/en/administration_guide/partitioning/index.rst b/doc/en/administration_guide/partitioning/index.rst index 3c3abca5f61..40953504143 100644 --- a/doc/en/administration_guide/partitioning/index.rst +++ b/doc/en/administration_guide/partitioning/index.rst @@ -68,6 +68,5 @@ Contents: .. toctree:: :maxdepth: 2 - prerequisite/index user/index diff --git a/doc/en/api/clapi/objects/engine_cfg.rst b/doc/en/api/clapi/objects/engine_cfg.rst index 9dc2b441e17..d4d365873a9 100644 --- a/doc/en/api/clapi/objects/engine_cfg.rst +++ b/doc/en/api/clapi/objects/engine_cfg.rst @@ -29,8 +29,7 @@ Order Description 3 Instance that is linked to centreon-engine.cfg 4 Comments regarding the configuration file -======= ============================================== - +======= =============================================== Add --- diff --git a/doc/en/api/clapi/objects/index.rst b/doc/en/api/clapi/objects/index.rst index 78800fe021d..5ff15e93fb1 100644 --- a/doc/en/api/clapi/objects/index.rst +++ b/doc/en/api/clapi/objects/index.rst @@ -10,13 +10,13 @@ Object management acl_menu acl_resource broker_cfg - cgi_cfg commands contacts contact_templates contact_groups dependencies downtimes + engine_cfg host_templates hosts host_categories @@ -24,9 +24,6 @@ Object management host_group_services instances ldap_servers - nagios_cfg - ndo2db_cfg - ndomod_cfg resource_cfg service_templates services diff --git a/doc/en/api/clapi/objects/service_templates.rst b/doc/en/api/clapi/objects/service_templates.rst index 6e1325463fe..1af945a1ac9 100644 --- a/doc/en/api/clapi/objects/service_templates.rst +++ b/doc/en/api/clapi/objects/service_templates.rst @@ -150,7 +150,7 @@ first_notification_delay First notification delay in seconds recovery_notification_delay Recovery notification delay -parallelize_checks 1 when parallelize checks are enabled, 0 otherwise +parallelize_check 1 when parallelize checks are enabled, 0 otherwise obsess_over_service 1 when obsess over service is enabled, 0 otherwise @@ -198,7 +198,7 @@ service_notification_options Notification options (w,u,c,r,f,s) .. note:: You need to generate your configuration file and restart monitoring engine in order to apply changes. -.. _addhosttemplate-and-sethosttemplate +.. _addhosttemplate-and-sethosttemplate: Addhosttemplate and Sethosttemplate ----------------------------------- diff --git a/doc/en/api/restApi/index.rst b/doc/en/api/restApi/index.rst deleted file mode 100644 index e6c13e6b3b0..00000000000 --- a/doc/en/api/restApi/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -======== -Rest API -======== - -The Rest API is a Centreon API that enables users to configure their monitoring system through HTTP. - -This documentation aims to introduce all the actions you can perform with Centreon CLAPI, from adding host objects to restarting a remote monitoring poller. - -Contents: - -.. toctree:: - :maxdepth: 1 - - overview - engine_management - objects/index - import_export.rst diff --git a/doc/en/configuration_guide/advanced_configuration/macros.rst b/doc/en/configuration_guide/advanced_configuration/macros.rst index a7740f3959f..c0e829ae79a 100644 --- a/doc/en/configuration_guide/advanced_configuration/macros.rst +++ b/doc/en/configuration_guide/advanced_configuration/macros.rst @@ -36,6 +36,7 @@ There are several advantages to using customised macros instead of arguments: * The function of the macro is defined in its name. The macro $_HOSTMOTDEPASSEINTRANET$ is easier to read than $ARG1$ * The macros inherit models of hosts and of services, the hence it is possible to modify a single macro for a host or a service. On the other hand, the arguments all need to be redefined if a single argument is changed * The number of arguments is limited to 32, unlike customised macros which are unlimited + A macro of a host is used to define a variable that is specific to the host and which will not change regardless of the service questioned: host connection identifiers, a port of connection to a particular service, an SNMP community, etc. A macro of a service is used more to define settings specific to a service: a WARNING / CRITICAL threshold, a partition to be questioned, etc. diff --git a/doc/en/configuration_guide/advanced_configuration/metaservices.rst b/doc/en/configuration_guide/advanced_configuration/metaservices.rst index 3424579f4d1..660db931a81 100644 --- a/doc/en/configuration_guide/advanced_configuration/metaservices.rst +++ b/doc/en/configuration_guide/advanced_configuration/metaservices.rst @@ -102,6 +102,7 @@ If you have chosen the option **Service list**, in the screen containing all the * The **Host** field serves to select the host to which the service to be selected belongs. * The **Service** field serves to choose the service (first list) as well as the metric in this service (second list). * The **Status** and **Comment** fields serve to enable / disable or comment on the indicator. + 3. Repeat the operation until you have added all the indicators necessary for the calculation of the meta-service. .. note:: diff --git a/doc/en/configuration_guide/category.rst b/doc/en/configuration_guide/category.rst index 5fb52c59d66..49c54538ff7 100644 --- a/doc/en/configuration_guide/category.rst +++ b/doc/en/configuration_guide/category.rst @@ -28,6 +28,8 @@ To add a category of hosts: * The **Level** and **Icon** fields define a criticality level and an associated icon respectively. * The **Status** and **Comment** fields allow us to enable or disable the category of host and to comment on it. +.. _servicecategory: + ********************** Categories of services ********************** diff --git a/doc/en/configuration_guide/imp/index.rst b/doc/en/configuration_guide/imp/index.rst index 7f60a198e57..aa5a04553a4 100644 --- a/doc/en/configuration_guide/imp/index.rst +++ b/doc/en/configuration_guide/imp/index.rst @@ -113,7 +113,7 @@ Your account is now available. You can link your Centreon platform. .. image:: /_static/images/configuration/website/create_account_05.png :width: 1000 px - :align: center + :align: center 2. Link your Centreon platform ------------------------------ diff --git a/doc/en/configuration_guide/poller/03wizards.rst b/doc/en/configuration_guide/poller/03wizards.rst index 8a461e6e74f..36cc22b9011 100644 --- a/doc/en/configuration_guide/poller/03wizards.rst +++ b/doc/en/configuration_guide/poller/03wizards.rst @@ -42,9 +42,6 @@ Configuration of a poller for a distributed architecture :align: center :alt: Schema distributed monitoring -.. note:: - :alt: Schema distributed monitoring - #. Choose **Simple poller** #. Enter a name for the configuration #. Select a poller diff --git a/doc/en/developer/index.rst b/doc/en/developer/index.rst index 9c988ad0ae0..99631e8ff35 100644 --- a/doc/en/developer/index.rst +++ b/doc/en/developer/index.rst @@ -7,4 +7,3 @@ Developer writemodule writewidget - develop-a-plugin.rst diff --git a/doc/en/exploitation_guide/general/index.rst b/doc/en/exploitation_guide/general/index.rst index 019c01a94c7..e2ceef923ef 100644 --- a/doc/en/exploitation_guide/general/index.rst +++ b/doc/en/exploitation_guide/general/index.rst @@ -1,5 +1,3 @@ -.. _configuration_start: - ####### General ####### diff --git a/doc/en/exploitation_guide/monitoring/index.rst b/doc/en/exploitation_guide/monitoring/index.rst deleted file mode 100644 index 0286c77a7a6..00000000000 --- a/doc/en/exploitation_guide/monitoring/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -========== -Monitoring -========== - -.. toctree:: - :maxdepth: 2 - :glob: - - 01customview - 03stats - 04realtime - 05logs diff --git a/doc/en/extendcentreon/index.rst b/doc/en/extendcentreon/index.rst deleted file mode 100644 index af04996ef82..00000000000 --- a/doc/en/extendcentreon/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -=============================================== -Comment développer des extensions pour Centreon -=============================================== - -Ce chapitre est une reprise sans traduction de la documentation anglaise. - -.. toctree:: - :maxdepth: 2 - - writemodule - writewidget diff --git a/doc/en/extendcentreon/writemodule.rst b/doc/en/extendcentreon/writemodule.rst deleted file mode 100644 index 1d2a2e1330b..00000000000 --- a/doc/en/extendcentreon/writemodule.rst +++ /dev/null @@ -1,132 +0,0 @@ -===================== -How to write a module -===================== - -You want to create a new module for Centreon 2 or to adapt an existing -one? You're at the right place! - -You should know Centreon contains a page dedicated to the installation -and the uninstallation of modules (*Administration > Modules*). To -make the module appears on this page, its directory must be placed -inside Cetreon's ``modules/`` directory. Example:: - - /usr/local/centreon/www/modules/module-Dummy - - An empty module template can be found inside `Centreon's repository - `_. - - ***** - Basis - ***** - - The essential elements your module's directory must contain are presented below (\* = required): - - **[conf.php]\***:: - - // Short module's name. Must be equal to your module's directory name - $module_conf['dummy']['name'] = "dummy"; - // Full module's name - $module_conf['dummy']['rname'] = "Dummy Module"; - // Module's version - $module_conf['dummy']['mod_release'] = "2.0"; - // Additional information - $module_conf['dummy']['infos'] = "First of all"; - // Allow your module to be uninstalled - $module_conf['dummy']['is_removeable'] = "1"; - // Module author's name - $module_conf['dummy']['author'] = "Centreon Team"; - // 1: the module executes an SQL file for installation and/or uninstallation - // 0: the module doesn't execute any SQL file - $module_conf['dummy']['sql_files'] = "1"; - // 1: the module executes a PHP file for installation and/or uninstallation - // 0: the module doesn't execute any SQL file - $module_conf['dummy']['php_files'] = "1"; - -**[infos > infos.txt]** - -This file can contain various information about your module. - -**[php > install.php]** - -This PHP file is executed at module installation if it is configured -inside the *conf.php* file. - -**[php > uninstall.php]** - -This PHP file is executed at module uninstallation if it is configured -inside the *conf.php* file. - -**[sql > install.sql]** - -This SQL file is executed during the module installation if it is -configured inside the *conf.php* file. If you want your module to be -available from Centreon menus, you must insert new entries into the -``topology`` table of the ``centreon`` database. An example is -available inside the ``Dummy`` module. - -**[sql > uninstall.sql]** - -This SQL file is executed during the module uninstallation if it is -configured inside the *conf.php* file. It can also remove your module -from Centreon menus. - -**[generate_files > \*.php]** - -The PHP files contained inside the ``generate_files`` directory will -be executed during the configuration files generation (inside -*Configuration > Monitoring Engines*). Those files must generate -configuration files. - -**[UPGRADE > dummy-x.x > sql > upgrade.sql]** - -Centreon provides an upgrade system for modules. To use it, just add a -directory under ``UPGRADE`` named using the following pattern: -``-``. When clicking on the upgrade button, -Centreon will search for scripts to execute, following the logical -order of versions. - -For example, if the version 1.0 of the dummy module is installed and -the following directories exist:: - - $ ls UPGRADE - dummy-1.1 dummy-1.2 - -Centreon will execute the scripts in the following order : 1.1, 1.2. A -configuration file in each upgrade directory is present in order to -allow (or not) the execution. - -You're free to organize the remaining files (your module's content) as -you like. - -******** -Advanced -******** - -That's great, you know how to install a module! As an empty module is -not really usefull, put your imagination at work. Knowing that you can -do almost everything, it should not be too complicated :-). - -Connecting to the database -========================== - -You can use the ``centreon``, ``centstorage`` and ``ndo`` databases by -calling the following file: ``centreon/www/class/centreonDB.class.php``. - -For example, execute requests like this: - -.. sourcecode:: php - - query("SELECT * FROM host"); - ?> - -Existing functions -================== - -You can access most of the functions already developed within Centreon -using ``include()`` statements. They're generally stored in -``centreon/www/class/``. - -Before developing your own function, check the existing code, it could -spare your time! diff --git a/doc/en/extendcentreon/writewidget.rst b/doc/en/extendcentreon/writewidget.rst deleted file mode 100644 index c892f8cf0b9..00000000000 --- a/doc/en/extendcentreon/writewidget.rst +++ /dev/null @@ -1,253 +0,0 @@ -===================== -How to write a widget -===================== - -Centreon (since version 2.4) offers a custom view system which allows -user to view one or different widgets in the same page : *Home > -Custom views*. - -You may have specific needs that are not yet covered by our widget -catalog and this tutorial will explain to you how to write your first -widget for Centreon. - -*********************************** -Should I make a widget or a module? -*********************************** - -If you are wondering if you should be making a module or a widget, -then ask yourself if your project is meant to contain many menus or is -it rather a plain page which is going to display little information? - -Of course, you could make a widget that would only work with a certain -module. - -******************* -Directory structure -******************* - -Widgets work pretty much like Modules. They have to be placed in -the following directory:: - - # centreon/www/widgets/nameOfYourWidget/ - -Your widget must contain one mandatory file named **configs.xml** at its root. - -****************** -Configuration file -****************** - -This is the XML configuration file of our Dummy widget: - -.. code-block:: xml - - - Dummy - Centreon - contact@centreon.com - http://www.centreon.com - Dummy widget - 1.0.3 - dummy, widget, centreon - - ./widgets/dummy/resources/logoCentreon.png - ./widgets/dummy/index.php - - - - - - - - - - - - - -Now, let's see what these tags refer to. - -Basic tags -========== - -\* = Mandatory tag - -============== ================================================================ -Tag nameDescription -============== ================================================================ -title* Title of your widget - -author* Your name - -email Your email address - -website URL of your project - -description* Short description of your widget - -version* Version of your widget. Increment this number whenever you - publish a new version. - -keywords A few key words that describe your widget - -screenshot Screenshot that shows the best side of your widget. Screenshot - should be placed within your widget directory. - -thumbnail Logo of your project. Best size is 100px x 25px. Thumbnail - shoud be placed within your widget directory. - -url* Path of the main page of your widget - -autorefresh This parameter is not implemented yet -============== ================================================================ - -Parameter attributes -==================== - -\* = *Mandatory parameter* - -====================== ======================================================== -Tag attributes Description -====================== ======================================================== -label* Label of the parameter - -name* Name of the parameter that will be used for retrieving - its value - -defaultValue* Default Value of the parameter - -requirePermission Value can be "1" or "0". When set to 1, this parameter - will not be shown to unauthorized users. - -type* Parameter type, must be one of the following: - text,boolean,date,list,range,compare,host,hostgroup, - hostTemplate,servicegroup,serviceTemplate - -min* For range type only. It refers to the minimum value - of the range parameter - -max* For range type only. It refers to the maximum value - of the range parameter - -step* For range type only. It refers to the step value of - the range parameter -====================== ======================================================== - -Parameter type -============== - -====================== ======================================================== -Type name Description -====================== ======================================================== -text Renders a text input element - -boolean Renders a checkbox - -date Renders two text input elements. One for the date of - start, the other one for the date of end. - -list Renders a selectbox. The selectbox will be populated - with the option tags which have to be defined within the - preference tag. - -range Renders a selectbox which will be populated with values - depending on the min, max and step definitions. - -compare Renders a selectbox and a text input. Selectbox will - contain SQL operands such as:: - - > : greater than - < : less than - >= : greater or equal - <= : less or equal - = : equal - != : not equal - LIKE : can be used with the wildcard %% - NOT LIKE : can be used with the wildcard %% - -host Renders a selectbox populated with a list of hosts. - -hostgroup Renders a selectbox populated with a list of hostgroups. - -hostTemplate Renders a selectbox populated with a list of host - templates. - -servicegroup Renders a selectbox populated with a list of - servicegroups. - -serviceTemplate Renders a selectbox populated with a list of service - templates. -====================== ======================================================== - -The preference window would look like this as a result: - -.. image:: /_static/images/extending/pref_dummy_widget.png - :align: center - -**** -Code -**** - -All langages are separated in differents files, one file for each langage. The file "configs.xml" call the php's file and the php's file call html's file etc... - -We use Smarty, it's an engine and template'php compiler (http://smarty.net). - - -To use Smarty you need to : - -.. source-code:: php - - require_once $centreon_path . 'GPL_LIB/Smarty/libs/Smarty.class.php'; - -1.configuration of smarty: - -.. source-code:: php - - $path = $centreon_path . "www/widgets/Dummy/src/"; - $template = new Smarty(); - $template = initSmartyTplForPopup($path, $template, "./", $centreon_path); - -2.creating php template to be use in html: - -.. source-code:: php - - $template->assign('widgetId', $widgetId); - $template->assign('autoRefresh', $autoRefresh); - $template->assign('data', $data); - -3.affectation of html's file to execute: - -.. source-code:: php - - $template->display('dummy.ihtml'); - - -To call template php's variable in the html look dummy.ihtml - -To do request in database: - -initialization of databases's centreon, centreon storage and recovering preferences: - -.. sourcecode:: php - - try { - global $pearDB; - - $db_centreon = new CentreonDB("centreon"); - $db = new CentreonDB("centstorage"); - $pearDB = $db_centreon; - - $widgetObj = new CentreonWidget($centreon, $db_centreon); - $preferences = $widgetObj->getWidgetPreferences($widgetId); - $autoRefresh = 0; - if (isset($preferences['refresh_interval'])) { - $autoRefresh = $preferences['refresh_interval']; - } - } catch (Exception $e) { - echo $e->getMessage() . "
"; - exit; - } - -then request in database with class' methods. - diff --git a/doc/en/installation/from_centreon.rst b/doc/en/installation/from_centreon.rst index 1a890ea3a4e..ee4219e670c 100644 --- a/doc/en/installation/from_centreon.rst +++ b/doc/en/installation/from_centreon.rst @@ -262,7 +262,7 @@ Centreon IMP needs the technical components Centreon License Manager and Centreon Plugin Pack Manager to work. Install packages ----------------- +================ When using Centreon ISO, installation of Centreon Plugin Pack Manager is very easy. You'll see that Centreon License Manager will be installed too @@ -273,7 +273,7 @@ as a dependency. $ yum install centreon-pp-manager Web install ------------ +=========== Once the packages installed, you need to enable the module in Centreon. So get to the Administration -> Extensions -> Modules page. diff --git a/doc/en/installation/from_packages.rst b/doc/en/installation/from_packages.rst index ec26ea73180..a500dca9488 100644 --- a/doc/en/installation/from_packages.rst +++ b/doc/en/installation/from_packages.rst @@ -17,7 +17,7 @@ To install Centreon software from the repository, you should first install the f Perform the following command from a user with sufficient rights. Centreon Repository --------------- +------------------- For CentOS 6. @@ -189,41 +189,43 @@ Web Installation The End of installation wizard of Centreon is displayed, click on **Next**. -.. image :: /images/user/acentreonwelcome.png +.. image:: /images/user/acentreonwelcome.png :align: center :scale: 85% The End of installation wizard of Centreon checks the availability of the modules, click on **Next**. -.. image :: /images/user/acentreoncheckmodules.png +.. image:: /images/user/acentreoncheckmodules.png :align: center :scale: 85% Click on **Next**. -.. image :: /images/user/amonitoringengine2.png +.. image:: /images/user/amonitoringengine2.png :align: center :scale: 85% Click on **Next**. -.. image :: /images/user/abrokerinfo2.png +.. image:: /images/user/abrokerinfo2.png :align: center :scale: 85% Define the data concerning the admin user, click on **Next**. -.. image :: /images/user/aadmininfo.png +.. image:: /images/user/aadmininfo.png :align: center :scale: 85% By default, the ‘localhost’ server is defined and the root password is empty. If you use a remote database server, these two data entries must be changed. In our box, we only need to define a password for the user accessing the Centreon databases, i.e. ‘Centreon’, click on **Next**. -.. image :: /images/user/adbinfo.png +.. image:: /images/user/adbinfo.png :align: center :scale: 85% -If the following error message appears: **Add innodb_file_per_table=1 in my.cnf file under the [mysqld] section and restart MySQL Server.** Perform the following operation: +If the following error message appears: **Add innodb_file_per_table=1 in my.cnf file under the [mysqld] section and restart MySQL Server.** + +Perform the following operation: 1. Log-on to the ‘root’ user on your server @@ -235,8 +237,6 @@ If the following error message appears: **Add innodb_file_per_table=1 in my.cnf 3. Add these lines to the file -.. raw:: latex - :: [mysqld] @@ -252,7 +252,7 @@ If the following error message appears: **Add innodb_file_per_table=1 in my.cnf The End of installation wizard configures the databases, click on **Next**. -.. image :: /images/user/adbconf.png +.. image:: /images/user/adbconf.png :align: center :scale: 85% @@ -260,13 +260,13 @@ The installation is finished, click on Finish. At this stage a publicity allows to know the latest Centreon . If your platform is connected to the Internet you have the latest information , if the information present in this version will be offered. -.. image :: /images/user/aendinstall.png +.. image:: /images/user/aendinstall.png :align: center :scale: 85% You can now log in. -.. image :: /images/user/aconnection.png +.. image:: /images/user/aconnection.png :align: center :scale: 85% @@ -286,6 +286,7 @@ To start monitoring engine : :: service cbd start + 8. Start Centreon Engine :: @@ -306,7 +307,7 @@ Introduction to the web interface Centreon web interface is made up of several menus, each menu has a specific function: -.. image :: /images/user/amenu.png +.. image:: /images/user/amenu.png :align: center | diff --git a/doc/en/installation/from_sources.rst b/doc/en/installation/from_sources.rst index 41d666e74eb..2ebad55b6a4 100644 --- a/doc/en/installation/from_sources.rst +++ b/doc/en/installation/from_sources.rst @@ -148,7 +148,7 @@ Install this Stream Multiplexers before continuing with the installation. Centreon ******** -Download the latest version of Centreon :ref:`here `. +Download the latest version of Centreon `here `_. Shell Installation @@ -238,7 +238,7 @@ Answer [y] to all the questions. Definition of installation paths --------------------------------- + -------------------------------- :: @@ -323,7 +323,7 @@ Monitoring user --------------- This is the user used to run the monitoring engine (Centreon Engine). If you followed the -`official installation procedure `_ +`Centreon Engine official installation procedure `_ the user will likely be *centreon-engine*. :: @@ -333,7 +333,7 @@ the user will likely be *centreon-engine*. > This is the user used to run the stream broker (Centreon Broker). If you followed the -`official installation procedure `_ +`Centreon Broker official installation procedure `_ the user will likely be *centreon-broker*. :: @@ -681,7 +681,7 @@ SELinux should be disabled; for this, you have to modify the file "/etc/sysconfi :: - SELINUX=disabled + SELINUX=disabled After saving the file, please reboot your operating system to apply the changes. @@ -689,7 +689,7 @@ PHP timezone should be set; go to /etc/php.d directory and create a file named p :: - date.timezone = Europe/Paris + date.timezone = Europe/Paris After saving the file, please don't forget to restart apache server. diff --git a/doc/en/installation/index.rst b/doc/en/installation/index.rst index b302d93befa..f4acef31076 100644 --- a/doc/en/installation/index.rst +++ b/doc/en/installation/index.rst @@ -16,7 +16,6 @@ Finally, you can install the platform. prerequisites architecture/index - installation/index downloads from_centreon from_packages diff --git a/doc/en/installation/prerequisites.rst b/doc/en/installation/prerequisites.rst index a6190780486..53e4e4ce7e5 100644 --- a/doc/en/installation/prerequisites.rst +++ b/doc/en/installation/prerequisites.rst @@ -63,6 +63,7 @@ The following table describes the dependent software: +----------+------------------+ | zlib | 1.2.3 | +----------+------------------+ + *************************** Select type of architecture *************************** diff --git a/doc/en/life_cycle.rst b/doc/en/life_cycle.rst index a6667775729..3be8c0f5820 100644 --- a/doc/en/life_cycle.rst +++ b/doc/en/life_cycle.rst @@ -29,7 +29,7 @@ This rule aims to provide operational support for around 2 years. +-----------------+---------------------------------------------------------+ | | Help and support non guaranteed |br| | | UNSUPPORTED | No fix(es) delivery | -| | | +| | | +-----------------+---------------------------------------------------------+ |br|\ diff --git a/doc/en/migration/index.rst b/doc/en/migration/index.rst index 4611bd0bcc8..6ad1d60ee8d 100644 --- a/doc/en/migration/index.rst +++ b/doc/en/migration/index.rst @@ -1,5 +1,3 @@ -.. _install: - ################################# Migration from Nagios to Centreon ################################# diff --git a/doc/en/quick_start/add_host.rst b/doc/en/quick_start/add_host.rst index 313d6ea0f49..770d20cc2d6 100644 --- a/doc/en/quick_start/add_host.rst +++ b/doc/en/quick_start/add_host.rst @@ -1,4 +1,5 @@ .. _add_host: + ========== Add a host ========== diff --git a/doc/en/quick_start/add_host_from_template.rst b/doc/en/quick_start/add_host_from_template.rst index 38be38b8b7b..93d1c08b32c 100644 --- a/doc/en/quick_start/add_host_from_template.rst +++ b/doc/en/quick_start/add_host_from_template.rst @@ -1,4 +1,5 @@ .. _add_host_template: + ============================= Deploy a host from a template ============================= diff --git a/doc/en/quick_start/login.rst b/doc/en/quick_start/login.rst index 760db8e72e4..ef3a6654d07 100644 --- a/doc/en/quick_start/login.rst +++ b/doc/en/quick_start/login.rst @@ -1,4 +1,5 @@ .. _centreon_login: + ===== Login ===== diff --git a/doc/en/release_notes/centreon-2.4/index.rst b/doc/en/release_notes/centreon-2.4/index.rst index 9a1d16d4077..b93ad0a3b1c 100644 --- a/doc/en/release_notes/centreon-2.4/index.rst +++ b/doc/en/release_notes/centreon-2.4/index.rst @@ -9,7 +9,6 @@ Please find here the release notes dedicated to the last 2.4.x version of Centre centreon-2.4.5 centreon-2.4.4 - centreon-2.4.2 centreon-2.4.1 centreon-2.4.0 diff --git a/doc/en/release_notes/centreon-2.5/centreon-2.5.1.rst b/doc/en/release_notes/centreon-2.5/centreon-2.5.1.rst index 05d1d86a6ac..b90b9b17f3e 100644 --- a/doc/en/release_notes/centreon-2.5/centreon-2.5.1.rst +++ b/doc/en/release_notes/centreon-2.5/centreon-2.5.1.rst @@ -8,9 +8,9 @@ WARNING If you are upgrading from Centreon 2.5.0 make sure to read the following. -.. DANGER:: -If you are upgrading from a version prior to 2.5.0, just skip this notice and follow this procedure instead: -`https://blog.centreon.com/centreon-2-5-0-release/ `_. +.. WARNING:: + If you are upgrading from a version prior to 2.5.0, just skip this notice and follow this procedure instead: + `https://blog.centreon.com/centreon-2-5-0-release/ `_. As usual, database backups are to be made before going any further. @@ -21,7 +21,7 @@ the size of your log tables. You are using NDOUtils ********************** -If you are using NDOUtils, chances are that you have plenty of duplicate entries in your log table. Follow the procedure in order to re insert the logs:: +If you are using NDOUtils, chances are that you have plenty of duplicate entries in your log table. Follow the procedure in order to re insert the logs: Copy all the log files from the remote pollers to the local poller in /var/lib/centreon/log/POLLERID/. To know the POLLERID of each of your pollers, execute the following request against the MySQL server (centreon database):: diff --git a/doc/en/release_notes/centreon-2.7/centreon-2.7.0.rst b/doc/en/release_notes/centreon-2.7/centreon-2.7.0.rst index 0c3e6c2793d..fcfa2aa0fcd 100644 --- a/doc/en/release_notes/centreon-2.7/centreon-2.7.0.rst +++ b/doc/en/release_notes/centreon-2.7/centreon-2.7.0.rst @@ -12,8 +12,10 @@ Features and Bug Fixes * Changing the graphic charter to be consistent with the new logo Centreon * Flat design (CSS and icons) * Custom view improvement + * Adding an editing or visualization mode * Graphic widgets relief to be able to put more on a page + * Adding a fullscreen mode * Menu Review for improved navigation and simplified user actions * Review og pages dedicated hosts and services pages in monitoring to include more informations. @@ -26,16 +28,19 @@ Features and Bug Fixes * Integration of a graphics module to replace a non-performing component QuickForm (Improved forms on multi element selection) * Simplifying the configuration of Centreon Broker (Temporary and Failover are automatically configured + enhanced best practices) * Ergonomic improvement of the configurations objects: + * Improved hosts form * Improved services form * Improved management macros: dynamic form system that provides the necessary inherited macros templates for proper operation of the configuration * Added ability to set a description of each macro used in commands * Review of the pathway for the generation of the configuration * Automatic creation of a configuration file for the poller when it is created + * Deleting configuration options in the Administration section, now automatically configured. This simplifies the handling of Centreon * Improved ACL system (Improved performances) * Native integration of Centreon CLAPI * Improved documentation + * Redesign Configuration part * Redesign Exploitation part * Integration of the API part @@ -76,20 +81,20 @@ Removed Features Known Bugs ---------- * ACL of pages is not fully updated during the upgrade process. So please check all your ACL pages after the migration. You may have problems with the followings pages: + * Monitoring > Hosts * Monitoring > Services * Monitoring > Performances (new page) * Monitoring > Downtimes * Monitoring > Comments * Monitoring > Eventlogs > System logs + * Graph slip not working * Pagination is broker when you go on the last page, change the number of line to the Max. Page become empty. -* If you have timeperiods used in exception or inclusion of timeperiod and now deleted, their ids stays in the database in relation table. During the sql update process, this blocks an addition of constraint on this relation table. To fix it, you have to remove old timeperiod id. - :: - - mysql> DELETE FROM timeperiod_exclude_relations WHERE timeperiod_id NOT IN (SELECT tp_id FROM timeperiod) OR timeperiod_exclude_id NOT IN (SELECT tp_id FROM timeperiod); - mysql> DELETE FROM timeperiod_include_relations WHERE timeperiod_id NOT IN (SELECT tp_id FROM timeperiod) OR timeperiod_exclude_id NOT IN (SELECT tp_id FROM timeperiod); +* If you have timeperiods used in exception or inclusion of timeperiod and now deleted, their ids stays in the database in relation table. During the sql update process, this blocks an addition of constraint on this relation table. To fix it, you have to remove old timeperiod id.:: + mysql> DELETE FROM timeperiod_exclude_relations WHERE timeperiod_id NOT IN (SELECT tp_id FROM timeperiod) OR timeperiod_exclude_id NOT IN (SELECT tp_id FROM timeperiod); + mysql> DELETE FROM timeperiod_include_relations WHERE timeperiod_id NOT IN (SELECT tp_id FROM timeperiod) OR timeperiod_exclude_id NOT IN (SELECT tp_id FROM timeperiod); How to Install ? ---------------- diff --git a/doc/en/release_notes/centreon-2.8/centreon-2.8.6.rst b/doc/en/release_notes/centreon-2.8/centreon-2.8.6.rst index fa25cbf4942..e93455b1291 100644 --- a/doc/en/release_notes/centreon-2.8/centreon-2.8.6.rst +++ b/doc/en/release_notes/centreon-2.8/centreon-2.8.6.rst @@ -48,4 +48,4 @@ Known bugs or issues ==================== * There's an issue in the ldap configuration form. A fix is available and will be package with the next bugfix version. Until then you can apply the patch available `here `_ -* There's an issue on all listing pages. A fix is available and will be package with the next bugfix version. Until then you can apply the patch available `here `_ +* There's an issue on all listing pages. A fix is available and will be package with the next bugfix version. Until then you can apply the `available patch `_ diff --git a/doc/en/release_notes/centreon-2.8/index.rst b/doc/en/release_notes/centreon-2.8/index.rst index 71b33963035..ecca4b2af78 100644 --- a/doc/en/release_notes/centreon-2.8/index.rst +++ b/doc/en/release_notes/centreon-2.8/index.rst @@ -15,3 +15,4 @@ Please find here the release notes dedicated to the last 2.8.x version of Centre centreon-2.8.6 centreon-2.8.7 centreon-2.8.8 + centreon-2.8.9 From 5a966ba5b14a5441dac5512bf78e004aeb1ab8c2 Mon Sep 17 00:00:00 2001 From: Laurent Pinsivy Date: Mon, 22 May 2017 09:47:07 +0100 Subject: [PATCH 2/2] Correct make html warning/error for EN documentation --- doc/en/configuration_guide/contact.rst | 2 ++ doc/en/configuration_guide/poller/index.rst | 2 ++ doc/en/exploitation_guide/01customview.rst | 2 ++ doc/en/release_notes/centreon-2.4/centreon-2.4.0.rst | 4 ++-- 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/en/configuration_guide/contact.rst b/doc/en/configuration_guide/contact.rst index dd852ae8700..f108d6261ca 100644 --- a/doc/en/configuration_guide/contact.rst +++ b/doc/en/configuration_guide/contact.rst @@ -34,6 +34,8 @@ General information * The **Host / Service Notification Period** field serves to choose the time period in which notifications are sent. * The **Host / Service Notification Command** field serves to choose the notification command to a host or a service. +.. _autologin: + *********************** Centreon authentication *********************** diff --git a/doc/en/configuration_guide/poller/index.rst b/doc/en/configuration_guide/poller/index.rst index 90388d268e8..a41eacc22fb 100644 --- a/doc/en/configuration_guide/poller/index.rst +++ b/doc/en/configuration_guide/poller/index.rst @@ -1,3 +1,5 @@ +.. _pollers_basic_conf: + ====== Poller ====== diff --git a/doc/en/exploitation_guide/01customview.rst b/doc/en/exploitation_guide/01customview.rst index 4c805b615ab..6d22986a567 100644 --- a/doc/en/exploitation_guide/01customview.rst +++ b/doc/en/exploitation_guide/01customview.rst @@ -1,3 +1,5 @@ +.. _widgets_user_guide: + ============ Custom views ============ diff --git a/doc/en/release_notes/centreon-2.4/centreon-2.4.0.rst b/doc/en/release_notes/centreon-2.4/centreon-2.4.0.rst index 41fd9f0c5bd..793424ed00e 100644 --- a/doc/en/release_notes/centreon-2.4/centreon-2.4.0.rst +++ b/doc/en/release_notes/centreon-2.4/centreon-2.4.0.rst @@ -37,7 +37,7 @@ Support for multiple LDAP servers ================================= The LDAP authentication system is much more robust than before. -Indeed, it is now possible to have :ref:`multiple LDAP configurations ` on +Indeed, it is now possible to have :ref:`multiple LDAP configurations ` on top of the failover system. The LDAP import form will let you choose the LDAP server to import from. @@ -70,7 +70,7 @@ Communication with pollers The default system user used by *Centcore* to communicate with pollers has changed from ``nagios`` to ``centreon``. See -:ref:`ces:pollers_basic_conf` for more information. +:ref:`pollers_basic_conf` for more information. Plugins