Update doc

git-svn-id: http://svn.merethis.net/centreon-esxd/trunk@63 a5eaa968-4c79-4d68-970d-af6011b5b055
This commit is contained in:
Quentin Garnier 2013-07-02 14:31:02 +00:00
parent a7db928bea
commit 03c41987a7
4 changed files with 51 additions and 256 deletions

View File

@ -28,8 +28,7 @@ Steps of operation :
Then, this process gets back the VMWare indicators creating a subprocess per request.
Centreon-esxd necessitates the utilization of one (or more) VirtualCenter. It isn't possible to get back informations of an ESX server directly.
Centreon-esxd necessitates the utilization of one (or more) VirtualCenter (or ESX).
This is a example of a fragmented architecture :
.. image:: ../images/archi.png
@ -44,35 +43,18 @@ Configuration du connecteur
```````````````````````````
Le daemon « centreon-esxd » possède un fichier de configuration « centreon_esxd.pm » de la forme suivante ::
our $libpath = '/usr/share/centreon/lib/centreon-esxd';
our $port = 5700;
our %vsphere_server = ('default' => {'url' => 'https://XXXXXX/sdk',
'username' => 'XXXXX',
'password' => 'XXXXX'},
'testvc' => {'url' => 'https://XXXXXX/sdk',
'username' => 'XXXXX',
$centreonesxd_config = {
vsphere_server => {
'default' => {'url' => 'https://vcenter/sdk',
'username' => 'qgarnier@merethis.net',
'password' => 'XXXXXX'}
our $TIMEOUT_VSPHERE = 60;
our $TIMEOUT = 60;
our $TIMEOUT_KILL = 30;
our $REFRESH_KEEPER_SESSION = 15;
# Log Mode: 0 = stdout, 1 = file, 2 = syslog
our $log_mode = 1;
# Criticity: 0 = nothing, 1 = critical, 3 = info
our $log_crit = 1;
# Specify if $log_mode = 2 and CPAN Module Unix::Syslog is installed
our $log_facility;
#our $log_facility = LOG_DAEMON;
our $LOG = "/tmp/centreon_esxd.log";
}
port => 5700
};
La variable «%vsphere_server » permet de configurer les accès aux différents VirtualCenter. Il est nécessaire d'avoir au moins l'entrée 'default'.
La variable « $port » permet de configurer le port d'écoute du connecteur « centreon-esxd ».
Il est aussi possible de modifier la variable « $log_mode » si vous souhaitez utiliser « syslog » au lieu d'un fichier à plat.
Il est déconseillé de modifier les variables suivantes : « $REFRESH_KEEPER_SESSION », « $TIMEOUT_KILL », « $ TIMEOUT_VSPHERE » et « $TIMEOUT », car ils sont configurés pour une utilisation optimale.
L'attribut «%vsphere_server » permet de configurer les accès aux différents VirtualCenter. Il est nécessaire d'avoir au moins l'entrée 'default'.
L'attribut « $port » permet de configurer le port d'écoute du connecteur « centreon-esxd ».
Optimisation de la configuration dans Centreon
----------------------------------------------

View File

@ -14,9 +14,10 @@ Installation on other system is possible but is outside the scope of this docume
==================== =====================
Software Minimal Version
==================== =====================
VMWare SDK Perl 5.0
Perl 5.8
centreon-esxd 1.3
VMWare SDK Perl 5.1
Perl 5.8
centreon-esxd 1.4
centreon-common-perl 2.5
==================== =====================
Hardware Recommandations
@ -36,16 +37,12 @@ SDK Perl VMWare Installation
The "centreon-esxd" connector uses SDK Perl VMWare for its operation. So we install it. To do this, we begin by install CPAN, it's the name of a Perl module who improves the download, the installation, the upgrade and the maintenance of others Perl modules who are archived on the CPAN.
Install CPAN prerequisites ::
root # yum install gcc make unzip wget expat-devel e2fsprogs-devel openssl-devel
root # yum install perl-XML-LibXML perl-Crypt-SSLeay
root # yum install gcc make unzip wget e2fsprogs-devel
root # yum install perl-XML-LibXML perl-Crypt-SSLeay perl-libwww-perl perl-TimeDate
root # cpan install Class::MethodMaker
root # cpan install LWP
root # cpan install Net::SSLeay
root # cpan install LWP::Protocol::https
root # cpan install SOAP::Lite
root # wget http://search.cpan.org/CPAN/authors/id/J/JN/JNH/UUID-0.04.tar.gz
@ -60,44 +57,33 @@ Download the last version on the VMWare website (`SDK VMWare <http://www.vmware.
Install VMWare Perl SDK::
root # tar zxvf VMware-vSphere-Perl-SDK-5.1.0-780721.x86_64.tar.gz
root # tar zxvf VMware-vSphere-Perl-SDK-5.1.0-780721.x86_64.gz
root # cd vmware-vsphere-cli-distrib
root # perl Makefile.pl
root # make && make install
Addtionnal Modules Installation
Requirements
```````````````````````````````
Some features require additionnal prerequisites.
« centreon-common-perl » is a prerequisite for « centreon_esxd ». (Module in Centreon 2.5)
To send data to a syslog daemon, the " Unix::Syslog" must be installed ::
root # cpan install Unix::Syslog
To check a virtual server snapshots date, the "DateTime::Format::ISO8601" is required (**be advise that this module has a lot of CPAN dependencies and may need a full Perl update. This update is hazardous**) ::
root # cpan install DateTime
root # cpan install DateTime::Format::ISO8601
root # o conf make /usr/bin/make
root # o conf commit
Reboot your system to complete.
centreon-esxd Installation
``````````````````````````
Download « centreon-esxd » archive, then install ::
root # tar zxvf centreon-esxd-1.X.tar.gz
root # cd centreon-esxd-1.X
root # tar zxvf centreon-esxd-1.4.tar.gz
root # cd centreon-esxd-1.4
root # cp centreon_esxd /usr/bin/
root # mkdir -p /etc/centreon
root # cp centreon_esxd-conf.pm /etc/centreon/centreon_esxd.pm
root # cp centreon_esxd-init /etc/init.d/centreon_esxd
root # mkdir -p /usr/share/centreon/lib/centreon-esxd
root # cp lib/* /usr/share/centreon/lib/centreon-esxd/
root # mkdir -p /usr/lib/perl5/vendor_perl/5.8.8/centreon/esxd/
root # cp lib/* /usr/lib/perl5/vendor_perl/5.8.8/centreon/esxd/
root # cp centreonesxd.pm /usr/lib/perl5/vendor_perl/5.8.8/centreon/script/
Configure "centreon-esxd" daemon to start at boot ::
@ -112,73 +98,4 @@ Centreon-esxd Installation - centos/rhel 6 systems
SDK Perl VMWare Installation
`````````````````````````````
The "centreon-esxd" connector uses SDK Perl VMWare for its operation. So we install it. To do this, we begin by install CPAN, it's the name of a Perl module who improves the download, the installation, the upgrade and the maintenance of others Perl modules who are archived on the CPAN.
Install CPAN prerequisites ::
root # yum install gcc make unzip wget expat-devel e2fsprogs-devel openssl-devel perl-CPAN libuuid-devel
root # yum install perl-XML-LibXML perl-Crypt-SSLeay perl-Class-MethodMaker perl-SOAP-Lite
root # cpan install Test::More
root # cpan install LWP
root # cpan install Net::SSLeay
root # cpan install LWP::Protocol::https
root # wget http://search.cpan.org/CPAN/authors/id/J/JN/JNH/UUID-0.04.tar.gz
root # tar zxvf UUID-0.04.tar.gz
root # cd UUID-0.04
root # perl Makefile.PL
root # make && make install
All SDK prerequisites are installed.
Download the last version on the VMWare website (`SDK VMWare <http://www.vmware.com/support/developer/viperltoolkit/>`_) (choose the file correponding to your architecture)
Install VMWare Perl SDK::
root # tar zxvf VMware-vSphere-Perl-SDK-5.1.0-780721.x86_64.tar.gz
root # cd vmware-vsphere-cli-distrib
root # perl Makefile.pl
root # make && make install
Addtionnal Modules Installation
```````````````````````````````
Some features require additionnal prerequisites.
To send data to a syslog daemon, the " Unix::Syslog" must be installed ::
root # cpan install Unix::Syslog
To check a virtual server snapshots date, the "DateTime::Format::ISO8601" is required (**be advise that this module has a lot of CPAN dependencies and may need a full Perl update. This update is hazardous**) ::
root # cpan install DateTime
root # cpan install DateTime::Format::ISO8601
root # o conf make /usr/bin/make
root # o conf commit
Reboot your system to complete.
centreon-esxd Installation
``````````````````````````
Download « centreon-esxd » archive, then install ::
root # tar zxvf centreon-esxd-1.X.tar.gz
root # cd centreon-esxd-1.X
root # cp centreon_esxd /usr/bin/
root # mkdir -p /etc/centreon
root # cp centreon_esxd-conf.pm /etc/centreon/centreon_esxd.pm
root # cp centreon_esxd-init /etc/init.d/centreon_esxd
root # mkdir -p /usr/share/centreon/lib/centreon-esxd
root # cp lib/* /usr/share/centreon/lib/centreon-esxd/
Configure "centreon-esxd" daemon to start at boot ::
root # chkconfig --level 2345 centreon_esxd on
*"centreon_esx_client.pl" is the corresponding nagios plugin.*
TODO

View File

@ -28,7 +28,7 @@ Voici le fonctionnement :
Enfin, ce processus récupère les indicateurs VMWare en créant un sous-processus par demande.
Centreon-esxd nécessite impérativement l'utilisation d'un (ou plusieurs) VirtualCenter. Il n'est pas possible de récupérer les informations d'un serveur ESX directement.
Centreon-esxd nécessite impérativement l'utilisation d'un (ou plusieurs) VirtualCenter (ou ESX).
Voici un exemple d'architecture éclaté :
@ -38,41 +38,24 @@ Mode de fonctionnement
``````````````````````
Le programme « centreon-esxd » fonctionne uniquement en mode « daemon ». (dans le sens où il ne peut fournir les indicateurs sans l'utilisation d'un client).
Lors de l'utilisation du plugin *centreon_esx_client.pl*, on passe des chaînes de caractères qui vont être lier aux différentes librairies dans *"/usr/share/centreon/lib/centreon-esxd"* et qui va être ensuite communiquer au Vcenter qui va au final retourner le résultat au Client. Le client ouvre une liaison TCP avec le serveur pour récolter les informations nécessaires.
Lors de l'utilisation du plugin *centreon_esx_client.pl*, on passe des chaînes de caractères qui vont être lier aux différentes librairies dans *"/usr/lib/perl5/vendor_perl/5.8.8/centreon/esxd/"* et qui va être ensuite communiquer au Vcenter qui va au final retourner le résultat au Client. Le client ouvre une liaison TCP avec le serveur pour récolter les informations nécessaires.
Configuration du connecteur
```````````````````````````
Le daemon « centreon-esxd » possède un fichier de configuration « centreon_esxd.pm » de la forme suivante ::
our $libpath = '/usr/share/centreon/lib/centreon-esxd';
our $port = 5700;
our %vsphere_server = ('default' => {'url' => 'https://XXXXXX/sdk',
'username' => 'XXXXX',
'password' => 'XXXXX'},
'testvc' => {'url' => 'https://XXXXXX/sdk',
'username' => 'XXXXX',
$centreonesxd_config = {
vsphere_server => {
'default' => {'url' => 'https://vcenter/sdk',
'username' => 'qgarnier@merethis.net',
'password' => 'XXXXXX'}
our $TIMEOUT_VSPHERE = 60;
our $TIMEOUT = 60;
our $TIMEOUT_KILL = 30;
our $REFRESH_KEEPER_SESSION = 15;
# Log Mode: 0 = stdout, 1 = file, 2 = syslog
our $log_mode = 1;
# Criticity: 0 = nothing, 1 = critical, 3 = info
our $log_crit = 1;
# Specify if $log_mode = 2 and CPAN Module Unix::Syslog is installed
our $log_facility;
#our $log_facility = LOG_DAEMON;
our $LOG = "/tmp/centreon_esxd.log";
}
port => 5700
};
La variable «%vsphere_server » permet de configurer les accès aux différents VirtualCenter. Il est nécessaire d'avoir au moins l'entrée 'default'.
La variable « $port » permet de configurer le port d'écoute du connecteur « centreon-esxd ».
Il est aussi possible de modifier la variable « $log_mode » si vous souhaitez utiliser « syslog » au lieu d'un fichier à plat.
Il est déconseillé de modifier les variables suivantes : « $REFRESH_KEEPER_SESSION », « $TIMEOUT_KILL », « $ TIMEOUT_VSPHERE » et « $TIMEOUT », car ils sont configurés pour une utilisation optimale.
L'attribut «%vsphere_server » permet de configurer les accès aux différents VirtualCenter. Il est nécessaire d'avoir au moins l'entrée 'default'.
L'attribut « $port » permet de configurer le port d'écoute du connecteur « centreon-esxd ».
Optimisation de la configuration dans Centreon
----------------------------------------------

View File

@ -14,9 +14,10 @@ L'installation sur d'autres environnements n'est pas exclu mais non présenté d
==================== =====================
Logiciels Version minimum
==================== =====================
VMWare SDK Perl 5.0
Perl 5.8
centreon-esxd 1.3
VMWare SDK Perl 5.1
Perl 5.8
centreon-esxd 1.4
centreon-common-perl 2.5
==================== =====================
Préconisations matérielles
@ -36,16 +37,12 @@ Installation du SDK Perl VMWare
Le connecteur « centreon-esxd » utilise le SDK Perl VMWare pour son fonctionnement. Nous allons donc l'installer. Pour cela nous allons commencer par installer CPAN qui est le nom d'un module Perl qui rend aisés le téléchargement, l'installation, la mise à jour et la maintenance des autres modules Perl qui sont archivés sur le CPAN.
Installer les pré-requis CPAN::
root # yum install gcc make unzip wget expat-devel e2fsprogs-devel openssl-devel
root # yum install perl-XML-LibXML perl-Crypt-SSLeay
root # yum install gcc make unzip wget e2fsprogs-devel
root # yum install perl-XML-LibXML perl-Crypt-SSLeay perl-libwww-perl perl-TimeDate
root # cpan install Class::MethodMaker
root # cpan install LWP
root # cpan install Net::SSLeay
root # cpan install LWP::Protocol::https
root # cpan install SOAP::Lite
root # wget http://search.cpan.org/CPAN/authors/id/J/JN/JNH/UUID-0.04.tar.gz
@ -60,28 +57,15 @@ Télécharger la dernière version, correspondant à votre architecture 32/64 bi
Installer le SDK Perl VMWare::
root # tar zxvf VMware-vSphere-Perl-SDK-5.1.0-780721.x86_64.tar.gz
root # tar zxvf VMware-vSphere-Perl-SDK-5.1.0-780721.x86_64.gz
root # cd vmware-vsphere-cli-distrib
root # perl Makefile.pl
root # make && make install
Installation de modules complémentaires
Pré-requis
```````````````````````````````````````
Certains modules complémentaires Perl peuvent être installés si vous souhaitez utiliser certaines fonctionnalités du centreon_esxd :
Pour envoyer les logs au daemon « syslog », il est nécessaire d'installer le module « Unix::Syslog »::
root # cpan install Unix::Syslog
Pour vérifier la date des snapshots d'une machine virtuelle, il est nécessaire d'installer le module « DateTime::Format::ISO8601 » ( **ce module installe beaucoup de modules CPAN et est difficilement installable sans mettre à jour globalement « Perl ». Cette mise à jour est très risqué** )::
root # cpan install DateTime
root # cpan install DateTime::Format::ISO8601
root # o conf make /usr/bin/make
root # o conf commit
Ensuite redémarrer votre système.
« centreon-common-perl » est nécessaire pour le fonctionnement de « centreon_esxd ». Ce module est présent à partir de Centreon 2.5.
Installation de centreon-esxd
`````````````````````````````
@ -90,16 +74,17 @@ Télécharger l'archive de « centreon-esxd ».
Installer les fichiers::
root # tar zxvf centreon-esxd-1.X.tar.gz
root # cd centreon-esxd-1.X
root # tar zxvf centreon-esxd-1.4.tar.gz
root # cd centreon-esxd-1.4
root # cp centreon_esxd /usr/bin/
root # mkdir -p /etc/centreon
root # cp centreon_esxd-conf.pm /etc/centreon/centreon_esxd.pm
root # cp centreon_esxd-init /etc/init.d/centreon_esxd
root # mkdir -p /usr/share/centreon/lib/centreon-esxd
root # cp lib/* /usr/share/centreon/lib/centreon-esxd/
root # mkdir -p /usr/lib/perl5/vendor_perl/5.8.8/centreon/esxd/
root # cp lib/* /usr/lib/perl5/vendor_perl/5.8.8/centreon/esxd/
root # cp centreonesxd.pm /usr/lib/perl5/vendor_perl/5.8.8/centreon/script/
Activer le daemon « centreon-esxd » au démarrage::
@ -114,78 +99,6 @@ Installation de centreon-esxd - Environnement centos/rhel 6
Installation du sdk Perl VMWare
```````````````````````````````
Le connecteur « centreon-esxd » utilise le SDK Perl VMWare pour son fonctionnement.
Le connecteur « centreon-esxd » utilise le SDK Perl VMWare pour son fonctionnement. Nous allons donc l'installer. Pour cela nous allons commencer par installer CPAN qui est le nom d'un module Perl qui rend aisés le téléchargement, l'installation, la mise à jour et la maintenance des autres modules Perl qui sont archivés sur le CPAN.
Installer les pré-requis CPAN::
root # yum install gcc make unzip wget expat-devel e2fsprogs-devel openssl-devel perl-CPAN libuuid-devel
root # yum install perl-XML-LibXML perl-Crypt-SSLeay perl-Class-MethodMaker perl-SOAP-Lite
root # cpan install Test::More
root # cpan install LWP
root # cpan install Net::SSLeay
root # cpan install LWP::Protocol::https
root # wget http://search.cpan.org/CPAN/authors/id/J/JN/JNH/UUID-0.04.tar.gz
root # tar zxvf UUID-0.04.tar.gz
root # cd UUID-0.04
root # perl Makefile.PL
root # make && make install
Nous avons notre environnement prêt pour l'installation du SDK VMWare.
Télécharger la dernière version, correspondant à votre architecture 32/64 bits, sur le site officiel de VMWare (`SDK VMWare <http://www.vmware.com/support/developer/viperltoolkit/>`_)
Installer le SDK Perl VMWare::
root # tar zxvf VMware-vSphere-Perl-SDK-5.1.0-780721.x86_64.tar.gz
root # cd vmware-vsphere-cli-distrib
root # perl Makefile.pl
root # make && make install
Installation de modules complémentaires
```````````````````````````````````````
Certains modules complémentaires Perl peuvent être installés si vous souhaitez utiliser certaines fonctionnalités du centreon_esxd :
Pour envoyer les logs au daemon « syslog », il est nécessaire d'installer le module « Unix::Syslog »::
root # cpan install Unix::Syslog
Pour vérifier la date des snapshots d'une machine virtuelle, il est nécessaire d'installer le module « DateTime::Format::ISO8601 » ( **ce module installe beaucoup de modules CPAN et est difficilement installable sans mettre à jour globalement « Perl ». Cette mise à jour est très risqué** )::
root # cpan install DateTime
root # cpan install DateTime::Format::ISO8601
root # o conf make /usr/bin/make
root # o conf commit
Ensuite redémarrer votre système.
Installation de centreon-esxd
`````````````````````````````
Télécharger l'archive de « centreon-esxd ».
Installer les fichiers::
root # tar zxvf centreon-esxd-1.X.tar.gz
root # cd centreon-esxd-1.X
root # cp centreon_esxd /usr/bin/
root # mkdir -p /etc/centreon
root # cp centreon_esxd-conf.pm /etc/centreon/centreon_esxd.pm
root # cp centreon_esxd-init /etc/init.d/centreon_esxd
root # mkdir -p /usr/share/centreon/lib/centreon-esxd
root # cp lib/* /usr/share/centreon/lib/centreon-esxd/
Activer le daemon « centreon-esxd » au démarrage::
root # chkconfig --level 2345 centreon_esxd on
*Le plugin « nagios » correspond au fichier « centreon_esx_client.pl ».*
TODO