ICA-AtoM virtual appliance

From ICA-AtoM
Revision as of 19:02, 19 December 2009 by Austin (talk | contribs)
Jump to navigation Jump to search

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.

ICA-Atom VE is distributed as a virtual appliance.

This allows it to be run on almost any workstation or server hardware without compromising the host machine's operating system or application software. At the same time, the virtual appliance is able to interact with any number of networked and/or external storage devices to allow for the flexible implementation of an archival storage and backup strategy.

  • See the ICA-Atom Documentation page for instructions on how to use the virtual appliance.


Minimum hardware requirements

  • Processor: Intel core 2 or AMD Opteron
  • Memory: 256MB for the virtual appliance ('guest') operating system, i.e: if the 'host' operating system has 2GB available, 256MB needs to allocated to the 'guest'. Depending on the operating system, machines with less than 1.5GB total memory will likely have trouble running Archivematica. Note that the default allocation setting in Archivematica is 256MB; however, the more that is allocated the better the system will run. The setting can be changed once Archivematica is running.
  • Hard Drive space: a minimum of 1GB to test the system on a small scale (i.e. use the available test files or import a small set of test files); 5GB or more for larger implementations

Instructions for using the vmserver image

Install Sun Virtual Box

Download ICA-Atom vmserver

  • Download ICA-Atom vmserver: ica-atom-vmserver-2009-12-09.tgz (md5)
  • Unzip the ICA-atom-vmserver file. This should result in the following two files appearing in an ubuntu-vmserver folder:
    • ubuntu.vmx
    • disk0.vmdk

Setup ICA-Atom in VirtualBox

Add vmserver image to VirtualBox

  • Open the Sun VirtualBox virtual machine.
  • Click New

0-new.png


  • Click Next

1-Start-vmserver-setup.png


  • Enter a Name eg 'ICA-Atom'
  • Set OS type as operating system 'Linux' version 'Ubuntu'
  • Click Next

2-set-name-vmserver-setup.png


  • Set Base Memory Size to '256MB'
  • Click Next

3-set-mem-vmserver.png


  • Select Use Existing Hard Disk

4-use-existing.png


  • Click Folder/Arrow icon for Virtual Media Manager

5-click-folder-icon.png


  • Click Add

6-virtual-media-manger-add.png


  • Browse to location of disk0.vmdk and Click select/Open (ubuntu-vmserver folder)
  • Highlight newly added disk and click select

7-select-disk.png


  • Click Next

8-finish-add-vmserver.png


  • Review Selections, click Finish

9-finish.png


  • fin! ICA-Atom should be Visible on the left hand side of VirtualBox

VirtualBox Networking

Host-Only Adapter

  • Right Click ICA-Atom in VirtualBox
  • Choose Settings

0-settings.png


  • Select Network

2-selectnetwork.png


  • Choose 'Host-Only Adapter' in 'Attached to' drop down

3-select-host-only.png


  • Click OK

5-click.OK.png

Start The Machine

  • Click Start

0-start.png


  • Wait for Boot to complete

1-complete-boot.png


3-ica-atom.png


  • To complete your ICA-Atom installation Please refer to these instructions: Qubit Installation
  • Congratulations, you have a running copy of ICA-Atom! See the User_manual for instructions on how to use the software.

Turn off virtual machine

  • At the end of your session, turn off the VirtualBox virtual machine by going to Machine > Close > and selecting one of the three shutdown options. It is best to choose either "Save the machine state" or "Send the shutdown signal". This is from the VirtualBox help manual:

3.4.3. Saving the state of the machine

When you click on the "Close" button of your virtual machine window (at the top right of the window, just like you would close any other window on your system) (or press the Host key together with "Q"), VirtualBox asks you whether you want to "save" or "power off" the VM.

The difference between these three options is crucial. They mean:

Save the machine state: With this option, VirtualBox "freezes" the virtual machine by completely saving its state to your local disk. When you later resume the VM (by again clicking the "Start" button in the VirtualBox main window), you will find that the VM continues exactly where it was left off. All your programs will still be open, and your computer resumes operation.

Saving the state of a virtual machine is thus in some ways similar to suspending a laptop computer (e.g. by closing its lid).

Send the shutdown signal. This will send an ACPI shutdown signal to the virtual machine, which has the same effect as if you had pressed the power button on a real computer. So long as a fairly modern operating system is installed and running in the VM, this should trigger a proper shutdown mechanism in the VM.

Power off the machine: With this option, VirtualBox also stops running the virtual machine, but without saving its state.

This is equivalent to pulling the power plug on a real computer without shutting it down properly. If you start the machine again after powering it off, your operating system will have to reboot completely and may begin a lengthy check of its (virtual) system disks.

As a result, this should not normally be done, since it can potentially cause data loss or an inconsistent state of the guest system on disk.

The "Discard" button in the main VirtualBox window discards a virtual machine's saved state. This has the same effect as powering it off, and the same warnings apply.


Instructions for using the KVM image

Install KVM

  • There are KVM is apart of the Linux Kernal, check with your distribution for installation methods.

For Ubuntu/Debian

  • Run the following to check if your processor supports KVM (if nothing is printed you can not use KVM)
$ egrep '(vmx|svm)' --color=always /proc/cpuinfo
  • Install KVM
$ sudo aptitude install kvm 

Download ICA-Atom kvm

  • Download ICA-Atom kvm: ica-atom-kvm-2009-12-09.tgz (md5)
  • Unzip the ICA-atom-kvm file. This should result in the following two files appearing in an ubuntu-kvm folder:
    • disk0.qcow2
    • run.sh < this file can be modified to preserve settings

Run ICA-Atom in KVM

  • change directory to the location of KVM image,
$ cd /path/to/image/ubuntu-kvm/
  • start kvm ica-atom instance (-m sets the memory in MB in this case 256MB, -redir tells the host machine to direct port 8000 to 80 on the guest instance)
$ sudo kvm -m 256 -redir tcp:8000::80 disk0.qcow2
  • wait until the machine is completely booted (you will see Ubuntu shell login)