Overview

In Wakame-vdc it is possible to take a running instance and turn it into a new machine image. We simply call this process backup.

This is a quick and easy way to create new machine images. For example, you could start up an instance, install a web server in it and then back it up. Now you'll have a machine image with a web server installed and you'll immediately be able to start a any amount of web server instances.

Requirements

You of course need a working Wakame-vdc installation. You can use either the VirtualBox demo image or create your own environment using the installation guide.

You need to tell Wakame-vdc which backup storage to use when backing up instances. Both the VirtualBox image and the installation guide will set that up but just in case, here it is again.

Figure out which backup storage you want to use with vdc-manage.

/opt/axsh/wakame-vdc/dcmgr/bin/vdc-manage backupstorage show

On an environment installed according to the installation guide, it will have this output

UUID            Storage Type         Base URI
bkst-local      local                file:///var/lib/wakame-vdc/images/

There's only one backup storage defined and its UUID is bkst-local. We need to make sure this is set in dcmgr.conf.

grep backup_storage_id /etc/wakame-vdc/dcmgr.conf

That command should have an output similar to this.

backup_storage_id 'bkst-local'

If it does not show the UUID of the backup storage you want to use, open the file with a text editor and change that line.

Usage

You need to have started an instance in order to back it up. If you don't know how to start an instance, you can find the instructions in the basic usage guide.

Before you can create a backup, you have to power off your instance. On the Instances page of the GUI, tick the checkbox next to your instance and click on Select an Action.

screenshot

Next, click on Power Off.

Remark

Make sure to click on Power Off and not Stop. Stop will delete the instance while keeping its ip address and memory etc. reserved. When starting it again afterwards, it will run a new instance in its place.

Power Off means that the instance's OS will get the shutdown signal and the instance will gracefully shut down. It is equivalent to shutting down a physical server. You will be able to Power On the same instance again later.

screenshot

Your instance should now have the state of halting. Wait a few moments and click on the Refresh button. Repeat until your instance has reached the state of halted.

screenshot

Now tick the checkbox next to your instance again and click Backup.

screenshot

The Create Instance Backup dialog will pop up. Fill in the Backup Display Name field. This will become the name of your new machine image. Click on Backup when you've filled it in.

screenshot

You'll be taken back to the instances page. Click on Machine Images in the menu on the left.

screenshot

You should see your new machine image with the state of creating. Wait a few moments and click on Refresh. Eventually your image will reach the state of available.

screenshot

Once your image has reached the state of available, you are done. You are now free to Power On the original instance again and/or start new instances of this machine image.

screenshot