site/output/run-deltacloud-server.html - deltacloud - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <title>Run the Deltacloud server</title>
     <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
     <!--[if lt IE 9]>
     <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]-->

     <!-- Le JavaScript -->
     <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
     <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
     <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
     <script src="/assets/js/application.js" type="text/javascript"></script>
     <script src="/assets/js/bootstrap-transition.js"></script>
     <script src="/assets/js/bootstrap-alert.js"></script>
     <script src="/assets/js/bootstrap-modal.js"></script>
     <script src="/assets/js/bootstrap-scrollspy.js"></script>
     <script src="/assets/js/bootstrap-tab.js"></script>
     <script src="/assets/js/bootstrap-tooltip.js"></script>
     <script src="/assets/js/bootstrap-popover.js"></script>
     <script src="/assets/js/bootstrap-button.js"></script>
     <script src="/assets/js/bootstrap-collapse.js"></script>
     <script src="/assets/js/bootstrap-carousel.js"></script>
     <script src="/assets/js/bootstrap-typeahead.js"></script>

     <!-- Le styles -->
     <link href="/assets/css/bootstrap.css" rel="stylesheet">
     <link href="/assets/css/application.css" rel="stylesheet">
     <link rel="shortcut icon" href="/assets/img/favicon.ico">
   </head>

   <body><div style="background: red"><h1>2015/07/20 - Apache Deltacloud has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/">Attic</a>. </h2></div>

     <div class="navbar navbar-fixed-top">
       <div class="navbar-inner">
         <div class="container">
           <a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
             alt="Deltacloud API"/></a>
           <ul class="nav top-nav">
   <li><a href="/">Home</a></li>
   <li class="dropdown">
     <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
     <ul class="dropdown-menu">
       <li><a href="/about.html">What is Deltacloud?</a></li>
       <li><a href="/drivers.html#drivers">Supported Providers</a></li>
     </ul>
   </li>
   <li><a href="/download.html">Download</a></li>
   <li class="dropdown">
     <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
     <ul class="dropdown-menu">
       <li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
       <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
     </ul>
   </li>
   <li class="dropdown">
     <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
     <ul class="dropdown-menu">
       <li><a href="/usage.html#usingapi">Using API</a></li>
       <li><a href="/usage.html#clients">Client Libraries</a></li>
       <li><a href="/command-tools.html">Command Line Tools</a></li>
     </ul>
   </li>
   <li class="dropdown">
     <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
     <ul class="dropdown-menu">
       <li><a href="/getting-sources.html">Getting Sources</a></li>
       <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
     </ul>
   </li>
   <li class="dropdown">
     <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
     <ul class="dropdown-menu">
       <li><a href="/rest-api.html">Deltacloud REST API</a></li>
       <li><a href="/curl-examples.html">Deltacloud API cURL examples</a></li>
       <li><a href="/drivers.html">Drivers API</a></li>
     </ul>
   </li>
   <li class="dropdown">
     <a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
     <ul class="dropdown-menu">
       <li><a href="/cimi-rest.html">CIMI REST API</a></li>
       <li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
     </ul>
   </li>
   <li><a href="/contact.html">Contact</a></li>
 </ul>

         </div>
       </div>

     </div>

     <div class="container content">

       <p><br></p>
 <h3> Quick-start guide</h3>
 <p>This guide focuses on a linux environment. Some of the Deltacloud developers are running recent versions of <a href="http://fedoraproject.org/">Fedora</a>. However, you should be able to install Deltacloud on any OS that supports Ruby. If you are having any problems with installation, please <a href="contact.html">let us know</a>, we'd love to hear from you!</p>

 <h3>Running the Deltacloud server</h3>
 <p>Start the server by typing <strong>deltacloudd -i driver_id</strong>.</p>
 <p>The <strong>driver_id</strong> is the name of the cloud provider that you have an account with, for example <code>deltacloudd -i ec2</code>.</p>
 <p>If you don't yet have an account with a cloud provider, you can still try the Deltacloud mock driver:</p>
 <pre>deltacloudd -i mock</pre>
 <p>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 <strong>driver_ids</strong> that can be used with the <strong>deltacloudd</strong> executable:</p>
 <pre>
 $ deltacloudd -l

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

 <h3>Deltacloud HTML interface</h3>
 <p>After you start the server, you are ready to use the Deltacloud HTML interface.</p>
 <p>Open the address <strong>http://localhost:3001/api</strong> in your web browser:</p>

 <p>To display the XML output from the server in the browser, append <strong>format=xml</strong> to each URL. On Webkit based browsers like Safari, you might need to instruct the server explicitly to <a href="http://www.gethifi.com/blog/webkit-team-admits-accept-header-error">return HTML</a>. Do this by appending <strong>format=html</strong> to each URL.</p>

 <p>Your browser will prompt you for <a href="drivers.html#credentials">credentials</a> when you invoke an operation that requires authentication.</p>

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

 <pre>$ deltacloudd -i rackspace -p 10000</pre>

 <p>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:</p>

 <pre>$ deltacloudd -i ec2 -p 5000 -r 192.168.10.200</pre>

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

 <h3>Using CIMI</h3>

 <p>
 To use <a href="http://dmtf.org/standards/cloud">CIMI</a>, first, go to the direcotry <strong>~/deltacloud/server/bin</strong> and start the Deltacloud server in the background:
 </p>

 <pre>
 ./deltacloudd -i mock --cimi &amp;
 </pre>

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

 <pre>
 bin/start -u http://localhost:3001/cimi -r &lt;your_server_host_name&gt; &amp;
 </pre>

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

 <p>
 If there are some problems when you start up the servers, you may have missing dependencies. Check the <a href="install-deltacloud.html#gem-list">RubyGems list</a> 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:
 </p>

 <pre>
 http://&lt;your_server_host_name&gt;:4001/cimi
 </pre>

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

 <p><a class="btn btn-inverse btn-large" style="float: right" href="usage.html">Use Deltacloud</a></p>

 <p><br></p>


       <footer class="footer">
         <p class="pull-right"><span class='icon-circle-arrow-up'>&nbsp;</span><a href="#">Back to top</a></p>
         <div class='row'>
           <div class='span3'>
             <img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
           </div>
           <div class='span9'>
             <strong>Apache Deltacloud</strong> is a top-level project at the <a
               href="http://www.apache.org">Apache Software Foundation</a>,
             having graduated from the ASF Incubator in October
             2011. Through a collaborative and meritocratic development process, Apache
             projects deliver enterprise-grade, freely available software products that
             attract large communities of users.
           </div>
         </div>
       </footer>

     </div> <!-- /container -->

 <!-- Piwik -->
 <script type="text/javascript">
 var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/");
 document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
 </script><script type="text/javascript">
 try {
 var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
 piwikTracker.trackPageView();
 piwikTracker.enableLinkTracking();
 } catch( err ) {}
 </script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript>
 <!-- End Piwik Tracking Code -->

   </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>Run the Deltacloud server</title>
	<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
	<!--[if lt IE 9]>
	<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->

	<!-- Le JavaScript -->
	<script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
	<script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
	<script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
	<script src="/assets/js/application.js" type="text/javascript"></script>
	<script src="/assets/js/bootstrap-transition.js"></script>
	<script src="/assets/js/bootstrap-alert.js"></script>
	<script src="/assets/js/bootstrap-modal.js"></script>
	<script src="/assets/js/bootstrap-scrollspy.js"></script>
	<script src="/assets/js/bootstrap-tab.js"></script>
	<script src="/assets/js/bootstrap-tooltip.js"></script>
	<script src="/assets/js/bootstrap-popover.js"></script>
	<script src="/assets/js/bootstrap-button.js"></script>
	<script src="/assets/js/bootstrap-collapse.js"></script>
	<script src="/assets/js/bootstrap-carousel.js"></script>
	<script src="/assets/js/bootstrap-typeahead.js"></script>

	<!-- Le styles -->
	<link href="/assets/css/bootstrap.css" rel="stylesheet">
	<link href="/assets/css/application.css" rel="stylesheet">
	<link rel="shortcut icon" href="/assets/img/favicon.ico">
	</head>

	<body><div style="background: red"><h1>2015/07/20 - Apache Deltacloud has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/">Attic</a>. </h2></div>

	<div class="navbar navbar-fixed-top">
	<div class="navbar-inner">
	<div class="container">
	<a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
	alt="Deltacloud API"/></a>
	<ul class="nav top-nav">
	<li><a href="/">Home</a></li>
	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/about.html">What is Deltacloud?</a></li>
	<li><a href="/drivers.html#drivers">Supported Providers</a></li>
	</ul>
	</li>
	<li><a href="/download.html">Download</a></li>
	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
	<li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
	</ul>
	</li>
	<li class="dropdown">
	<a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/usage.html#usingapi">Using API</a></li>
	<li><a href="/usage.html#clients">Client Libraries</a></li>
	<li><a href="/command-tools.html">Command Line Tools</a></li>
	</ul>
	</li>
	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/getting-sources.html">Getting Sources</a></li>
	<li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
	</ul>
	</li>
	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/rest-api.html">Deltacloud REST API</a></li>
	<li><a href="/curl-examples.html">Deltacloud API cURL examples</a></li>
	<li><a href="/drivers.html">Drivers API</a></li>
	</ul>
	</li>
	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/cimi-rest.html">CIMI REST API</a></li>
	<li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
	</ul>
	</li>
	<li><a href="/contact.html">Contact</a></li>
	</ul>

	</div>
	</div>

	</div>

	<div class="container content">

	<p><br></p>
	<h3> Quick-start guide</h3>
	<p>This guide focuses on a linux environment. Some of the Deltacloud developers are running recent versions of <a href="http://fedoraproject.org/">Fedora</a>. However, you should be able to install Deltacloud on any OS that supports Ruby. If you are having any problems with installation, please <a href="contact.html">let us know</a>, we'd love to hear from you!</p>

	<h3>Running the Deltacloud server</h3>
	<p>Start the server by typing <strong>deltacloudd -i driver_id</strong>.</p>
	<p>The <strong>driver_id</strong> is the name of the cloud provider that you have an account with, for example <code>deltacloudd -i ec2</code>.</p>
	<p>If you don't yet have an account with a cloud provider, you can still try the Deltacloud mock driver:</p>
	<pre>deltacloudd -i mock</pre>
	<p>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 <strong>driver_ids</strong> that can be used with the <strong>deltacloudd</strong> executable:</p>
	<pre>
	$ deltacloudd -l

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

	<h3>Deltacloud HTML interface</h3>
	<p>After you start the server, you are ready to use the Deltacloud HTML interface.</p>
	<p>Open the address <strong>http://localhost:3001/api</strong> in your web browser:</p>

	<p>To display the XML output from the server in the browser, append <strong>format=xml</strong> to each URL. On Webkit based browsers like Safari, you might need to instruct the server explicitly to <a href="http://www.gethifi.com/blog/webkit-team-admits-accept-header-error">return HTML</a>. Do this by appending <strong>format=html</strong> to each URL.</p>

	<p>Your browser will prompt you for <a href="drivers.html#credentials">credentials</a> when you invoke an operation that requires authentication.</p>

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

	<pre>$ deltacloudd -i rackspace -p 10000</pre>

	<p>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:</p>

	<pre>$ deltacloudd -i ec2 -p 5000 -r 192.168.10.200</pre>

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

	<h3>Using CIMI</h3>

	<p>
	To use <a href="http://dmtf.org/standards/cloud">CIMI</a>, first, go to the direcotry <strong>~/deltacloud/server/bin</strong> and start the Deltacloud server in the background:
	</p>

	<pre>
	./deltacloudd -i mock --cimi &
	</pre>

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

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

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

	<p>
	If there are some problems when you start up the servers, you may have missing dependencies. Check the <a href="install-deltacloud.html#gem-list">RubyGems list</a> 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:
	</p>

	<pre>
	http://<your_server_host_name>:4001/cimi
	</pre>

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

	<p><a class="btn btn-inverse btn-large" style="float: right" href="usage.html">Use Deltacloud</a></p>

	<p><br></p>


	<footer class="footer">
	<p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p>
	<div class='row'>
	<div class='span3'>
	<img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
	</div>
	<div class='span9'>
	<strong>Apache Deltacloud</strong> is a top-level project at the <a
	href="http://www.apache.org">Apache Software Foundation</a>,
	having graduated from the ASF Incubator in October
	2011. Through a collaborative and meritocratic development process, Apache
	projects deliver enterprise-grade, freely available software products that
	attract large communities of users.
	</div>
	</div>
	</footer>

	</div> <!-- /container -->

	<!-- Piwik -->
	<script type="text/javascript">
	var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/");
	document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
	</script><script type="text/javascript">
	try {
	var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
	piwikTracker.trackPageView();
	piwikTracker.enableLinkTracking();
	} catch( err ) {}
	</script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript>
	<!-- End Piwik Tracking Code -->

	</body>
	</html>