135/netdisco
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update deployment docs; add missing JSON dependency

Browse Source
This commit is contained in:
Oliver Gorwits
2012-12-19 07:01:25 +00:00
parent 4b7616aff1
commit c4598f2e41
4 changed files with 108 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Netdisco/Makefile.PL
View File

@@ -14,6 +14,7 @@ requires 'Dancer::Plugin::DBIC' => 0;
requires 'File::ShareDir' => 0;
requires 'HTML::Entities' => 0;
requires 'HTTP::Tiny' => 0;
requires 'JSON' => 0;
requires 'List::MoreUtils' => 0;
requires 'Net::MAC' => 0;
requires 'NetAddr::IP' => 0;

86
Netdisco/lib/App/Netdisco.pm
View File

@@ -37,7 +37,7 @@ on the project.
If you have any trouble getting the frontend running, or it blows up in your
face, please speak to someone in the C<#netdisco> IRC channel (on freenode).
=head1 Installation
=head1 Dependencies
Netdisco has several Perl library dependencies which will be automatically
installed. However it's I<strongly> recommended that you first install
@@ -47,51 +47,74 @@ commands will test for the existence of them on your system:
perl -MDBD::Pg\ 999
perl -MSNMP\ 999
With that done, we can proceed...
With those two installed, we can proceed...
Create a user on your system called C<netdisco> if one does not already exist.
We'll install Netdisco and its dependencies into this user's home area, which
will take about 200MB including MIB files.
Netdisco uses the PostgreSQL (Pg) database server. Install Pg and then change
to the PostgreSQL superuser (usually C<postgres>). Create a new database and
Pg user for the Netdisco application:
postgres:~$ createuser -DRSP netdisco
Enter password for new role:
Enter it again:
postgres:~$ createdb -O netdisco netdisco
=head1 Installation
To avoid muddying your system, use the following script to download and
install Netdisco and its dependencies into your home area:
install Netdisco and its dependencies into the C<netdisco> user's home area
(C<~netdisco/perl5>).
curl -L http://cpanmin.us/ | perl - \
--notest --quiet --local-lib ${HOME}/perl-profiles/netdisco" \
su - netdisco
curl -L http://cpanmin.us/ | perl - --notest --quiet \
--local-lib ~/perl5 \
App::cpanminus \
App::local::lib::helper \
App::Netdisco
Link some of the newly installed apps into the C<netdisco> user's C<$PATH>,
e.g. C<~netdisco/bin>:
ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/
Test the installation by running the following command, which should only
produce some help text (and throw up no errors):
~/perl-profiles/netdisco/bin/localenv netdisco-daemon --help
localenv netdisco-daemon
=head1 Configuration
Netdisco uses a PostgreSQL (Pg) database. You can use this application with an
existing database, or set up a new one. At a minimum (if starting from
scratch) you should have created a Database in Pg, and created a User in Pg
with rights on the Database:
Make a directory for your local configuration and copy the configuration
template from this distribution:
postgres:~$ createuser -DRSP netdisco
postgres:~$ createdb -O netdisco netdisco
mkdir ~/environments
cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/development.yml ~/environments
chmod +w ~/environments/developemnt.yml
Make a directory for your local configuration, and copy the
C<share/environments/development.yml> file from this distribution into it.
Edit the file and change the database connection parameters for your local
system (the C<dsn>, C<user> and C<pass>).
Edit the file and change the database connection parameters to match those for
your local system (that is, the C<dsn>, C<user> and C<pass>).
Optionally, in the same file uncomment and edit the C<domain_suffix> setting
to be appropriate for your local site (same as the C<domain> setting in
C<netdisco.conf>).
to be appropriate for your local site.
Finally, run the following script to bring you up to date:
~/perl-profiles/netdisco/bin/localenv netdisco-db-deploy
=head1 Bootstrap
=head1 Startup
Make a note of the directory containing C<development.yml> and run the
following command to start the web server, substituting as appropriate:
Run the following command to start the web server:
DANCER_ENVIRONMENT=/change/me/dir ~/perl-profiles/netdisco/bin/localenv netdisco-web
DANCER_ENVDIR=~/environments localenv plackup ~/bin/netdisco-web
Other ways to run and host the web application can be found in the
L<Dancer::Deployment> page. See also the L<plackup> documentation.
Run the following command to start the daemon:
DANCER_ENVDIR=~/environments localenv netdisco-daemon start
=head1 Tips and Tricks
@@ -102,8 +125,7 @@ or MAC addreses, VLAN numbers, and so on.
For SQL debugging try the following command:
DBIC_TRACE_PROFILE=console DBIC_TRACE=1 \
DANCER_ENVIRONMENT=/change/me/dir \
~/perl-profiles/netdisco/bin/localenv netdisco-web
DANCER_ENVDIR=~/environments plackup ~/bin/netdisco-web
=head1 Future Work
@@ -127,10 +149,16 @@ mismatches). These might be implemented as a plugin bundle.
The Wireless, IP Phone and NetBIOS Node properies are not yet shown.
=head1 AUTHOR
=head1 AUTHORS
=over 4
=item *
Oliver Gorwits <oliver@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by The Netdisco Developer Team.

