[Catalyst] Pedantically thorough one-shot catalyst sandbox
installation: eventually intended to install demo/sample apps
at one shot as well
thomashartman1 at googlemail.com
Fri Dec 15 08:49:27 GMT 2006
( Originally posted to perlmonks at http://www.perlmonks.org/?node_id=589529 )
I have released an (in progress) catalyst one-shot installer:
pimpmycat -- into Google code project hosting.
This is the way I have evolved to manage complexity in perl projects
that have a lot of dependencies. For me, the Catalyst ecosystem is the
quintissential example of this, but I am sure it is not the only one,
and I think this approach could be used in other contexts.
I am curious what the other monks/cat users think of this, both those
involved with catalyst and those not.
By the way, mst, this uses the shadowcat installer once perl, cpan,
and module::build are shiny. And zbi, it targets all dependencies
required for the latest version of Helper::InstantCrud to work. My
next goal is to have it actually compile and start as many demo apps
as possible "out of the box." IE, no user interaction whatsoever.
Click and go.
The <a href="http://pimpmycat.googlecode.com/svn/trunk/install/README">README
</a> documentation is pasted in below.
Pimpmycat is the easy way to install a sane catalyst development sandbox on a
possibly non-root-account virgin shell. It provides the developer, or the
curious newbie who would like to experiment, with a more or less "one
click" way to
install a freshly compiled perl, an optimized build system (with an updated CPAN
and Module::Build), Catalyst, many Catalyst helper modules, and finally a number
of Catalyst tutorials and sample applications, which should already be
and ready to run. (This last item is still a work in progress, but that is what
I'm shooting for.)
My hope is that this will ultimately lead to a slick catalyst demo installer
that will run without any babysitting at all. Run it overnight, come
back in the morning
and the final message of the installer is various urls that you can
open in your web browser
to view the various sample and tutorial apps. Not quite there yet, but
I I think I'm close.
Pimpmmycat is ideally suited for users who would like to try out Catalyst on a
shared web host, where there is a large amount of hard disk space but
no root access.
It will also provides a useful tool to help CPAN authors ensure that
install cleanly in various scenarios. (EG, a virgin perl install; a
virgin perl with an updated
CPAN, a virgin pwel plus updated CPAN and Module::Build, etc.)
Basically, this is a collection of simple shell scripts. The main
function is to install a collection of external dependencies organized
around perl under a single top level directory. Along with this, there
are user friendly backup and revert helper scripts to snapshot all
external dependencies at any particular point in time. Snapshot backups
are taken during the install at various crucial points. So, for
example, you don't have
to sit through the half-hour perl compile process more than once. The next
time you want to verify if something installs cleanly against a particular
configuration, you can snapshot-revert to it in just a few seconds.
Developers are encouraged to modify the install script to fold in the
dependency idiosynchracies that their individual projects may have.
The motivating idea is that ideally a catalyst web project (or
actually any project) should be re-installable at will on a virgin
system without any babysitting. However, various rough edges in the
perl ecosystem make this impracticable. Compiling and installing
takes a long time, and many important CPAN modules are "evil" in the
sense that they ask for user input, even if only to cocnfirm some
default. Pimpmycat tries to minimize this evil.
Also, I believe that these constraints tempt module authors to release
modules which, for example, pass all tests only when some particular
dependency is there that they have forgotten about. By providing an easy
way for module authors to snapshot-revert all the way back to a fresh perl,
more thorough testing is encouraged.
This approach could be helpful in non-catalyst development scenarios.
I have toyed with the idea of generalizing this concept as "Pimpmyperl" or
something along those lines, but I explicitly oriented myself around catalyst
for two reasons. First, I am doing a lot of catalyst development now.
Second, the large number of CPAN dependencies required to do useful work
in the Catalyst ecosystem are its greatest strength, but in my opinion also
its achilles heel. So, this is my humble offering to strengthen the strengths
and work around the weakness. Or maybe I just liked the sound of "pimpmycat" :)
The pimpmycat installer has been tested to death on a linode user-mode
virtual linux server running ubuntu dappper drake.
To actually get started using it, do as follows.
Checkout pimpmycat from google project hosting
svn checkout http://pimpmycat.googlecode.com/svn/trunk/ pimpmycat
variable exported by
to conform with your home directory.
This config file is sourced by both the one-shot install script,
and the run environment.
Build external dependencies
thartman at linodewhyou:~/pimpmycat/install$ ./install.sh
-- This is a very thorough install script; takes a long time (maybe
hours) to complete
It installs a local perl, updates cpan, installs module build,
installs catalyst helpers, installs database programs, creates
and finally installs various catalyst demo apps which
should work out of the box. (the last three items are a work in progress)
This script requires some babysitting, but it gives many hints to
make the installation as user friendly as possible
If it doesn't work the first time, there is lots of documentation
inside this script
on how to troubleshoot, work with, and improve it.
Get to know the working environment environment you just installed
-- your default perl... don't like it:
thartman at linodewhyou:~/pimpmycat/install$ which perl # who knows
what has been installed here
-- the perl you get after giving yourself an environment,
which you have complete control over even if you are not root:
thartman at linodewhyou:~/pimpmycat/install$ . ../environment/environment.sh
thartman at linodewhyou:~/pimpmycat/install$ which perl
-- all external dependencies controlled by pimpmycat are installed under
thartman at linodewhyou:~/nbarter/install$ ls -lth
-- Everything installed into this directory is backed up at various
points during the install script
and can be reverted at will, and conveniently, using utilities
Get to know your backups
gets something like
..... more backups from various points in the install
Get to know your backup and revert utilities
If something went wrong with the install, or if you just feel like
you can revert your perl development sandbox to any point that has
been archived here.
For instance, if you want to test that a CPAN module you have under
development installs cleanly against a
freshly installed perl (where CPAN module hasn't been updated, and
so is a few versions old, and you
don't have Module::Build), you could revert your current perl to the
archive like so:
thartman at linodewhyou:~/pimpmycat/install$ . functions.sh # source
the backup/revert functions for your environment
thartman at linodewhyou:~/pimpmycat/install$ revert_external_deps
# revert it
Or, if you would like to archive your current "external
dependencies" to a particular point in time
that you think you may want to later revisit, do:
thartman at linodewhyou:~/nbarter/install$ backup_external_deps hellokitty
backing up /home/thartman/whyou_external_dependencies/current dir
The backup/revert commands are just simple tar commands with a bit
of tweaking to work nicely with pimpmycat.
Look inside functions.sh if you are curious how this works
Set up database ( To do: change this to work with sqlite, which is
easier to install and which tutorials work with )
-- Need root
See if it worked
$ ./runit.sh # should start the catalyst server for the sample
application included in the catalyst tutorial (haven't gotten this
$ wget http://localhost:3000 # should fetch the home page of the
If there are problems with this last bit, the install.sh script didn't
do what it was supposed to do.
I have done my best to package pimpmycat to work on non root systems,
but I may have overlooked something.
So first off have a look at the system dependencies in
This is the script I run against a freshly installed ubuntu system to
get things bootstrapped. I have tried to only include packages which
will be included by default on a shell account provided by a
reasonable web hoster, but maybe I overlooked something. So, verify
that everything this script would install is in fact installed for
you. If there's something missing and you don't have root access,
you could ask your sysadmin if they could just run it as root,
since nothing too controversial gets installed.
If that doesn't seem to be the problem, look at the output files
written under /pimpmycat/install and see if you can diagnose things
Bug reports, improvements, patches, and suggestions can be made to
thomashartman1 at gmail.com
or the catalyst mailing list.
Pimpmycat been tested on a virtuozzo virtual linux at tectonic.net
hosting, and found to have problems:
Cache::FastMmap won't install because of system libraries issue.
This isn't a problem with user mode virtual linus.
I would like to know if it is a problem with xen virtual linux.
More information about the Catalyst