Skip to content

Latest commit

 

History

History
188 lines (140 loc) · 14.3 KB

README.md

File metadata and controls

188 lines (140 loc) · 14.3 KB
Raw

Vagrant + DSpace = vagrant-dspace

Vagrant can be used to spin up a temporary Virtual Machine (VM) in a variety of providers (VirtualBox, VMWare, Amazon AWS, etc).

Simply put, 'vagrant-dspace' uses Vagrant and Puppet to auto-install latest DSpace on the VM provider of your choice (though so far we've mostly tested with VirtualBox).

Some example use cases for 'vagrant-dspace':

  • Lets you easily install the latest version of DSpace on a Virtual Machine in order to try it out or test upgrades, etc.
  • Lets you easily setup an offline/local copy of DSpace for demos at conferences or similar.
  • Lets you quickly setup a DSpace development environment on a Virtual Machine. You'd need to install your IDE of choice, but besides that, everything else is installed for you.
  • Vagrant VMs are "throwaway". Can easily destroy the VM and recreate at will for testing purposes or as needs arise (e.g. vagrant destroy; vagrant up)

This work began as a collaborative project between tdonohue and hardyoyo, but has now been more broadly accepted.

BIG WARNING: THIS IS STILL A WORK IN PROGRESS. YOUR MILEAGE MAY VARY. NEVER USE THIS IN PRODUCTION.

How it Works

'vagrant-dspace' does all of the following for you:

  • Spins up an Ubuntu 12.04 VM using Vagrant
  • Installs some of the basic prerequisites for DSpace Development (namely: Git, Java, Maven)
  • Clones DSpace source from GitHub to ~/dspace-src/ (under the default 'vagrant' user account)
  • Installs/Configures PostgreSQL
  • Installs Tomcat to ~/tomcat/ (under the default 'vagrant' user account)
    • We install tdonohue/puppet-tomcat (via librarian-puppet), and then use that Puppet module to setup Tomcat
    • WARNING: We are just pulling down the latest "master" code from tdonohue/puppet-tomcat at this time.
  • Installs DSpace to ~/dspace/ (under the default 'vagrant' user account).
  • Sets up SSH Forwarding, so that you can use your local SSH key(s) on the VM (for development with GitHub)
  • Syncs your local Git settings (name and email from local .gitconfig) to VM (for development with GitHub)

If you want to help, please do. We'd prefer solutions using Puppet.

Requirements

  • Vagrant version 1.3.2 or higher
  • VirtualBox
  • A GitHub account with an associated SSH key: As vagrant-dspace was built initially as a developer tool, at this time one must have a GitHub account (and an associated SSH key) in order for 'vagrant-dspace' to be able to download DSpace source from GitHub. Please note, we are working on removing this requirement in the future.

How To Use vagrant-dspace

  1. Install Vagrant (Only tested with the VirtualBox provider so far)
  2. Clone a copy of 'vagrant-dspace' to your local computer
    • git clone git@github.com:DSpace/vagrant-dspace.git
  3. WINDOWS ONLY : Any users of Vagrant from Windows MUST create a GitHub-specific SSH Key (at ~/.ssh/github_rsa) which is then connected to your GitHub Account. There are two easy ways to do this:
    • Install GitHub for Windows - this will automatically generate a new ~/.ssh/github_rsa key.
    • OR, manually generate a new ~/.ssh/github_rsa key and associate it with your GitHub Account. GitHub has detailed instructions on how to do this.
    • SIDENOTE: Mac OSX / Linux users do NOT need this, as Vagrant's SSH Key Forwarding works properly from Mac OSX & Linux. There's just a bug in using Vagrant + Windows.
  4. cd [vagrant-dspace]/
  5. vagrant up
    • Wait for ~15 minutes while Vagrant & Puppet do all the heavy lifting of cloning GitHub & building & installing DSpace.
    • There may be times that vagrant will appear to "stall" for several minutes (especially during the Maven build of DSpace). But, don't worry.
  6. Once complete, visit http://localhost:8080/xmlui/ or http://localhost:8080/jspui/ in your local web browser to see if it worked! More info below on what to expect.
    • If you already have something running locally on port 8080, vagrant-dspace will attempt to use the next available port between 8081 and 8100.

The vagrant up command will initialize a new VM based on the settings in the Vagrantfile in that directory.

Once complete, you'll have a fresh Ubuntu VM that you can SSH into by simply typing vagrant ssh. Since SSH Forwarding is enabled, that Ubuntu VM should have access to your local SSH keys, which allows you to immediately use Git/GitHub.

What will you get?

  • A running instance of DSpace 'master', on top of latest PostgreSQL and Tomcat 7 (and using Java OpenJDK 7 by default)
  • A fresh Ubuntu virtual server with DSpace GitHub cloned (at ~/dspace-src/) and Java/Maven/Ant/Git installed.
  • All "out of the box" DSpace webapps running out of ~/dspace/webapps/. The full DSpace installation is at ~/dspace/.
  • Tomcat 7 instance installed at ~/tomcat/
    • Includes PSI Probe running at http://localhost:8080/probe/
      • PSI Probe Login: 'dspace', Pwd: 'vagrant'
  • Enough to get you started with developing/building/using DSpace (or debug issues with the DSpace build process, if any pop up)
    • Though you may wish to install your IDE of choice.
  • A very handy playground for testing multiple-machine configurations of DSpace, and software that might utilize DSpace as a service

It is up to you to continue the DSpace setup, as needed.

Your first step should be to change the default password(s), and/or optionally create a new administrator:

vagrant ssh
~dspace/bin/dspace create-administrator

It is also worth noting that you may choose to tweak the default Vagrantfile to better match your own development environment. There's even a few quick settings there to get you started.

If you want to destroy the VM at anytime (and start fresh again), just run vagrant destroy. No worries, you can always recreate a new VM from scratch with another vagrant up.

As you develop with 'vagrant-dspace', from time to time you may want to run a vagrant destroy cycle (followed by a fresh vagrant up), just to confirm that the Vagrant setup is still doing exactly what you want it to do. This cleans out any old experiments and starts fresh with a new base image. If you're just using vagrant-dspace for dspace development, this isn't advice for you. But, if you're working on contributing back to vagrant-dspace, do try this from time to time, just to sanity-check your Vagrant and Puppet scripts.

Additional Vagrant Plugin Recommendations

The following Vagrant plugins are not required, but they do make using Vagrant and vagrant-dspace more enjoyable.

How to Tweak Things to your Liking?

local.yaml

If you look at the config folder, there are a few files you'll be interested in. The first is common.yaml, it's a Hiera configuration file. You may copy this file to one named local.yaml. Any changes to local.yaml will override the defaults set in the common.yaml file. The local.yaml file is ignored in .gitignore, so you won't accidentally commit it. Here are the options:

  • git_repo - it would be a good idea to point this to your own fork of DSpace
  • git_branch - if you're constantly working on another brach than master, you can change it here
  • mvn_params - add other maven prameters here (this is added to the Vagrant user's profile, so these options are always on whenever you run mvn as the Vagrant user
  • ant_installer_dir - until we figure out how to have the installer just run from whatever version of DSpace is in the target folder produced by Maven, we'll need to hard code the DSpace version so we can have Puppet look in the right place to run the Ant installer for DSpace
  • admin_firstname - you may want to change this to something more memorable than the demo DSpace user
  • admin_lastname - ditto
  • admin_email - likewise
  • admin_passwd - you probably have a preferred password
  • admin_language - and you my have a language preference, you can set it here

local-bootstrap.sh

In the config folder, you will also find a file called local-bootstrap.sh.example. If you copy that file to local-bootstrap.sh and edit it to your liking (it is well-commented) you'll be able to customize your git clone folder to your liking (turning on the color.ui, always pull using rebase, set an upstream github repository, add the ability to fetch pull requests from upstream), as well as automatically batch-load content (an example using AIPs is included, but you're welcome to script whatever you need here... if you come up with something interesting, please consider sharing it with the community).

local-bootstrap.sh is a "shell provisioner" for Vagrant, and our vagrantfile is configured to run it if it is present in the config folder. If you have a fork of Vagrant-DSpace for your own repository management, you may add another shell provisioner, to maintain your own workgroup's customs and configurations. You may find an example of this in the Vagrant-MOspace repository.

maven_settings.xml

If you've copied the example local-bootstrap.sh file, you may create a config/dotfiles folder, and place a file called maven_settings.xml in it, that file will be copied to /home/vagrant/.m2/settings.xml every time the local-bootstrap.sh provisioner is run. This will allow you to further customize your Maven builds. One handy (though somewhat dangerous) thing to add to your settings.xml file is the following profile: sign true <gpg.passphrase>add-your-passphrase-here-if-you-dare</gpg.passphrase>

NOTE: any file in config/dotfiles is ignored by Git, so you won't accidentally commit it. But, still, putting your GPG passphrase in a plain text file might be viewed by some as foolish. If you elect to not add this profile, and you DO want to sign an artifact created by Maven using GPG, you'll need to enter your GPG passphrase quickly and consistently. Choose your poison.

vim and .vimrc

Another optional config/dotfiles folder which is copied (if it exists) by the example local-bootstrap.sh shell provisioner is config/dotfiles/vimrc (/home/vagrant/.vimrc) and config/dotfiles/vim (/home/vagrant/.vim). Populating these will allow you to customize Vim to your heart's content.

What's Next?

Here are a few things we'd like to explore in future version of vagrant-dspace:

  • use a CentOS base machine, and make all Puppet provisioning modules compatible with a Yum-based package manager. The current vagrant-dspace project relies on a package only available on Debian-based systems. We'd really like to avoid that dependency in the future.
  • Oracle database version (Hardy is busy working on this already, contact him if you'd like to help).
  • Multi-machine configuration, to demonstrate proper configuration of multi-machine installations of DSpace. One possibility would be to set up a seperate Elastic Search or Solr box, and send usage statistics to that external box. Another possibility would be to explore using an alternate UI based on the REST-API. We recommend that you use the Land Rush Vagrant plugin if you're serrious about exploring a multi-machine Vagrant setup.

Tools we use to make this all work

  • Vagrant (obviously)
  • Puppet - To actually clone, build, configure & install DSpace from GitHub
  • Librarian-Puppet - Used to install the external Puppet Modules which setup Tomcat & PostgreSQL

Reporting Bugs / Requesting Enhancements

Bugs / Issues or requests for enhancements can be reported via the DSpace Issue Tracker. Please select the "vagrant-dspace" component when creating your ticket in the issue tracker.

We also encourage you to submit Pull Requests with any recommended changes/fixes. As it is, the 'vagrant-dspace' project is really just a labor of love, and we can use help in making it better.

License

This work is licensed under the DSpace BSD 3-Clause License, which is just a standard BSD 3-Clause License.