Doc and Config fixups.

Be explicit about linux package names for those not familiar with
the platform. Also more explicit about steps such as editing file,
and testing the daemon.

Remove leading whitespace from commented-out config examples.
Set default parallel DNS back to 10, and suggest override of 100 in
config file. Enforce skipped DNS for autoconf IPs if unset (this is
a consequence of the way Dancer merges the two files - top level
config cannot be in both files).
This commit is contained in:
Oliver Gorwits
2014-02-08 15:10:57 +00:00
parent 279924d2fb
commit 3a7ffcf379
3 changed files with 46 additions and 39 deletions

View File

@@ -79,6 +79,9 @@ setting('plugins')->{DBIC}->{daemon} = {
schema_class => 'App::Netdisco::Daemon::DB', schema_class => 'App::Netdisco::Daemon::DB',
}; };
# force skipped DNS resolution, if unset
setting('dns')->{no} ||= ['fe80::/64','169.254.0.0/16']
=head1 NAME =head1 NAME
App::Netdisco - An open source web-based network management tool. App::Netdisco - An open source web-based network management tool.
@@ -134,15 +137,15 @@ Notes|App::Netdisco::Manual::ReleaseNotes>.
Netdisco has several Perl library dependencies which will be automatically Netdisco has several Perl library dependencies which will be automatically
installed. However it's I<strongly> recommended that you first install installed. However it's I<strongly> recommended that you first install
L<DBD::Pg> and L<SNMP> using your operating system packages. The following L<DBD::Pg>, L<SNMP>, and a compiler using your operating system packages.
commands will test for the existence of them on your system:
perl -MDBD::Pg\ 999 On Ubuntu/Debian:
perl -MSNMP\ 999
You'll also need a compiler for some of the other Perl dependencies. For root:~# apt-get install libdbd-pg-perl libsnmp-perl build-essential
example on Ubuntu/Debian, install the C<build-essential> package. On
Fedora/Red-Hat, install C<make>, C<automake>, and C<gcc>. On Fedora/Red-Hat:
root:~# yum install perl-DBD-Pg net-snmp-perl make automake gcc
With those installed, we can proceed... With those installed, we can proceed...
@@ -187,7 +190,8 @@ Link some of the newly installed apps into a handy location:
ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/ ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/
Test the installation by running the following command, which should only Test the installation by running the following command, which should only
produce a status message (and throw up no errors): produce a status message (it's just a test - you'll start the daemon properly,
later on):
~/bin/netdisco-daemon status ~/bin/netdisco-daemon status
@@ -200,12 +204,13 @@ template from this distribution:
cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/deployment.yml ~/environments cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/deployment.yml ~/environments
chmod +w ~/environments/deployment.yml chmod +w ~/environments/deployment.yml
Edit the file and change the database connection parameters to match those for Edit the file ("C<~/environments/deployment.yml>") and change the database
your local system (that is, the C<name>, C<host>, C<user> and C<pass>). connection parameters to match those for your local system (that is, the
C<name>, C<host>, C<user> and C<pass>).
In the same file uncomment and edit the C<domain_suffix> setting to be In the same file uncomment and edit the C<domain_suffix> setting to be
appropriate for your local site. Optionally, set the C<no_auth> value to true appropriate for your local site. If this is a fresh install, uncomment and set
if you wish to skip user authentication in the web interface. the C<no_auth> value to true (temporarily disables user authentication).
=head1 Bootstrap =head1 Bootstrap

View File

@@ -162,8 +162,8 @@ workers:
sleep_time: 2 sleep_time: 2
dns: dns:
max_outstanding: 250
no: ['fe80::/64','169.254.0.0/16'] no: ['fe80::/64','169.254.0.0/16']
max_outstanding: 10
#housekeeping: #housekeeping:
# discoverall: # discoverall:

View File

@@ -20,34 +20,36 @@ database:
# will be stripped from fqdn when displayed in the web UI # will be stripped from fqdn when displayed in the web UI
# also, do not forget the leading dot. # also, do not forget the leading dot.
# domain_suffix: '.example.com' # ```````````````````````````````````````````````````````
#domain_suffix: '.example.com'
# uncomment and set to true to disable authentication/login. # uncomment and set to true to disable authentication/login
# no_auth: false # `````````````````````````````````````````````````````````
#no_auth: false
# community: ['public'] # SNMP community string(s)
# community_rw: ['private'] # ````````````````````````
#community: ['public']
#community_rw: ['private']
# when not set, Netdisco loads all MIBs in mibhome directory. # daemon will keep netdisco up to date on this schedule
# mibdirs: # `````````````````````````````````````````````````````
# - cisco #housekeeping:
# - rfc # discoverall:
# - net-snmp # when: '5 7 * * *'
# macwalk:
# when:
# min: 20
# arpwalk:
# when:
# min: 50
# nbtwalk:
# when: '0 8,13,21 * * *'
# expiry:
# when: '20 23 * * *'
# housekeeping: # increase the performance of parallel DNS resolution for node names
# discoverall: # (the default is max_outstanding: 10)
# when: '5 7 * * *' #dns:
# macwalk: # max_outstanding: 100
# when:
# min: 20
# arpwalk:
# when:
# min: 50
# nbtwalk:
# when: '0 8,13,21 * * *'
# expiry:
# when: '20 23 * * *'
# expire_devices: 60
# expire_nodes: 90
# expire_nodes_archive: 60