From 70426a3bcd17ba16e942267758467945da98dee0 Mon Sep 17 00:00:00 2001 From: Oliver Gorwits Date: Sun, 9 Dec 2012 12:35:22 +0000 Subject: [PATCH] simple POD changes and the like --- Changes | 17 +++++---- Netdisco/bin/create_netdisco_schema_version | 13 +++++++ Netdisco/bin/upgrade_netdisco_schema_version | 39 +++++++++++++++++++- Netdisco/config.yml | 9 +++-- TODO | 1 - 5 files changed, 66 insertions(+), 13 deletions(-) delete mode 100644 TODO diff --git a/Changes b/Changes index cad81c97..ad91bd47 100644 --- a/Changes +++ b/Changes @@ -1,7 +1,8 @@ -0.8 - +2.8 - [NEW FEATURES] + * Refactor to make less webby and more suitable to be a complete Netdisco app * Network Map now shows all device neighbors and allows click-through nav * Add new netdisco-daemon to handle port_control actions @@ -17,7 +18,7 @@ * node search switchport link shows connected nodes again * show device IP in search results when DNS is not available -0.7 - 2012-11-25 +2.7 - 2012-11-25 [NEW FEATURES] @@ -43,7 +44,7 @@ * Fix netgear port ordering (closes #26) * Fix Foundry 10GE port ordering -0.6 2012-08-28 +2.6 2012-08-28 [NEW FEATURES] @@ -68,7 +69,7 @@ * Fix sidebar hiding not making main content reflow to full window width (#15) -0.5 2012-03-09 +2.5 2012-03-09 [NEW FEATURES] @@ -88,13 +89,13 @@ * Set distinct on device search (#12) * Fix strikethrough on tab change (#9) -0.4 2012-02-19 +2.4 2012-02-19 [NEW FEATURES] * Sidebar can be pinned in place to keep it visible when scrolling. -0.3 2011-02-03 +2.3 2011-02-03 [NEW FEATURES] @@ -111,7 +112,7 @@ * Refactor Stylsheets to better organise and comment the settings. * When Device Search sidebar is in use, strikethrough the navbar search. -0.2 2011-01-22 +2.2 2011-01-22 [NEW FEATURES] @@ -135,6 +136,6 @@ * Device Ports Legend show/hide arrow was pointing the wrong way. * Increase TT WHILE_MAX to allow very long lists of ports. -0.1 2011-01-18 +2.1 2011-01-18 * Initial release on an unsuspecting world. diff --git a/Netdisco/bin/create_netdisco_schema_version b/Netdisco/bin/create_netdisco_schema_version index 8b19e7a4..e45d71f5 100755 --- a/Netdisco/bin/create_netdisco_schema_version +++ b/Netdisco/bin/create_netdisco_schema_version @@ -35,3 +35,16 @@ ENDHELP }; schema->create_ddl_dir( 'PostgreSQL', $version, $sql_dir, $preversion ); + +=head1 create_netdisco_schema_version + +This script creates SQL DDL files of the Netdisco database schema. + +If called without any CLI options, it makes one SQL DDL file which will +initialize the complete schema to the current DBIx::Class specification. + +If called with the "-p " option, upgrade SQL DDL command files +are created between the specified version and the current DBIx::Class +specification. + +=cut diff --git a/Netdisco/bin/upgrade_netdisco_schema_version b/Netdisco/bin/upgrade_netdisco_schema_version index 243f1415..4be0d93f 100755 --- a/Netdisco/bin/upgrade_netdisco_schema_version +++ b/Netdisco/bin/upgrade_netdisco_schema_version @@ -6,7 +6,6 @@ use warnings FATAL => 'all'; use Dancer ':script'; use Dancer::Plugin::DBIC 'schema'; -use Netdisco::DB; use Try::Tiny; use feature 'say'; @@ -29,3 +28,41 @@ try { # upgrades from whatever dbix_class_schema_versions says, to $VERSION say 'Upgrading Netdisco::DB schema...'; schema->txn_do(sub { schema->upgrade() }); + +=head1 upgrade_netdisco_schema_version + +This script upgrades or initialises a Netdisco database schema. + +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). + +Simply run this script, which connects to the database and runs without user +interaction. If there's no Nedisco schema, it is deployed. If there's an +unversioned schema then versioning is added, and updates applied. Otherwise +only necessary updates are applied to an already versioned schema. + +=head2 Versions + +=over 4 + +=item * + +Version 1 is a completely empty database schema with no tables + +=item * + +Version 2 is the "classic" Netdisco database schema as of Netdisco 1.1 + +=item * + +Version 3 adds patches for Netdisco 1.2 + +=item * + +Version 4 (not yet created) B + +=back + +=cut diff --git a/Netdisco/config.yml b/Netdisco/config.yml index 0cb29b4a..50225a7d 100644 --- a/Netdisco/config.yml +++ b/Netdisco/config.yml @@ -1,11 +1,12 @@ -# This is the main configuration file of your Dancer app -# env-related settings should go to environments/$env.yml +# This is the main configuration file for Netdisco web and daemon apps # all the settings in this file will be loaded at Dancer's startup. +# Web app env-related settings should go to environments/$env.yml + # Your application's name appname: "Netdisco" -# The default layout to use for your application (located in +# The default web layout to use for your application (located in # views/layouts/main.tt) layout: "main" @@ -14,8 +15,10 @@ layout: "main" # about unicode within your app when this setting is set (recommended). charset: "UTF-8" +# web sessions stored in memory session: Simple +# web output template settings template: "template_toolkit" engines: template_toolkit: diff --git a/TODO b/TODO deleted file mode 100644 index 7310bcf9..00000000 --- a/TODO +++ /dev/null @@ -1 +0,0 @@ -See https://github.com/ollyg/netdisco-frontend-sandpit/issues