tyler.durden
/
pandorafms
mirror of https://github.com/pandorafms/pandorafms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

2006-09-21 Raul Mateos <raulofpandora@gmail.com> 

* en/pandora_install.xml: Updated

git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@182 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
raulmateos 2006-09-21 10:21:22 +00:00
parent 565fc519dd
commit 6d4cba8d85
2 changed files with 46 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pandora_doc/ChangeLog
View File

@ -1,3 +1,7 @@
2006-09-21 Raul Mateos <raulofpandora@gmail.com>
* en/pandora_install.xml: Updated
2006-09-18 slerena <slerena@artica.es> 2006-09-18 slerena <slerena@artica.es>
* en/pandora.xml: Moved to pandora_user.xml. A new file called * en/pandora.xml: Moved to pandora_user.xml. A new file called

81
pandora_doc/en/pandora_install.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <chapter id="installation">
<title>&pandora; installation</title> <title>&pandora; installation</title>
<sect1> <sect1 id="prereq">
<title>Prerequisites</title> <title>Prerequisites</title>
<para> <para>
&pandora; is not only a single app, its composed by &pandora; is not only a single app, its composed by
@ -13,7 +13,7 @@
libraries and software you need before install &pandora;. libraries and software you need before install &pandora;.
</para> </para>
</sect1> </sect1>
<sect1> <sect1 id="servers">
<title>Pandora Servers</title> <title>Pandora Servers</title>
<para> <para>
Pandora 1.2 has three kind of servers: Data server, Network Pandora 1.2 has three kind of servers: Data server, Network
@ -22,7 +22,7 @@
you could setup many of them in a High Availability enviroment you could setup many of them in a High Availability enviroment
or using it to manage highs loads of data. or using it to manage highs loads of data.
</para> </para>
<sect2><title>Pandora Data Server</title> <sect2 id="dataserver"><title>Pandora Data Server</title>
<para> <para>
To build <emphasis>Pandora Data Server</emphasis> you need to To build <emphasis>Pandora Data Server</emphasis> you need to
have the following perl modules and software installed in your have the following perl modules and software installed in your
@ -64,7 +64,7 @@
</para> </para>
</sect2> </sect2>
<sect2><title>Pandora Network Server</title> <sect2 id="networkserver"><title>Pandora Network Server</title>
<para> <para>
Requires SSH Server and Perl v5.8 or higher and the next Perl Modules: Requires SSH Server and Perl v5.8 or higher and the next Perl Modules:
<blockquote> <blockquote>
@ -109,7 +109,7 @@
Network Server must run with root privileges. Network Server must run with root privileges.
</para> </para>
</sect2> </sect2>
<sect2><title>Pandora SNMP Server</title> <sect2 id="snmpserver"><title>Pandora SNMP Server</title>
<para> <para>
You need to install the NET-SNMP package which is included in You need to install the NET-SNMP package which is included in
all GNU/Linux distributions. You have to use the snmptrapd all GNU/Linux distributions. You have to use the snmptrapd
@ -122,7 +122,7 @@
</para> </para>
</sect2> </sect2>
<sect2><title>Installing Pandora Server</title> <sect2 id="installing_server"><title>Installing Pandora Server</title>
<para> <para>
Create the <filename>/opt/pandora</filename> directory and Create the <filename>/opt/pandora</filename> directory and
"gunzip" and "untar" here the "gunzip" and "untar" here the
@ -158,7 +158,7 @@
</para> </para>
</sect2> </sect2>
<sect2><title>Configuring your new Pandora Server setup</title> <sect2 id="configuring_server"><title>Configuring your new Pandora Server setup</title>
<para> <para>
After install Pandora Server in, you will need to edit the file After install Pandora Server in, you will need to edit the file
<filename>pandora_server.conf</filename>, where are defined the <filename>pandora_server.conf</filename>, where are defined the
@ -229,7 +229,7 @@
</programlisting> </programlisting>
</para> </para>
<sect3><title>Setting up SSH configuration</title> <sect3 id="set_SSH"><title>Setting up SSH configuration</title>
<para> <para>
Pandora, uses SSH protocol to copy XML data packets, Pandora, uses SSH protocol to copy XML data packets,
generated by the agents, to the server. You need to generate a generated by the agents, to the server. You need to generate a
@ -254,10 +254,9 @@
</sect3> </sect3>
</sect2> </sect2>
</sect1> </sect1>
<sect1 id="console_db">
<sect1>
<title>Pandora Console and Pandora database</title> <title>Pandora Console and Pandora database</title>
<sect2><title>Pandora database install</title> <sect2 id="db_install"><title>Pandora database install</title>
<para> <para>
Please look at MySQL install and management guide Please look at MySQL install and management guide
(http://dev.mysql.com/doc) to obtain information about how to (http://dev.mysql.com/doc) to obtain information about how to
@ -350,7 +349,7 @@
</sect2> </sect2>
<sect2> <sect2 id="console_install">
<title>Pandora console install.</title> <title>Pandora console install.</title>
<para>Prior to install Pandora console, you need the following <para>Prior to install Pandora console, you need the following
dependencies and software needed: dependencies and software needed:
@ -451,7 +450,7 @@
string with big font: <quote>TEST</quote> and a big table with string with big font: <quote>TEST</quote> and a big table with
a lot of info about your PHP installation. a lot of info about your PHP installation.
</para> </para>
<sect3><title>Graphic reporting instalation</title> <sect3 id="graph_inst"><title>Graphic reporting instalation</title>
<para> <para>
For correct graphic generation, you need to enter the full For correct graphic generation, you need to enter the full
path to a TrueType font installed in your system. By default a path to a TrueType font installed in your system. By default a
@ -475,9 +474,8 @@
</sect2> </sect2>
</sect1> </sect1>
<sect1 id="agents"><title>Pandora Agents</title>
<sect1><title>Pandora Agents</title> <sect2 id="a_intro"><title>Introduction</title>
<sect2><title>Introduction</title>
<para> <para>
&pandora; agents collect all system's data. They are executed in &pandora; agents collect all system's data. They are executed in
each local system, although they can also collect remote each local system, although they can also collect remote
@ -507,7 +505,7 @@
</para> </para>
</sect2> </sect2>
<sect2><title>Generic role of the agents</title> <sect2 id="a_role"><title>Generic role of the agents</title>
<para> <para>
Regardless the platform an agent is running on, this is formed of Regardless the platform an agent is running on, this is formed of
the following elements: the following elements:
@ -526,25 +524,26 @@
</para> </para>
<para> <para>
This simple structure makes it easy the customisation of an This simple structure makes it easy the customisation of an
agent. There is no need to "reprogram" the agent to modify the agent. There is no need to code again the agent to modify the
way it works, as the configuration file holds most of the way it works, as the configuration file holds most of the
parameters needed to do so. parameters needed to do so.
</para> </para>
</sect2> </sect2>
<sect2><title>Main Script</title> <sect2 id="a_script"><title>Main Script</title>
<para> <para>
The main script is the executable file that collects the data The main script is the executable file that collects the data
specified in the configuration file. It sends the data to the specified in the configuration file. It sends the data to the
server in XML. In Windows machines application is installed as a server in XML. In Windows machines application is installed as a
service and is executed at the time intervals set in the service and is executed at the time intervals set in the
configuration file. In machines running over UNIX the main script configuration file. In machines running over UNIX the main script
is run through a special script called pandora_agent_daemon, and is run through a special script called
<filename>pandora_agent_daemon</filename>, and
runs continuously in the machine as a process. runs continuously in the machine as a process.
</para> </para>
</sect2> </sect2>
<sect2><title>Configuration File</title> <sect2 id="conf_file"><title>Configuration File</title>
<para> <para>
The data collection in the host system is the gathering of The data collection in the host system is the gathering of
independent data units, which are defined in the independent data units, which are defined in the
@ -568,7 +567,7 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<sect3><title>General parameters</title> <sect3 id="gen_params"><title>General parameters</title>
<para> <para>
The general parameters of the agent configuration are defined in The general parameters of the agent configuration are defined in
this section. Some of these parameters are common for all systems this section. Some of these parameters are common for all systems
@ -679,7 +678,7 @@
</screen> </screen>
</para> </para>
</sect3> </sect3>
<sect3><title>Module definition</title> <sect3 id="mod_def"><title>Module definition</title>
<para> <para>
Each data item that is to be collected must be defined precisely Each data item that is to be collected must be defined precisely
in each module, using the exact syntax. As many values as in each module, using the exact syntax. As many values as
@ -861,7 +860,7 @@
</sect3> </sect3>
</sect2> </sect2>
<sect2><title>Agent types</title> <sect2 id="a_types"><title>Agent types</title>
<para> <para>
It is possible to monitor virtually any system with Pandora. This It is possible to monitor virtually any system with Pandora. This
can be done either with a local agent collecting data directly from can be done either with a local agent collecting data directly from
@ -878,8 +877,8 @@
example, an SNMPGET tool. example, an SNMPGET tool.
</para> </para>
<sect3><title>UNIX agents</title> <sect3 id="unix_a"><title>UNIX agents</title>
<sect4><title>Introduction to Unix agents</title> <sect4 id="intro_unix_a"><title>Introduction to Unix agents</title>
<para> <para>
The in-built UNIX applications and tools make the agents running on The in-built UNIX applications and tools make the agents running on
this system be very simple. There are also agents developed for AIX, this system be very simple. There are also agents developed for AIX,
@ -955,7 +954,7 @@
</sect3> </sect3>
</sect2> </sect2>
<sect2><title>Pandora Unix Agent install</title> <sect2 id="unix_a_install"><title>Pandora Unix Agent install</title>
<para> <para>
The software comes in a .tar.gz file. First of all the file needs The software comes in a .tar.gz file. First of all the file needs
to be extracted into a folder, usually /opt/pandora_agent, to be extracted into a folder, usually /opt/pandora_agent,
@ -1007,7 +1006,7 @@
where the activity of the Pandora agent is saved, when the agent where the activity of the Pandora agent is saved, when the agent
is executed in debugging mode. is executed in debugging mode.
</para> </para>
<sect3><title>Key generation</title> <sect3 id="key_gen"><title>Key generation</title>
<para> <para>
The SSH keys generated must be: The SSH keys generated must be:
<itemizedlist mark='bullet'> <itemizedlist mark='bullet'>
@ -1045,7 +1044,7 @@
The system must connect successfully BEFORE launching the Pandora agent. The system must connect successfully BEFORE launching the Pandora agent.
</para> </para>
</sect3> </sect3>
<sect3><title>First execution of the Unix agent</title> <sect3 id="a_unix_run"><title>First running of the Unix agent</title>
<para> <para>
To start the agent it is only necessary to execute To start the agent it is only necessary to execute
pandora_agent_daemon start from /opt/pandora_client. Pandora Agent pandora_agent_daemon start from /opt/pandora_client. Pandora Agent
@ -1066,7 +1065,7 @@
</para> </para>
</sect3> </sect3>
<sect3><title>Advanced agent configuration for Unix</title> <sect3 id="a_unix_ad"><title>Advanced configuration for Unix Agent</title>
<para> <para>
The real power of Pandora resides in the capability of the agents The real power of Pandora resides in the capability of the agents
to run user defined scripts. This could be used to collect to run user defined scripts. This could be used to collect
@ -1154,7 +1153,7 @@
</para> </para>
</sect3> </sect3>
<sect3><title>Implementation examples for Unix Agents</title> <sect3 id="a_unix_examples"><title>Implementation examples for Unix Agents</title>
<para> <para>
Example #1: calculate the number of HITS of the main page of an Example #1: calculate the number of HITS of the main page of an
Apache Web server: Apache Web server:
@ -1180,6 +1179,7 @@
<para> <para>
Complete example of the configuration of an agent for Linux Complete example of the configuration of an agent for Linux
<programlisting> <programlisting>
<![CDATA[
# General Parameters # General Parameters
# ================== # ==================
@ -1264,15 +1264,16 @@
module_name eMails_SPAM module_name eMails_SPAM
module_type generic_data_inc module_type generic_data_inc
module_exec cat /var/log/mail/mail.log | grep "identified spam" | wc -l module_exec cat /var/log/mail/mail.log | grep "identified spam" | wc -l
module_end module_end
]]>
</programlisting> </programlisting>
</para> </para>
</sect3> </sect3>
</sect2> </sect2>
<sect2> <sect2 id="win_a">
<title>Pandora Windows Agents.</title> <title>Pandora Windows Agents</title>
<sect3> <sect3 id="build_win_a">
<title>Build Windows Agent from sources</title> <title>Build Windows Agent from sources</title>
<para> <para>
In order to build from sources, you will need the latest In order to build from sources, you will need the latest
@ -1285,7 +1286,7 @@
installation. installation.
</para> </para>
</sect3> </sect3>
<sect3> <sect3 id="install_win_a">
<title>Windows Agent installation</title> <title>Windows Agent installation</title>
<para> <para>
Before running or installation of Pandora Windows service, you Before running or installation of Pandora Windows service, you
@ -1336,7 +1337,7 @@
</programlisting> </programlisting>
</para> </para>
</sect3> </sect3>
<sect3> <sect3 id="win_a_testing">
<title>Windows Agent testing</title> <title>Windows Agent testing</title>
<para> <para>
You can check the Pandora Windows Agent output in the You can check the Pandora Windows Agent output in the
@ -1351,13 +1352,14 @@
"ssh.test". "ssh.test".
</para> </para>
</sect3> </sect3>
<sect3> <sect3 id="win_a_conf">
<title>Windows Agent configuration</title> <title>Windows Agent configuration</title>
<para> <para>
All setup is made in <filename>babel_agent.conf</filename>. All setup is made in <filename>babel_agent.conf</filename>.
This file is a list of keys/values pairs. Here is an example This file is a list of keys/values pairs. Here is an example
of this file. of this file.
<screen> <screen>
<![CDATA[
# General Parameters # General Parameters
# ================== # ==================
@ -1435,6 +1437,7 @@
module_freememory module_freememory
module_description Amount of free memory. module_description Amount of free memory.
module_end module_end
]]>
</screen> </screen>
</para> </para>
</sect3> </sect3>