From e9955b892a20bf312059eea0a3e4c307d709b021 Mon Sep 17 00:00:00 2001 From: marostegui Date: Fri, 15 Jun 2007 09:52:14 +0000 Subject: [PATCH] 2007-06-15 Manuel Arostegui * en/pandora_install.xml: Changes to adapt the document to the 1.3 release git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@513 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f --- pandora_doc/ChangeLog | 5 + pandora_doc/en/pandora_install.xml | 152 +++++++++++++++++++---------- 2 files changed, 107 insertions(+), 50 deletions(-) diff --git a/pandora_doc/ChangeLog b/pandora_doc/ChangeLog index d188e2f13a..aff3f07368 100644 --- a/pandora_doc/ChangeLog +++ b/pandora_doc/ChangeLog @@ -1,3 +1,8 @@ +2007-06-15 Manuel Arostegui + + * en/pandora_install.xml: Changes to adapt the + document to the 1.3 release + 2007-05-26 Manuel Arostegui * en/pandora_install.xml: Fixed a small typo related diff --git a/pandora_doc/en/pandora_install.xml b/pandora_doc/en/pandora_install.xml index c5cb8c5109..7e1edd0909 100644 --- a/pandora_doc/en/pandora_install.xml +++ b/pandora_doc/en/pandora_install.xml @@ -16,8 +16,8 @@ Pandora Servers - Pandora FMS 1.2 has three kind of servers: Data server, Network - Server and SNMP Server/Trap console. All of them could be + Pandora FMS 1.3 has four kind of servers: Data server, Network + Server, Recon Server and SNMP Server/Trap console. All of them could be installed in the same machine or in different machines, also, you could setup many of them in a High Availability environment or using it to manage highs loads of data. @@ -117,9 +117,9 @@ Installing Pandora Server - Create the /opt/pandora directory and + Create the /usr/share/pandora_server directory and "gunzip" and "untar" here the - pandora_server_1.2.tar.gz file. + pandora_server_1.3.tar.gz file. Create an user pandora in OS. Usually you do that in GNU/Linux @@ -147,7 +147,7 @@ Check launch scripts (pandora_network, pandora_server, pandora_snmp) and check for pathnames in the first two variables in script. roa Server. This usually is - /opt/pandora_server + /usr/share/pandora_server @@ -164,7 +164,7 @@ Edit configuration file of Pandora Server, usually - /opt/pandora/conf/pandora_server.conf and + /usr/share/pandora_server/conf/pandora_server.conf and take a look at the lines: dbuser pandora @@ -179,7 +179,7 @@ filename and valid username, password and hostname. - Remember: you need to create the directory /opt/pandora/data_in + Remember: you need to create the directory /var/spool/pandora/data_in where Pandora Server will read and write data, sent by remote agents using ssh/scp. This directory must be owned or with permissions to write for user "pandora". If you don't have a @@ -188,8 +188,8 @@ You can run Pandora Server with an user without privilegues, you can use the user "pandora", it only needs to run /usr/bin/perl and - access to /opt/pandora and - /opt/pandora/data_in directories. + access to /usr/share/pandora_server and + /var/spool/pandora/data_in directories. This is true with all the components but with Pandora SNMP Console @@ -212,7 +212,7 @@ (debian, Suse) and Solaris 8 systems. It has start|stop|restart parameters to include it in your default init level directory and it creates a logfile defined in $log_file variable (by default is - /opt/pandora/pandora.log): + /var/log/pandora/pandora.log): /etc/init.d/pandora_server start @@ -226,7 +226,7 @@ /home/pandora/.ssh/authorized_keys, so you need to create a user called "pandora" without privileges. This user will be used by agents to copy data into Pandora Data Server - /opt/pandora/data_in directory. + /var/spool/pandora/data_in directory. Please BE SURE that user "pandora" exists (if not, create with @@ -237,7 +237,7 @@ Please be sure that directory - /opt/pandora/data_in exists and pandora + /var/spool/pandora/data_in exists and pandora user is able to write in. @@ -247,6 +247,17 @@ Pandora Console and Pandora database Pandora database install + In the new 1.3 version of the Pandora Web Console the process + of creating and setting up the database can be easily made from + a browser following a Wizard, this process is described in the console install + section below. We recommend you to use the Wizard instead of doing it + manually. + + + Anyways, this is the process to create all the database stuff from + the command line. + + Please look at MySQL install and management guide (http://dev.mysql.com/doc) to obtain information about how to create a MySQL database, how to manage mysql users and give @@ -367,16 +378,11 @@ publishing directory and set perms to www-data or http user. - To setup Pandora Console, you only need to modify a file, - include/config.php, where the following - variables are included in .php code: + Then point your browser to: + + http://host:port/installdir/install.php + - - $dbname="pandora"; // name of database for pandora) - $dbuser="pandora"; // mysql user to access db - $dbpassword="pandora"; // Password for mysql user - $dbhost="pandora"; // Hostname or IP of mySQL server - If database is defined and was correctly installed, you can now access: @@ -534,7 +540,7 @@ The data collection in the host system is the gathering of independent data units, which are defined in the - pandora_agent.conf file. The + /etc/pandora/pandora_agent.conf file. The pandora_agent.conf file is divided in two parts: @@ -567,7 +573,7 @@ server_path: The server path is the full path of the folder where the server stores the data sent by the agent. It is usually - /opt/pandora/data_in. + /var/spool/pandora/data_in. @@ -589,7 +595,7 @@ flooding hard drive of the host system where the agent runs. The location of the local folder varies with the architecture of the host system. In Unix systems this is - usually /opt/pandora/data_out, and + usually /var/spool/pandora/data_out, and in Windows systems C:\pandora\data_out. @@ -637,13 +643,58 @@ in the server. Otherwise it could create problems. + + + Delayed Startup: This is parametrer + let you configure the Pandora Agent to start running after + an amount of time (in minutes) after you run it manually. + This could be useful for systems with lots of load. By default + it is disable, that is, Pandora Agent will start running since you + you run it manually. + + + + + Server Port: This is parametrer + let you specify the remote ssh server port is listening + in. By default it is 22, but just in case you set up your + server in other port this is where you have to change the port + if necessary. + + + + + Min and Max Hour: These parametrers + let you specify the hours where the Pandora Agent can run. + For instance if you set Min Hour 9 and Max Hour 18, if you try to + run Pandora Agent at 8, it will not run. + + + + + Transfer Mode: This parametrer + let you specify which transfer mode is going to be set up + to send the agent data to the server. + Modes available are: ssh (using scp), ftp or local. + Local mode it is only for systems where the agent run in the same + machine as the server does, cause it is basically a copy between + directories. + + + + + Pandora Nice: This parametrer + let you specify the priority the Pandora Agent process + will have in your system. + + An example of the general parameters from a Unix configuration would be. server_ip Pandora_Server - server_path /opt/pandora/data_in - temporal /opt/pandora/data_out + server_path /var/spool/pandora/data_in + temporal /var/spool/pandora/data_out interval 300 agent_name satellite_agent debug 1 @@ -794,7 +845,7 @@ module_interval factor - Pandora 1.2 introduces this new feature. You can, for each + Since Pandora 1.2 introduces this new feature. You can, for each module, setup its own interval. This interval its calculated as a multiply factor for agent interval. For example, if your agent has interval 300 (5 minutes), and you want a module only be @@ -933,52 +984,53 @@ Pandora Unix Agent install The software comes in a .tar.gz file. First of all the file needs - to be extracted into a folder, usually /opt/pandora_agent, - although any other folder may be used. If a different folder is - used, the daemon launcher must be modified by changing route to - $PANDORA_HOME. + to be extracted into a folder, usually /tmp. Then, once the file have + been extracted just run the Pandora Agent Installer, called: + pandora_agent_installer + to install it: ./pandora_agent_installer --install There is hardly any difference between AIX, Solaris and Linux, and they all work around the hash MD5 generation binaries. - This is the structure of the installation in /opt/pandora_agent/ - once the files have been extracted: + After running the installer the main directory is /usr/share/pandora_agent/ + where Pandora Agent is installed. - /opt/pandora_agent/data_out, folder where the + /var/spool/pandora/data_out, folder where the data collected by the agents is stored. - /opt/pandora_agent/doc, folder with + /usr/share/pandora_agent/doc, folder with information about the agent and its license. - /opt/pandora_agent/pandora_agent.conf, file + /etc/pandora/pandora_agent.conf, file where the data to be collected is defined, along side the command to be executed for the data collection. This is the system core, as it defines the main data to be collected in any Firewall. - /opt/pandora_agent/pandora_user.conf, file + /etc/pandora/pandora_user.conf, file where several of the parameters to collect data from the monitored system are defined in more detail. - /opt/pandora_agent/pandora_agent.sh, this is + /usr/share/pandora_agent/pandora_agent, this is the actual Pandora agent. This file is a shellscript that collects the data configured in the pandora_agent.conf and pandora_user.conf files. It also transfers the data packages to the Pandora server. - /opt/pandora_agent/pandora_agent_daemon, - start and stop script. It makes a call to pandora_agent.sh. It + /etc/init.d/pandora_agent_daemon, + start and stop script. It makes a call to pandora_agent. It offers two options, start and stop. + In AIX systems the daemon is: /etc/rc.pandora_agent_daemon - /opt/pandora_agent/pandora.log, text file + /var/log/pandora_agent/pandora.log, text file where the activity of the Pandora agent is saved, when the agent is executed in debugging mode. @@ -1023,8 +1075,8 @@ First running of the Unix agent To start the agent it is only necessary to execute - pandora_agent_daemon start from /opt/pandora_client. Pandora Agent - creates a file (/var/run/pandora.pid) with the PID number of the + /etc/init.d/pandora_agent_daemon start. + Pandora Agent creates a file (/var/run/pandora.pid) with the PID number of the process when it is started. @@ -1037,7 +1089,7 @@ In BSD systems the maximum priority is +20 and the lowest -20. - To stop agent, execute pandora_agent_daemon stop from /opt/pandora_agent. + To stop agent, execute pandora_agent_daemon stop from /etc/init.d/. @@ -1159,13 +1211,13 @@ # General Parameters # ================== - server_ip 192.168.100.45 - server_path /opt/pandora/data_in - pandora_path /opt/pandora_ng/ - temporal /opt/pandora_ng/data_out + server_ip 192.168.100.45 + server_path /var/spool/pandora/data_in + pandora_path /usr/share/pandora_server/ + temporal /var/spool/pandora/data_out interval 300 hostname linuxbox01 - debug 0 + debug 0 checksum 1 # Module Definition @@ -1371,7 +1423,7 @@ # ================== server_ip 127.0.0.1 - server_path /opt/pandora_server/data_in + server_path /var/spool/pandora/data_in temporal "c:\windows\temp" interval 300 agent_name localhost