2
Netdisco/share/environments/development.yml
View File

@@ -9,7 +9,7 @@ logger: "console"
# the log level for this environement
# core is the lowest, it shows Dancer's core log messages as well as yours
# (debug, warning and error)
log: "core"
log: "debug"
# should Dancer consider warnings as critical errors?
warnings: 1

78
README.txt
View File

@@ -10,7 +10,7 @@ Introduction
your face, please speak to someone in the "#netdisco" IRC channel (on
freenode).
Installation
Dependencies
Netdisco has several Perl library dependencies which will be
automatically installed. However it's *strongly* recommended that you
first install DBD::Pg and SNMP using your operating system packages. The
@@ -19,49 +19,70 @@ Installation
perl -MDBD::Pg\ 999
perl -MSNMP\ 999
With that done, we can proceed...
With those two installed, we can proceed...
Create a user on your system called "netdisco" if one does not already
exist. We'll install Netdisco and its dependencies into this user's home
area, which will take about 200MB including MIB files.
Netdisco uses the PostgreSQL (Pg) database server. Install Pg and then
change to the PostgreSQL superuser (usually "postgres"). Create a new
database and Pg user for the Netdisco application:
postgres:~$ createuser -DRSP netdisco
Enter password for new role:
Enter it again:
postgres:~$ createdb -O netdisco netdisco
Installation
To avoid muddying your system, use the following script to download and
install Netdisco and its dependencies into your home area:
install Netdisco and its dependencies into the "netdisco" user's home
area ("~netdisco/perl5").
curl -L http://cpanmin.us/ | perl - \
--notest --quiet --local-lib ${HOME}/perl-profiles/netdisco" \
su - netdisco
curl -L http://cpanmin.us/ | perl - --notest --quiet \
--local-lib ~/perl5 \
App::cpanminus \
App::local::lib::helper \
App::Netdisco
Link some of the newly installed apps into the "netdisco" user's $PATH,
e.g. "~netdisco/bin":
ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/
Test the installation by running the following command, which should
only produce some help text (and throw up no errors):
~/perl-profiles/netdisco/bin/localenv netdisco-daemon --help
localenv netdisco-daemon
Configuration
Netdisco uses a PostgreSQL (Pg) database. You can use this application
with an existing database, or set up a new one. At a minimum (if
starting from scratch) you should have created a Database in Pg, and
created a User in Pg with rights on the Database:
Make a directory for your local configuration and copy the configuration
template from this distribution:
postgres:~$ createuser -DRSP netdisco
postgres:~$ createdb -O netdisco netdisco
mkdir ~/environments
cp ~/perl5/lib/perl5/auto/share/dist/App-Netdisco/environments/development.yml ~/environments
chmod +w ~/environments/developemnt.yml
Make a directory for your local configuration, and copy the
"share/environments/development.yml" file from this distribution into
it. Edit the file and change the database connection parameters for your
local system (the "dsn", "user" and "pass").
Edit the file and change the database connection parameters to match
those for your local system (that is, the "dsn", "user" and "pass").
Optionally, in the same file uncomment and edit the "domain_suffix"
setting to be appropriate for your local site (same as the "domain"
setting in "netdisco.conf").
Finally, run the following script to bring you up to date:
~/perl-profiles/netdisco/bin/localenv netdisco-db-deploy
setting to be appropriate for your local site.
Bootstrap
Startup
Make a note of the directory containing "development.yml" and run the
following command to start the web server, substituting as appropriate:
Run the following command to start the web server:
DANCER_ENVIRONMENT=/change/me/dir ~/perl-profiles/netdisco/bin/localenv netdisco-web
DANCER_ENVDIR=~/environments localenv plackup ~/bin/netdisco-web
Other ways to run and host the web application can be found in the
Dancer::Deployment page. See also the plackup documentation.
Run the following command to start the daemon:
DANCER_ENVDIR=~/environments localenv netdisco-daemon start
Tips and Tricks
The main black navigation bar has a search box which is smart enough to
@@ -71,8 +92,7 @@ Tips and Tricks
For SQL debugging try the following command:
DBIC_TRACE_PROFILE=console DBIC_TRACE=1 \
DANCER_ENVIRONMENT=/change/me/dir \
~/perl-profiles/netdisco/bin/localenv netdisco-web
DANCER_ENVDIR=~/environments plackup ~/bin/netdisco-web
Future Work
The intention is to support "plugins" for additonal features, most
@@ -96,8 +116,8 @@ Caveats
The Wireless, IP Phone and NetBIOS Node properies are not yet shown.
AUTHOR
Oliver Gorwits <oliver@cpan.org>
AUTHORS
* Oliver Gorwits <oliver@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by The Netdisco Developer Team.