some documentation fixes (#640)

* a few more files to ignore

* the pgtune we reference seems to be dead, provide
a few alternatives.

* steal pod syntax check from snmp::info, but don't bother with checking Test::Pod version.
we want 1.22 or later, which was released in 2005

* reference the release notes in our wiki. changes you need to make manually during upgrades are documented there.

* add pod test to manifest

* term was defined around line 111 and then again at line 209, rename the second one
This commit is contained in:
nick n
2019-08-29 02:22:28 +02:00
committed by GitHub
parent 9730b87afa
commit a734890055
6 changed files with 59 additions and 20 deletions

View File

@@ -71,7 +71,7 @@ these is an optional service which the user is asked to confirm.
Pre-existing requirements are that there be a database table created and a
user with rights to create tables in that database. Both the table and user
name must match those configured in your environment YAML file (default
C<~/environments/deployment.yml>).
F<~/environments/deployment.yml>).
This script will download the latest MAC address vendor prefix data from the
Internet, and update the OUI table in the database. Hence Internet access is
@@ -80,10 +80,17 @@ required to run the script.
Similarly the latest Netdisco MIB bundle is also downloaded and placed into
the user's home directory (or C<$ENV{NETDISCO_HOME}>).
If you upgrade Netdisco make sure you run this script again to make sure
your config remains compatible.
Before each upgrade also review the
L<Release notes|https://github.com/netdisco/netdisco/wiki/Release-Notes> since
additional steps might be required!
=cut
print color 'bold cyan';
say 'This is the Netdisco II deployment script.';
say 'This is the Netdisco 2 deployment script.';
say '';
say 'Before we continue, the following prerequisites must be in place:';
say ' * Database added to PostgreSQL for Netdisco';
@@ -92,6 +99,11 @@ say ' * "~/environments/deployment.yml" file configured with Database dsn/user/p
say ' * A full backup of any existing Netdisco database data';
say ' * Internet access (for OUIs and MIBs)';
say '';
say 'If you are upgrading Netdisco 2 read the release notes:';
say 'https://github.com/netdisco/netdisco/wiki/Release-Notes';
say 'There you will find required and incompatible changes';
say 'which are not covered by this script.';
say '';
say 'You will be asked to confirm all changes to your system.';
say '';
print color 'reset';
@@ -194,13 +206,13 @@ sub deploy_db {
}
sub get_userpass {
my $term = shift;
my $name = $term->get_reply(prompt => 'Username: ');
my $pass = $term->get_reply(prompt => 'Password: ');
my $upterm = shift;
my $name = $upterm->get_reply(prompt => 'Username: ');
my $pass = $upterm->get_reply(prompt => 'Password: ');
unless ($name and $pass) {
say 'username and password cannot be empty, please try again.';
($name, $pass) = get_userpass($term);
($name, $pass) = get_userpass($upterm);
}
return ($name, $pass);
@@ -257,7 +269,7 @@ sub deploy_oui {
print color 'reset';
}
# This subroutine is baed on Wireshark's make-manuf
# This subroutine is based on Wireshark's make-manuf
# http://anonsvn.wireshark.org/wireshark/trunk/tools/make-manuf
sub shorten {
my $manuf = shift;