[Bast-commits] r8296 - ironman

[idn at dev.catalyst.perl.org]

Author: idn
Date: 2010-01-13 17:08:36 +0000 (Wed, 13 Jan 2010)
New Revision: 8296

Added:
   ironman/notes.pod
Log:
Adding idn notes to svn so that I can work out what the fuck I'm doing

Added: ironman/notes.pod
===================================================================
--- ironman/notes.pod	                        (rev 0)
+++ ironman/notes.pod	2010-01-13 17:08:36 UTC (rev 8296)
@@ -0,0 +1,87 @@
+=head1 Installation notes for Ironman archives
+
+This document is IanNs brain dump of how the ironman archives fit together.
+
+This service is hosted on kitty.scsys.co.uk.  Development and testing is
+performed under the ironboy user and home dir.  Live service is then deployed
+under the ironman user and home dir.
+
+=head2 Deployment process
+
+Thus spake the mst:
+
+    12:18 < mst> it's the dev account for ironman.
+    12:18 < mst> first, you make it work with the dev server
+    12:18 < mst> second, we make it work under FastCGI
+    12:18 < mst> third, we run it for a bit
+    12:18 < mst> fourth, we roll it out to ironman.
+
+Here endeth the lesson....
+
+=head2 Shell access
+
+Use the sush command to become the ironboy user via sudo:
+
+    sush ironboy
+
+=head2 CPAN
+
+Ironboy and Ironman both make use of local::lib for their CPAN modules.
+Additional modules can be correctly installed within these paths simply by
+using CPAN as normal.
+
+More info on the deeper magic at http://search.cpan.org/~apeiron/local-lib/lib/local/lib.pm
+
+=head1 Initial data import
+
+=head2 Data sources
+
+Create copies of the data so that we're not working on live files:
+
+    cd ~ironboy/ironman/
+    cp -r ~ironman/plagger/csv .
+    cp /var/www/ironman.enlightenedperl.org/plagger/subscriptions.db .
+
+=head2 Upgrade the database schema
+
+Given the copy of the subscriptions.db file we have, we need to upgrade it to
+the latest schema version prior to being able to make full use of it.  This is
+another reason to do this on a copy and not the live data.
+
+Upgrade the copied subscriptions.db schema:
+
+    cd ~ironboy/
+    perl -I ironman/plagger/lib/ \
+         ironman/IronMan-Web/script/upgrade-db-schema.pl \
+         --db_path=ironman/subscriptions.db
+
+This may generate a number of error messages.
+
+=head2 Importing the existing CSV data
+
+Once the database schema has been upgraded, the next step is to perform the one
+off CSV import again utilising the test data copied from the live system.
+
+    cd ~ironboy/
+    perl -I ironman/plagger/lib/ \
+         ironman/IronMan-Web/script/import_csv.pl \
+         --db_path=ironman/subscriptions.db \
+         --csv_path=ironman/csv
+
+This will import the existing CSV data generated by plagger.  This import can
+be run multiple times against the same dataset with no ill effect.
+
+=head2 Testing the web UI
+
+Change the DBI source in IronMan-Web/lib/IronMan/Web/Model/FeedDB.pm:
+
+    dbi:SQLite:/var/www/ironboy.enlightenedperl.org/ironman/subscriptions.db
+
+Run this up as an independent service just to verify deps:
+
+    perl -I ironman/plagger/lib/ \
+         ironman/IronMan-Web/script/ironman_web_server.pl
+
+
+
+=cut