vagrant-irods

This repository contains Vagrant configurations for local iRODS VMs.

Prerequisites

• Install VirtualBox, or alternatively use Libvirt with KVM

• Install Vagrant 2.x

• Install plugins depending on the provider:

  • For VirtualBox, install the vagrant-env and vagrant-disksize plugin: vagrant plugin install vagrant-env vagrant-disksize
  • For Libvirt, install only the vagrant-env plugin: vagrant plugin install vagrant-env (since the disksize plugin is incompatible with the Libvirt provider)

• You may need to update your Vagrant libvirt plugin if it's old, e.g.: vagrant plugin install vagrant-libvirt --plugin-version 0.12.2

Included configurations

• irods-single-server: a basic plain vanilla iRODS server for local testing.
• irods-provider-consumer: an iRODS zone consisting of a provider and a single consumer. The VMs are meant for local testing, and run with default key values.
• irods-icommands: a VM which contains the icommands tools for remote administration of iRODS.

These scripts should support the 4.2.x and 4.3.x iRODS versions that are available through the package repositories. As of 4 March 2026, versions 4.2.2 through 4.2.12, as well as 4.3.0 through 4.3.5, as well as version 5.0.0 through 5.0.2 are available in the repositories.

The following distributions are supported:

• iRODS 4.2.x: Ubuntu 18.04 LTS (bionic)
• iRODS 4.2.12 and 4.3.x: Ubuntu 20.04 LTS (focal)
• iRODS 4.3.4 and up, as well as iRODS 5.0.x: Ubuntu 24.04 LTS (noble)

Usage

• If you use Windows, ensure that core.autocrlf is set to false in your git client before you clone the Vagrant-irods repository: git config --global core.autocrlf false
• Clone the vagrant-irods repository: git clone https://github.com/utrechtuniversity/vagrant-irods.git
• Go to the configuration directory. For example : cd vagrant-irods/irods-single-server
• Optionally adjust the settings in the .env file. You might want to change the image of the VM, the amount of memory assigned to the VM or the iRODS version to be installed.
• If you want to use Libvirt rather than VirtualBox, change the Vagrant default provider: export VAGRANT_DEFAULT_PROVIDER=libvirt
• Start and provision the VM(s): vagrant up
• After the VM is provisioned, you should be able to log in using vagrant ssh. In case of the provider-consumer setup, use vagrant ssh provider or vagrant ssh consumer.