view release on metacpan or  search on metacpan

VBTK.pm  view on Meta::CPAN

report the status, update graphs, store text, etc.  See L<VBTK::Parser> for more
details.

=back

=head2 ENVIRONMENT VARIABLES

The VB toolkit can make use of several environment variables to override the 
defaults entered when VBTK was first installed.  If you go with
the defaults, it makes things much simpler.

=over 4

=item VBHOME

This is the root directory of the VBTK files.  (Defaults to /usr/vbtk).

=item VBPORT

The TCP port on which the VBServer web server will be available and which the
client processes will report their statuses into the VBServer.  
(Defaults to 4712).

=item VBURI

The URI which the client processes will use to contact the VBServer when 
reporting their statuses.  (Defaults to 'http://vbserver:$VBPORT')  Note
that if you just setup a DNS alias for 'vbserver', then you don't have to
change the default.

=item VBPSWD

The path to a file where passwords can be stored for automated access by 
client processes.  This is currently only used by the 
L<VBTK::DBI|VBTK::DBI/item_user> module.

=item VBLOGS

The directory where the logs of STDOUT from each of the VBServer and 
client processes will be stored.  (Defaults to '$VBHOME/logs')

=item VBOBJ

The directory where the object database will be stored.  Don't put anything
else into this directory, it should just be for the object database.
(Defaults to '$VBHOME/vbobj')  You can override this in the call to
L<new VBTK::Server|VBTK::Server/Methods> with the 
L<ObjectDir|VBTK::Server/item_ObjectDir> parameter if you want.

=item RRDBIN

The location of the rrdtool binary.  Defaults to '/usr/local/bin/rrdtool'.

=back

=head2 FILE SYSTEM LAYOUT

By default, the VB toolkit installs into a single directory as designated by
the environment variable L<VBHOME|/item_VBHOME>.  Sub-directories are then setup
as follows.  See the section on L<Environment Variables|/ENVIRONMENT VARIABLES>
for details on how to relocate these from their default settings.

=over 4

=item bin

Location of some administrative scripts used for installing and replicating
the VBTK software.

=item conf

Location of user-defined configuration scripts

=item examples

A directory containing example files which can be copied into the 'conf' 
directory and then customized.

=item logs

Location of STDOUT log files from the VBServer and client processes.

=item mib

Directory in which MIB files can be installed for use by the 
L<VBTK::Snmp|VBTK::Snmp> module.

=item perf

Directory in which performance related log files are usually stored by
default.  These log files contain the data gathered by the client monitoring
processes.  Their format and location is determined by the 'LogFile', 
'LogHeader', and 'LogDetail' parameters passed in the contructors of the
L<data-gathering|/DATA-GATHERING MODULES> modules.

=item scripts

Directory in which can be placed shell or other scripts used by the
data-gathering processes to collect their data.

=item vbobj

Directory in which the VBServer stores it's VB Object database.  For each 
VB object created, the VBServer will create a sub-directory using the objects
full name.  All history data, RRD databases, meta data, etc will be stored in
this sub-directory.

=item web

Document root directory for the VBServer's built-in web server.  The '.phtml'
and images files in this directory are all user-customizable, so feel free to
customize the web interface as you like.  See the section on 
L<Customizing the Web Interface|VBTK::Server/CUSTOMIZING THE WEB INTERFACE>
in the L<VBTK::Server|VBTK::Server> documentation for more details.

=back

=head1 DEPENDENCIES

The VB toolkit depends on several other perl modules, which are readily 
available from CPAN.