Quick-start guide

This guide focuses on a linux environment. Some of the Deltacloud developers are running recent versions of Fedora. However, you should be able to install Deltacloud on any OS that supports Ruby. If you are having any problems with installation, please let us know, we'd love to hear from you!

Running the Deltacloud server

Start the server by typing deltacloudd -i driver_id.

The driver_id is the name of the cloud provider that you have an account with, for example deltacloudd -i ec2.

If you don't yet have an account with a cloud provider, you can still try the Deltacloud mock driver:

deltacloudd -i mock

This will start the Deltacloud server on your local machine with the mock driver, accepting connections on port 3001 (default). From version 0.4.0 of Deltacloud, you can use the '-l' flag to see all available driver_ids that can be used with the deltacloudd executable:

$ deltacloudd -l

Available drivers:
* condor
* vsphere
* opennebula
* eucalyptus
* rhevm
* sbc
* azure
* gogrid
* mock
* rackspace
* rimuhosting
* terremark
* ec2

Deltacloud HTML interface

After you start the server, you are ready to use the Deltacloud HTML interface.

Open the address http://localhost:3001/api in your web browser:

To display the XML output from the server in the browser, append format=xml to each URL. On Webkit based browsers like Safari, you might need to instruct the server explicitly to return HTML. Do this by appending format=html to each URL.

Your browser will prompt you for credentials when you invoke an operation that requires authentication.

The '-h' flag will list all available options for deltacloudd. For example, to start the Deltacloud server with the Rackspace driver on port 10000 you can use:

$ deltacloudd -i rackspace -p 10000

If you want to install the server on another machine and make Deltacloud available on your local network, you need to bind the Deltacloud server to an address other than 'localhost' (default). To start the server use the IP address of a machine where you installed and started Deltacloud. For instance:

$ deltacloudd -i ec2 -p 5000 -r 192.168.10.200

This will make the Deltacloud server available at the address http://192.168.10.200:5000/api. Instead of IP address you can also use the hostname to start the server on another machine.

Using CIMI

To use CIMI, first, go to the direcotry ~/deltacloud/server/bin and start the Deltacloud server in the background:

./deltacloudd -i mock --cimi &

Then go to the directory ~/deltacloud/clients/cimi and start the CIMI client server in the background:

bin/start -u http://localhost:3001/cimi -r <your_server_host_name> &

Use the -r option to make your client accessible from other machines different from the machine on which you are running both servers.

If there are some problems when you start up the servers, you may have missing dependencies. Check the RubyGems list with the list above and make sure you don't have anything missing. If there are no problems with starting the servers, access the application using your browser by following URL:

http://<your_server_host_name>:4001/cimi

The browser will ask for credentials. To log in use mockuser and mockpassword as user ID and password.

Use Deltacloud