Skip to content

C
CONF
Commit 5d404579 authored by Spiros Koulouzis's avatar Spiros Koulouzis
Browse files
Options

refactor API

parent cdc919e2
Expand all Show whitespace changes
Inline Side-by-side
Showing with 4701 additions and 1453 deletions
.gitignore
View file @ 5d404579
......@@ -8,3 +8,4 @@
/drip-planner2provisioner/target/
/drip-component_example/target/
/deleteme/target/
/drip-api/nbproject/
\ No newline at end of file
docs/apidocs/data.html
View file @ 5d404579
......@@ -79,35 +79,34 @@
<tr class="clickable-row" data-href="json_CloudCredentials.html">
<td> <span class="datatype-name">CloudCredentials</span>
</td>
<td> <span class="datatype-description">This class represents the cloud credentials for a cloud. They are used by the
provisoner to request for resources.</span>
<td> <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ClusterCredentials.html">
<td> <span class="datatype-name">ClusterCredentials</span>
<tr class="clickable-row" data-href="json_DeployRequest.html">
<td> <span class="datatype-name">DeployRequest</span>
</td>
<td> <span class="datatype-description">This class represents the cluster credentials for a cloud. They can used to
login to the cluster created by the deployer</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_DeployParameter.html">
<td> <span class="datatype-name">DeployParameter</span>
<tr class="clickable-row" data-href="json_DeployResponse.html">
<td> <span class="datatype-name">DeployResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_KeyValueHolder.html">
<td> <span class="datatype-name">KeyValueHolder</span>
<tr class="clickable-row" data-href="json_Key.html">
<td> <span class="datatype-name">Key</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LoginKey.html">
<td> <span class="datatype-name">LoginKey</span>
<tr class="clickable-row" data-href="json_KeyValueHolder.html">
<td> <span class="datatype-name">KeyValueHolder</span>
</td>
<td> <span class="datatype-description">This class represents a login key. This key can be used to either login to a
VM created by the provisiner or by the VM to allow the user to login to the
VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_OwnedObject.html">
......@@ -116,14 +115,20 @@ VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Plan.html">
<td> <span class="datatype-name">Plan</span>
<tr class="clickable-row" data-href="json_PlanResponse.html">
<td> <span class="datatype-name">PlanResponse</span>
</td>
<td> <span class="datatype-description">This class represents a plan generated by the planner.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ProvisionInfo.html">
<td> <span class="datatype-name">ProvisionInfo</span>
<tr class="clickable-row" data-href="json_ProvisionRequest.html">
<td> <span class="datatype-name">ProvisionRequest</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ProvisionResponse.html">
<td> <span class="datatype-name">ProvisionResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
......@@ -235,41 +240,40 @@ VMs from the machine the keys correspond to.</span>
<tr class="clickable-row" data-href="xml_ns0_cloudCredentials.html">
<td> <span class="datatype-name">cloudCredentials</span>
</td>
<td> <span class="datatype-description">This class represents the cloud credentials for a cloud. They are used by the
provisoner to request for resources.</span>
<td> <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_clusterCredentials.html">
<td> <span class="datatype-name">clusterCredentials</span>
</td>
<td> <span class="datatype-description">This class represents the cluster credentials for a cloud. They can used to
login to the cluster created by the deployer</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
<td> <span class="datatype-name">deployParameter</span>
<tr class="clickable-row" data-href="xml_ns0_deployRequest.html">
<td> <span class="datatype-name">deployRequest</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
<td> <span class="datatype-name">keyValueHolder</span>
<tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
<td> <span class="datatype-name">deployResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_loginKey.html">
<td> <span class="datatype-name">loginKey</span>
<tr class="clickable-row" data-href="xml_ns0_key.html">
<td> <span class="datatype-name">key</span>
</td>
<td> <span class="datatype-description">This class represents a login key. This key can be used to either login to a
VM created by the provisiner or by the VM to allow the user to login to the
VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_type.html">
<td> <span class="datatype-name">type</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
<td> <span class="datatype-name">keyValueHolder</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
......@@ -278,8 +282,20 @@ VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_provisionInfo.html">
<td> <span class="datatype-name">provisionInfo</span>
<tr class="clickable-row" data-href="xml_ns0_planResponse.html">
<td> <span class="datatype-name">planResponse</span>
</td>
<td> <span class="datatype-description">This class represents a plan generated by the planner.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_provisionRequest.html">
<td> <span class="datatype-name">provisionRequest</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_provisionResponse.html">
<td> <span class="datatype-name">provisionResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
......
docs/apidocs/downloads.html
View file @ 5d404579
......@@ -72,7 +72,7 @@
<h1 class="page-header">Files and Libraries</h1>
<h3 id="artifact_gwt_json_overlay">GWT JSON Overlay</h3>
<p class="lead">Created March 24, 2017</p>
<p class="lead">Created March 28, 2017</p>
<p> <p>
The <a href="http://code.google.com/webtoolkit/">Google Web Toolkit</a> JSON Overlay library provides the JSON Overlays that
can be used to access the Web service API for this application.
......@@ -91,13 +91,13 @@
<tbody data-link="row" class="rowlink">
<tr class="clickable-row" data-href="drip-api-gwt-json-overlay.jar">
<td><span class="downloadfile-name">drip-api-gwt-json-overlay.jar</span></td>
<td><span class="downloadfile-size">7.99K</span></td>
<td><span class="downloadfile-size">8.25K</span></td>
<td><span class="downloadfile-description">The sources for the GWT JSON overlay.</span></td>
</tr>
</tbody>
</table>
<h3 id="artifact_java_json_client_library">Java JSON Client Library</h3>
<p class="lead">Created March 24, 2017</p>
<p class="lead">Created March 28, 2017</p>
<p><p>
The Java client-side library is used to provide the set of Java objects that can be serialized
to/from JSON using <a href="http://jackson.codehaus.org/">Jackson</a>. This is useful for accessing the
......@@ -116,18 +116,18 @@
<tbody data-link="row" class="rowlink">
<tr class="clickable-row" data-href="drip-api-json-client.jar">
<td><span class="downloadfile-name">drip-api-json-client.jar</span></td>
<td><span class="downloadfile-size">10.42K</span></td>
<td><span class="downloadfile-size">10.75K</span></td>
<td><span class="downloadfile-description">The binaries for the Java JSON client library.</span></td>
</tr>
<tr class="clickable-row" data-href="drip-api-json-client-json-sources.jar">
<td><span class="downloadfile-name">drip-api-json-client-json-sources.jar</span></td>
<td><span class="downloadfile-size">8.26K</span></td>
<td><span class="downloadfile-size">8.50K</span></td>
<td><span class="downloadfile-description">The sources for the Java JSON client library.</span></td>
</tr>
</tbody>
</table>
<h3 id="artifact_java_xml_client_library">Java XML Client Library</h3>
<p class="lead">Created March 24, 2017</p>
<p class="lead">Created March 28, 2017</p>
<p><p>
The Java client-side library is used to access the Web service API for this application using Java.
</p>
......@@ -144,18 +144,18 @@
<tbody data-link="row" class="rowlink">
<tr class="clickable-row" data-href="drip-api-xml-client.jar">
<td><span class="downloadfile-name">drip-api-xml-client.jar</span></td>
<td><span class="downloadfile-size">17.81K</span></td>
<td><span class="downloadfile-size">18.93K</span></td>
<td><span class="downloadfile-description">The binaries for the Java XML client library.</span></td>
</tr>
<tr class="clickable-row" data-href="drip-api-xml-client-xml-sources.jar">
<td><span class="downloadfile-name">drip-api-xml-client-xml-sources.jar</span></td>
<td><span class="downloadfile-size">16.15K</span></td>
<td><span class="downloadfile-size">17.11K</span></td>
<td><span class="downloadfile-description">The sources for the Java XML client library.</span></td>
</tr>
</tbody>
</table>
<h3 id="artifact_js_client_library">JavaScript Client Library</h3>
<p class="lead">Created March 24, 2017</p>
<p class="lead">Created March 28, 2017</p>
<p><p>
The JavaScript client-side library defines classes that can be (de)serialized to/from JSON.
This is useful for accessing the resources that are published by this application, but only
......@@ -184,13 +184,13 @@
<tbody data-link="row" class="rowlink">
<tr class="clickable-row" data-href="drip-api-js.zip">
<td><span class="downloadfile-name">drip-api-js.zip</span></td>
<td><span class="downloadfile-size">3.34K</span></td>
<td><span class="downloadfile-size">3.26K</span></td>
<td><span class="downloadfile-description">&nbsp;</span></td>
</tr>
</tbody>
</table>
<h3 id="artifact_php_json_client_library">PHP JSON Client Library</h3>
<p class="lead">Created March 24, 2017</p>
<p class="lead">Created March 28, 2017</p>
<p><p>
The PHP JSON client-side library defines the PHP classes that can be (de)serialized to/from JSON.
This is useful for accessing the resources that are published by this application, but only
......@@ -213,13 +213,13 @@
<tbody data-link="row" class="rowlink">
<tr class="clickable-row" data-href="drip-api-php.zip">
<td><span class="downloadfile-name">drip-api-php.zip</span></td>
<td><span class="downloadfile-size">3.51K</span></td>
<td><span class="downloadfile-size">3.40K</span></td>
<td><span class="downloadfile-description">&nbsp;</span></td>
</tr>
</tbody>
</table>
<h3 id="artifact_php_xml_client_library">PHP XML Client Library</h3>
<p class="lead">Created March 24, 2017</p>
<p class="lead">Created March 28, 2017</p>
<p><p>
The PHP client-side library defines the PHP classes that can be (de)serialized to/from XML.
This is useful for accessing the resources that are published by this application, but only
......@@ -245,13 +245,13 @@
<tbody data-link="row" class="rowlink">
<tr class="clickable-row" data-href="drip-api-php.zip">
<td><span class="downloadfile-name">drip-api-php.zip</span></td>
<td><span class="downloadfile-size">6.95K</span></td>
<td><span class="downloadfile-size">7.16K</span></td>
<td><span class="downloadfile-description">&nbsp;</span></td>
</tr>
</tbody>
</table>
<h3 id="artifact_ruby_json_client_library">Ruby JSON Client Library</h3>
<p class="lead">Created March 24, 2017</p>
<p class="lead">Created March 28, 2017</p>
<p><p>
The Ruby JSON client-side library defines the Ruby classes that can be (de)serialized to/from JSON.
This is useful for accessing the REST endpoints that are published by this application, but only
......@@ -276,7 +276,7 @@
<tbody data-link="row" class="rowlink">
<tr class="clickable-row" data-href="drip-api.rb">
<td><span class="downloadfile-name">drip-api.rb</span></td>
<td><span class="downloadfile-size">44.56K</span></td>
<td><span class="downloadfile-size">42.59K</span></td>
<td><span class="downloadfile-description">&nbsp;</span></td>
</tr>
</tbody>
......
docs/apidocs/drip-api.rb
View file @ 5d404579
This diff is collapsed.
docs/apidocs/index.html
View file @ 5d404579
This diff is collapsed.
docs/apidocs/json_CloudCredentials.html
View file @ 5d404579
......@@ -64,8 +64,8 @@
<h1 class="page-header">CloudCredentials <small>Data Type</small></h1>
<p>This class represents the cloud credentials for a cloud. They are used by the
provisoner to request for resources.</p>
<p>This class represents the cloud credentials. They are used by the provisoner
to request for resources.</p>
<dl class="dl-horizontal">
</dl>
......@@ -81,57 +81,48 @@ provisoner to request for resources.</p>
</thead>
<tbody>
<tr>
<td> <span class="property-name">id</span>
<td> <span class="property-name">secretKey</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">It is the secret key / password for accessing a cloud provider.</span>
</td>
</tr>
<tr>
<td> <span class="property-name">key</span>
<td> <span class="property-name">id</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The key for the cloud provider.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">keyIdAlias</span>
<td> <span class="property-name">cloudProviderName</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The key id for the cloud provider or the key alias.</span>
</td>
</tr>
<tr>
<td> <span class="property-name">loginKeys</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_LoginKey.html">LoginKey</a>
</span>
</td>
<td> <span class="property-description">The login keys</span>
<td> <span class="property-description">The name of the cloud provider</span>
</td>
</tr>
<tr>
<td> <span class="property-name">cloudProviderName</span>
<td> <span class="property-name">accessKeyId</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The name of the cloud provider</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">keypass</span>
<td> <span class="property-name">keyIDs</span>
</td>
<td> <span class="datatype-reference">string
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description">The password for key stores</span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......@@ -151,32 +142,11 @@ provisoner to request for resources.</p>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;key&quot; : &quot;6J7uo99ifrff45126Gsy5vgb3bmrtwY6hBxtYt9y&quot;,
&quot;keyIdAlias&quot; : &quot;AKIAITY3K5ZUQ6M7YBSQ&quot;,
&quot;loginKeys&quot; : [ {
&quot;name&quot; : &quot;id_dsa.pub&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;type&quot; : &quot;PRIVATE&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : &quot;domain_name:Virginia&quot;,
&quot;property2&quot; : &quot;domain_name:Virginia&quot;
},
&quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;,
&quot;owner&quot; : &quot;...&quot;
}, {
&quot;name&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;type&quot; : &quot;PUBLIC&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
},
&quot;key&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
} ],
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;keypass&quot; : &quot;123passwd&quot;,
&quot;accessKeyId&quot; : &quot;...&quot;,
&quot;keyIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;...&quot;
}</pre>
......
docs/apidocs/json_DeployRequest.html 0 → 100644
View file @ 5d404579
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>drip-api: DeployRequest</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/style.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: DeployRequest</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
<li><a href="downloads.html">Files and Libraries</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
<li class="dropdown"><a href="json_DeployRequest.html">DeployRequest</a></li>
</ol>
<h1 class="page-header">DeployRequest <small>Data Type</small></h1>
<p></p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_DeployResponse.html">DeployResponse</a></dd>
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> <span class="property-name">provisionID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">clusterType</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">configurationID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;provisionID&quot; : &quot;...&quot;,
&quot;clusterType&quot; : &quot;...&quot;,
&quot;configurationID&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
}</pre>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>
docs/apidocs/json_DeployResponse.html 0 → 100644
View file @ 5d404579
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>drip-api: DeployResponse</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/style.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: DeployResponse</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
<li><a href="downloads.html">Files and Libraries</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
<li class="dropdown"><a href="json_DeployResponse.html">DeployResponse</a></li>
</ol>
<h1 class="page-header">DeployResponse <small>Data Type</small></h1>
<p></p>
<dl class="dl-horizontal">
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> <span class="property-name">key</span>
</td>
<td> <span class="datatype-reference"><a href="json_Key.html">Key</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">id</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_DeployRequest.html">DeployRequest</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">provisionID</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">clusterType</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">configurationID</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;key&quot; : {
&quot;name&quot; : &quot;id_dsa.pub&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;type&quot; : &quot;PRIVATE&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : &quot;domain_name:Virginia&quot;,
&quot;property2&quot; : &quot;domain_name:Virginia&quot;
},
&quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;,
&quot;owner&quot; : &quot;...&quot;
},
&quot;id&quot; : &quot;...&quot;,
&quot;provisionID&quot; : &quot;...&quot;,
&quot;clusterType&quot; : &quot;...&quot;,
&quot;configurationID&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
}</pre>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>
docs/apidocs/json_Key.html 0 → 100644
View file @ 5d404579
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>drip-api: Key</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/style.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: Key</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
<li><a href="downloads.html">Files and Libraries</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
<li class="dropdown"><a href="json_Key.html">Key</a></li>
</ol>
<h1 class="page-header">Key <small>Data Type</small></h1>
<p>This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</p>
<dl class="dl-horizontal">
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> <span class="property-name">name</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The name of the key.</span>
</td>
</tr>
<tr>
<td> <span class="property-name">id</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">type</span>
</td>
<td> <span class="datatype-reference"><a href="json_Type.html">Type</a>
</span>
</td>
<td> <span class="property-description">The type of key</span>
</td>
</tr>
<tr>
<td> <span class="property-name">attributes</span>
</td>
<td> <span class="datatype-reference">map of string
</span>
</td>
<td> <span class="property-description">A general use key,value. In the case of the cloud credentials it's used
to specify the domain name for ec2</span>
</td>
</tr>
<tr>
<td> <span class="property-name">key</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The contents of the key.</span>
</td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;name&quot; : &quot;id_dsa.pub&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;type&quot; : &quot;PRIVATE&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : &quot;domain_name:Virginia&quot;,
&quot;property2&quot; : &quot;domain_name:Virginia&quot;
},
&quot;key&quot; : &quot;-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n&quot;,
&quot;owner&quot; : &quot;...&quot;
}</pre>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>
docs/apidocs/json_KeyValueHolder.html
View file @ 5d404579
......@@ -68,7 +68,7 @@
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_Plan.html">Plan</a>, <a href="json_ProvisionInfo.html">ProvisionInfo</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a></dd>
<dd><a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a>, <a href="json_PlanResponse.html">PlanResponse</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a></dd>
</dl>
<table class="table datatype-properties">
......
docs/apidocs/json_OwnedObject.html
View file @ 5d404579
......@@ -68,7 +68,7 @@
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_LoginKey.html">LoginKey</a>, <a href="json_Script.html">Script</a>, <a href="json_Plan.html">Plan</a>, <a href="json_ClusterCredentials.html">ClusterCredentials</a>, <a href="json_ProvisionInfo.html">ProvisionInfo</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a>, <a href="json_KeyValueHolder.html">KeyValueHolder</a>, <a href="json_CloudCredentials.html">CloudCredentials</a></dd>
<dd><a href="json_Script.html">Script</a>, <a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a>, <a href="json_DeployRequest.html">DeployRequest</a>, <a href="json_KeyValueHolder.html">KeyValueHolder</a>, <a href="json_PlanResponse.html">PlanResponse</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a>, <a href="json_DeployResponse.html">DeployResponse</a>, <a href="json_Key.html">Key</a>, <a href="json_CloudCredentials.html">CloudCredentials</a></dd>
</dl>
<table class="table datatype-properties">
......
docs/apidocs/json_PlanResponse.html 0 → 100644
View file @ 5d404579
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>drip-api: PlanResponse</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/style.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: PlanResponse</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
<li><a href="downloads.html">Files and Libraries</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
<li class="dropdown"><a href="json_PlanResponse.html">PlanResponse</a></li>
</ol>
<h1 class="page-header">PlanResponse <small>Data Type</small></h1>
<p>This class represents a plan generated by the planner.</p>
<dl class="dl-horizontal">
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> <span class="property-name">name</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">toscaID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">level</span>
</td>
<td> <span class="datatype-reference">number
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">loweLevelPlanIDs</span>
</td>
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_KeyValueHolder.html">KeyValueHolder</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">keyValue</span></td>
<td><span class="datatype-reference">map of object
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">id</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;name&quot; : &quot;...&quot;,
&quot;toscaID&quot; : &quot;...&quot;,
&quot;level&quot; : 12345,
&quot;loweLevelPlanIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;keyValue&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
}</pre>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>
docs/apidocs/json_ProvisionRequest.html 0 → 100644
View file @ 5d404579
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>drip-api: ProvisionRequest</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/style.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: ProvisionRequest</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
<li><a href="downloads.html">Files and Libraries</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
<li class="dropdown"><a href="json_ProvisionRequest.html">ProvisionRequest</a></li>
</ol>
<h1 class="page-header">ProvisionRequest <small>Data Type</small></h1>
<p></p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_ProvisionResponse.html">ProvisionResponse</a></dd>
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> <span class="property-name">cloudCredentialsID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">planID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">scriptID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">userKeyID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_KeyValueHolder.html">KeyValueHolder</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">keyValue</span></td>
<td><span class="datatype-reference">map of object
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">id</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;cloudCredentialsID&quot; : &quot;...&quot;,
&quot;planID&quot; : &quot;...&quot;,
&quot;scriptID&quot; : &quot;...&quot;,
&quot;userKeyID&quot; : &quot;...&quot;,
&quot;keyValue&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
}</pre>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>
docs/apidocs/json_ProvisionResponse.html 0 → 100644
View file @ 5d404579
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>drip-api: ProvisionResponse</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">
<!--custom css for these pages-->
<link rel="stylesheet" href="css/style.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#apinav">
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: ProvisionResponse</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="resources.html">Resources</a></li>
<li><a href="data.html">Data Types</a></li>
<li><a href="downloads.html">Files and Libraries</a></li>
</ul>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-sm-3 col-md-2 sidebar" id="apinav">
<ul class="nav nav-sidebar">
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
</div>
<div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
<ol class="breadcrumb" id="top">
<li class="active dropdown"><a href="index.html">Home</a></li>
<li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
<li class="dropdown"><a href="json_ProvisionResponse.html">ProvisionResponse</a></li>
</ol>
<h1 class="page-header">ProvisionResponse <small>Data Type</small></h1>
<p></p>
<dl class="dl-horizontal">
</dl>
<table class="table datatype-properties">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_ProvisionRequest.html">ProvisionRequest</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">cloudCredentialsID</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">planID</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">scriptID</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">userKeyID</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_KeyValueHolder.html">KeyValueHolder</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">keyValue</span></td>
<td><span class="datatype-reference">map of object
</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">id</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
<tr>
<td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
</tr>
<tbody>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;cloudCredentialsID&quot; : &quot;...&quot;,
&quot;planID&quot; : &quot;...&quot;,
&quot;scriptID&quot; : &quot;...&quot;,
&quot;userKeyID&quot; : &quot;...&quot;,
&quot;keyValue&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
}</pre>
<footer class="footer">
<div class="container">
<p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
</div>
</footer>
</div>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- Bootstrap core JavaScript
================================================== -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
<script>
$(function() {
$(".clickable-row").click(function() {
window.document.location = $(this).data("href");
});
$('[data-toggle="tooltip"]').tooltip()
});
</script>
</body>
</html>
docs/apidocs/ns0.xsd
View file @ 5d404579
......@@ -248,28 +248,21 @@ sub-topology name appeared in the high-level description file. (For example, her
<xs:complexType name="cloudCredentials">
<xs:annotation>
<xs:documentation>
<![CDATA[This class represents the cloud credentials for a cloud. They are used by the
provisoner to request for resources.]]>
<![CDATA[This class represents the cloud credentials. They are used by the provisoner
to request for resources.]]>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="ownedObject">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="key" type="xs:string" minOccurs="0">
<xs:element name="secretKey" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The key for the cloud provider.]]>
<![CDATA[It is the secret key / password for accessing a cloud provider.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keyIdAlias" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The key id for the cloud provider or the key alias.]]>
</xs:documentation>
</xs:annotation>
<xs:element name="id" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="cloudProviderName" type="xs:string" minOccurs="0">
<xs:annotation>
......@@ -278,52 +271,36 @@ provisoner to request for resources.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="accessKeyId" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="keyIDs" type="xs:string" minOccurs="0" maxOccurs="unbounded">
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="clusterCredentials">
<xs:annotation>
<xs:documentation>
<![CDATA[This class represents the cluster credentials for a cloud. They can used to
login to the cluster created by the deployer]]>
</xs:documentation>
</xs:annotation>
<xs:complexType name="deployRequest">
<xs:complexContent>
<xs:extension base="ownedObject">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:element name="provisionID" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="key" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The key of the login key.]]>
</xs:documentation>
</xs:annotation>
<xs:element name="clusterType" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="configurationID" type="xs:string" minOccurs="0">
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="deployParameter">
<xs:sequence>
<xs:element name="cloudCertificateName" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="IP" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="user" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="role" type="xs:string" minOccurs="0">
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="keyValueHolder">
<xs:complexType name="deployResponse">
<xs:complexContent>
<xs:extension base="ownedObject">
<xs:extension base="deployRequest">
<xs:sequence>
<xs:element name="key" type="key" minOccurs="0">
</xs:element>
<xs:element name="id" type="xs:string" minOccurs="0">
</xs:element>
</xs:sequence>
......@@ -331,12 +308,12 @@ login to the cluster created by the deployer]]>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="loginKey">
<xs:complexType name="key">
<xs:annotation>
<xs:documentation>
<![CDATA[This class represents a login key. This key can be used to either login to a
VM created by the provisiner or by the VM to allow the user to login to the
VMs from the machine the keys correspond to.]]>
<![CDATA[This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.]]>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
......@@ -399,6 +376,17 @@ to specify the domain name for ec2]]>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="keyValueHolder">
<xs:complexContent>
<xs:extension base="ownedObject">
<xs:sequence>
<xs:element name="id" type="xs:string" minOccurs="0">
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ownedObject">
<xs:sequence>
<xs:element name="owner" type="xs:string" minOccurs="0">
......@@ -406,7 +394,27 @@ to specify the domain name for ec2]]>
</xs:sequence>
</xs:complexType>
<xs:complexType name="provisionInfo">
<xs:complexType name="planResponse">
<xs:annotation>
<xs:documentation>
<![CDATA[This class represents a plan generated by the planner.]]>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="keyValueHolder">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="toscaID" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="level" type="xs:int" minOccurs="0">
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="provisionRequest">
<xs:complexContent>
<xs:extension base="keyValueHolder">
<xs:sequence>
......@@ -418,13 +426,18 @@ to specify the domain name for ec2]]>
</xs:element>
<xs:element name="userKeyID" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="deployParameters" type="deployParameter" minOccurs="0" maxOccurs="unbounded">
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="provisionResponse">
<xs:complexContent>
<xs:extension base="provisionRequest">
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="script">
<xs:annotation>
<xs:documentation>
......
docs/apidocs/resource_DeployController.html
View file @ 5d404579
This diff is collapsed.
docs/apidocs/resource_KeysController.html 0 → 100644
View file @ 5d404579
This diff is collapsed.
docs/apidocs/resource_ProvisionController.html
View file @ 5d404579
......@@ -134,7 +134,7 @@ Content-Type: application/json
<div id="resource_ProvisionController_getIds_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/provisioner/ids <a href="../user/v1.0/provisioner/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Gets the IDs of all the stored ProvisionInfo</p>
<p>Gets the IDs of all the stored ProvisionRequest</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -212,12 +212,12 @@ Content-Type: application/json
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_ProvisionInfo.html">ProvisionInfo</a>
<td><span class="datatype-reference"><a href="json_ProvisionRequest.html">ProvisionRequest</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_provisionInfo.html">provisionInfo</a>
<td><span class="datatype-reference"><a href="xml_ns0_provisionRequest.html">provisionRequest</a>
(XML)</span></td>
</tr>
</tbody>
......@@ -237,7 +237,7 @@ Content-Type: application/json
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference">string
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">The ID of the provisioned ProvisionInfo</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">The ID of the provisioned ProvisionRequest</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
......@@ -263,17 +263,6 @@ Accept: application/json
&quot;planID&quot; : &quot;...&quot;,
&quot;scriptID&quot; : &quot;...&quot;,
&quot;userKeyID&quot; : &quot;...&quot;,
&quot;deployParameters&quot; : [ {
&quot;cloudCertificateName&quot; : &quot;...&quot;,
&quot;IP&quot; : &quot;...&quot;,
&quot;user&quot; : &quot;...&quot;,
&quot;role&quot; : &quot;...&quot;
}, {
&quot;cloudCertificateName&quot; : &quot;...&quot;,
&quot;IP&quot; : &quot;...&quot;,
&quot;user&quot; : &quot;...&quot;,
&quot;role&quot; : &quot;...&quot;
} ],
&quot;keyValue&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
......@@ -302,7 +291,7 @@ Content-Type: application/json
<div id="resource_ProvisionController_delete_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/provisioner/{id} <a href="../user/v1.0/provisioner/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Deletes the ProvisionInfo</p>
<p>Deletes the ProvisionRequest</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -341,7 +330,7 @@ Content-Type: application/json
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference">string
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">the ID of the deleted ProvisionInfo</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">the ID of the deleted ProvisionRequest</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
......@@ -380,7 +369,7 @@ Content-Type: application/json
<div id="resource_ProvisionController_get_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/provisioner/{id} <a href="../user/v1.0/provisioner/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Gets the ProvisionInfo</p>
<p>Gets the ProvisionRequest</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -417,13 +406,13 @@ Content-Type: application/json
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_ProvisionInfo.html">ProvisionInfo</a>
<td><span class="datatype-reference"><a href="json_ProvisionResponse.html">ProvisionResponse</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">the requested ProvisionInfo</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">the requested ProvisionRequest</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_provisionInfo.html">provisionInfo</a>
<td><span class="datatype-reference"><a href="xml_ns0_provisionResponse.html">provisionResponse</a>
(XML)</span></td>
</tr>
</tbody>
......@@ -452,17 +441,6 @@ Content-Type: application/json
&quot;planID&quot; : &quot;...&quot;,
&quot;scriptID&quot; : &quot;...&quot;,
&quot;userKeyID&quot; : &quot;...&quot;,
&quot;deployParameters&quot; : [ {
&quot;cloudCertificateName&quot; : &quot;...&quot;,
&quot;IP&quot; : &quot;...&quot;,
&quot;user&quot; : &quot;...&quot;,
&quot;role&quot; : &quot;...&quot;
}, {
&quot;cloudCertificateName&quot; : &quot;...&quot;,
&quot;IP&quot; : &quot;...&quot;,
&quot;user&quot; : &quot;...&quot;,
&quot;role&quot; : &quot;...&quot;
} ],
&quot;keyValue&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
......
docs/apidocs/resource_UserPublicKeysController.html
View file @ 5d404579
......@@ -78,7 +78,7 @@ machine the keys correspond to.</p>
<div id="resource_UserPublicKeysController_postKey_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/user/v1.0/user_key <a href="../user/v1.0/user_key" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Posts the LoginKey and stores it. The LoginKey is a container for public
<p>Posts the Key and stores it. The Key is a container for public
key contents. The public key contents are represented in the 'key' field.
All new lines in the 'key' field have to be replaced with the '\n'
character.</p>
......@@ -99,12 +99,12 @@ character.</p>
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/json&quot; HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_LoginKey.html">LoginKey</a>
<td><span class="datatype-reference"><a href="json_Key.html">Key</a>
(JSON)</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Content-Type: application/xml&quot; HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_loginKey.html">loginKey</a>
<td><span class="datatype-reference"><a href="xml_ns0_key.html">key</a>
(XML)</span></td>
</tr>
</tbody>
......@@ -140,7 +140,7 @@ character.</p>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference">string
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">the ID of the LoginKey</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">the ID of the Key</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
......@@ -251,7 +251,7 @@ Content-Type: application/json
<div id="resource_UserPublicKeysController_getIds_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/user_key/ids <a href="../user/v1.0/user_key/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Gets the IDs of all the stored LoginKey</p>
<p>Gets the IDs of all the stored Key</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -389,7 +389,7 @@ Content-Type: application/json
<div id="resource_UserPublicKeysController_delete_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/user_key/{id} <a href="../user/v1.0/user_key/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Deletes a LoginKey</p>
<p>Deletes a Key</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -428,7 +428,7 @@ Content-Type: application/json
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference">string
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">The ID of the deleted LoginKey</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">The ID of the deleted Key</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
......@@ -467,7 +467,7 @@ Content-Type: application/json
<div id="resource_UserPublicKeysController_get_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/user_key/{id} <a href="../user/v1.0/user_key/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Gets the LoginKey.</p>
<p>Gets the Key.</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -487,7 +487,7 @@ Content-Type: application/json
<tr>
<td><span class="parameter-name">id</span></td>
<td>path</td>
<td><span class="parameter-description">. The ID of the LoginKey to return</span></td>
<td><span class="parameter-description">. The ID of the Key to return</span></td>
</tr>
</tbody>
</table>
......@@ -504,13 +504,13 @@ Content-Type: application/json
<tbody>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
<td><span class="datatype-reference"><a href="json_LoginKey.html">LoginKey</a>
<td><span class="datatype-reference"><a href="json_Key.html">Key</a>
(JSON)</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">The LoginKey</span></td>
<td rowspan="2" class="multi-row-description"><span class="response-description">The Key</span></td>
</tr>
<tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
<td><span class="datatype-reference"><a href="xml_ns0_loginKey.html">loginKey</a>
<td><span class="datatype-reference"><a href="xml_ns0_key.html">key</a>
(XML)</span></td>
</tr>
</tbody>
......
docs/apidocs/resources.html
View file @ 5d404579
......@@ -96,12 +96,14 @@ provisoner to request for resources (VMs).</span>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/user/v1.0/credentials/cloud</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/credentials/cloud/all</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/credentials/cloud/ids</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/credentials/cloud/sample</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/credentials/cloud/{id}</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/credentials/cloud/upload/{id}</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li></ul></td>
......@@ -114,14 +116,14 @@ provisoner to request for resources (VMs)</span>
<td> <span class="resource-name">DeployController</span>
</td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/user/v1.0/deployer/all</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/deployer/deploy/</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/deployer/ids</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/deployer/{id}</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/deployer/deploy/{id}/</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
<td> <span class="resource-description">This controller is responsible for deploying a cluster on provisoned
resources.</span>
......@@ -138,6 +140,28 @@ resources.</span>
</samp></li></ul></td>
<td> <span class="resource-description">This controller is responsible for deploying a cluster on provisoned
resources.</span>
</td>
</tr>
<tr class="clickable-row" data-href="resource_KeysController.html">
<td> <span class="resource-name">KeysController</span>
</td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/user/v1.0/key</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/key/all</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/key/ids</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/key/sample</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/key/upload</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/key/{id}</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
<td> <span class="resource-description">This controller is responsible for handling user public keys. These keys can
be used by the provisoner to allow the user to login to the VMs from the
machine the keys correspond to.</span>
</td>
</tr>
<tr class="clickable-row" data-href="resource_PlannerController.html">
......@@ -245,26 +269,6 @@ used by the planner.</span>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li></ul></td>
<td> <span class="resource-description">This controller is responsible for handling user accounts</span>
</td>
</tr>
<tr class="clickable-row" data-href="resource_UserPublicKeysController.html">
<td> <span class="resource-name">UserPublicKeysController</span>
</td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/user/v1.0/user_key</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/user_key/all</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/user_key/ids</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/user_key/upload</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/user_key/{id}</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
<td> <span class="resource-description">This controller is responsible for handling user public keys. These keys can
be used by the provisoner to allow the user to login to the VMs from the
machine the keys correspond to.</span>
</td>
</tr>
<tr class="clickable-row" data-href="resource_UserPublicKeysController0.html">
......
docs/apidocs/syntax_json.html
View file @ 5d404579
......@@ -74,35 +74,34 @@
<tr class="clickable-row" data-href="json_CloudCredentials.html">
<td> <span class="datatype-name">CloudCredentials</span>
</td>
<td> <span class="datatype-description">This class represents the cloud credentials for a cloud. They are used by the
provisoner to request for resources.</span>
<td> <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ClusterCredentials.html">
<td> <span class="datatype-name">ClusterCredentials</span>
<tr class="clickable-row" data-href="json_DeployRequest.html">
<td> <span class="datatype-name">DeployRequest</span>
</td>
<td> <span class="datatype-description">This class represents the cluster credentials for a cloud. They can used to
login to the cluster created by the deployer</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_DeployParameter.html">
<td> <span class="datatype-name">DeployParameter</span>
<tr class="clickable-row" data-href="json_DeployResponse.html">
<td> <span class="datatype-name">DeployResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_KeyValueHolder.html">
<td> <span class="datatype-name">KeyValueHolder</span>
<tr class="clickable-row" data-href="json_Key.html">
<td> <span class="datatype-name">Key</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_LoginKey.html">
<td> <span class="datatype-name">LoginKey</span>
<tr class="clickable-row" data-href="json_KeyValueHolder.html">
<td> <span class="datatype-name">KeyValueHolder</span>
</td>
<td> <span class="datatype-description">This class represents a login key. This key can be used to either login to a
VM created by the provisiner or by the VM to allow the user to login to the
VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_OwnedObject.html">
......@@ -111,14 +110,20 @@ VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Plan.html">
<td> <span class="datatype-name">Plan</span>
<tr class="clickable-row" data-href="json_PlanResponse.html">
<td> <span class="datatype-name">PlanResponse</span>
</td>
<td> <span class="datatype-description">This class represents a plan generated by the planner.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ProvisionInfo.html">
<td> <span class="datatype-name">ProvisionInfo</span>
<tr class="clickable-row" data-href="json_ProvisionRequest.html">
<td> <span class="datatype-name">ProvisionRequest</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="json_ProvisionResponse.html">
<td> <span class="datatype-name">ProvisionResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
......
docs/apidocs/syntax_xml.html
View file @ 5d404579
......@@ -141,41 +141,40 @@
<tr class="clickable-row" data-href="xml_ns0_cloudCredentials.html">
<td> <span class="datatype-name">cloudCredentials</span>
</td>
<td> <span class="datatype-description">This class represents the cloud credentials for a cloud. They are used by the
provisoner to request for resources.</span>
<td> <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_clusterCredentials.html">
<td> <span class="datatype-name">clusterCredentials</span>
</td>
<td> <span class="datatype-description">This class represents the cluster credentials for a cloud. They can used to
login to the cluster created by the deployer</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
<td> <span class="datatype-name">deployParameter</span>
<tr class="clickable-row" data-href="xml_ns0_deployRequest.html">
<td> <span class="datatype-name">deployRequest</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
<td> <span class="datatype-name">keyValueHolder</span>
<tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
<td> <span class="datatype-name">deployResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_loginKey.html">
<td> <span class="datatype-name">loginKey</span>
<tr class="clickable-row" data-href="xml_ns0_key.html">
<td> <span class="datatype-name">key</span>
</td>
<td> <span class="datatype-description">This class represents a login key. This key can be used to either login to a
VM created by the provisiner or by the VM to allow the user to login to the
VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_type.html">
<td> <span class="datatype-name">type</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
<td> <span class="datatype-name">keyValueHolder</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
......@@ -184,8 +183,20 @@ VMs from the machine the keys correspond to.</span>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_provisionInfo.html">
<td> <span class="datatype-name">provisionInfo</span>
<tr class="clickable-row" data-href="xml_ns0_planResponse.html">
<td> <span class="datatype-name">planResponse</span>
</td>
<td> <span class="datatype-description">This class represents a plan generated by the planner.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_provisionRequest.html">
<td> <span class="datatype-name">provisionRequest</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_provisionResponse.html">
<td> <span class="datatype-name">provisionResponse</span>
</td>
<td> <span class="datatype-description"></span>
</td>
......
docs/apidocs/xml_ns0_cloudCredentials.html
View file @ 5d404579
......@@ -64,8 +64,8 @@
<h1 class="page-header">cloudCredentials <small>Data Type</small></h1>
<p>This class represents the cloud credentials for a cloud. They are used by the
provisoner to request for resources.</p>
<p>This class represents the cloud credentials. They are used by the provisoner
to request for resources.</p>
<dl class="dl-horizontal">
<dt>Namespace</dt>
......@@ -87,6 +87,24 @@ provisoner to request for resources.</p>
</tr>
</thead>
<tbody>
<tr>
<td> <span class="property-name">accessKeyId</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">the accessKeyId</span>
</td>
</tr>
<tr>
<td> <span class="property-name">cloudProviderName</span>
</td>
......@@ -124,7 +142,7 @@ provisoner to request for resources.</p>
</td>
</tr>
<tr>
<td> <span class="property-name">key</span>
<td> <span class="property-name">keyIDs</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -135,14 +153,14 @@ provisoner to request for resources.</p>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/1
<td> <span class="property-minMaxOccurs">0/unbounded
</span>
</td>
<td> <span class="property-description">The key for the cloud provider.</span>
<td> <span class="property-description">the keyIDs</span>
</td>
</tr>
<tr>
<td> <span class="property-name">keyIdAlias</span>
<td> <span class="property-name">secretKey</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -156,7 +174,7 @@ provisoner to request for resources.</p>
<td> <span class="property-minMaxOccurs">0/1
</span>
</td>
<td> <span class="property-description">The key id for the cloud provider or the key alias.</span>
<td> <span class="property-description">It is the secret key / password for accessing a cloud provider.</span>
</td>
</tr>
</tbody>
......@@ -182,10 +200,11 @@ provisoner to request for resources.</p>
<p class="lead">Example</p>
<pre class="prettyprint language-xml example">&lt;c-----&gt;
&lt;secretKey&gt;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&lt;/secretKey&gt;
&lt;id&gt;...&lt;/id&gt;
&lt;key&gt;6J7uo99ifrff45126Gsy5vgb3bmrtwY6hBxtYt9y&lt;/key&gt;
&lt;keyIdAlias&gt;AKIAITY3K5ZUQ6M7YBSQ&lt;/keyIdAlias&gt;
&lt;cloudProviderName&gt;ec2&lt;/cloudProviderName&gt;
&lt;accessKeyId&gt;...&lt;/accessKeyId&gt;
&lt;keyIDs&gt;...&lt;/keyIDs&gt;
&lt;owner&gt;...&lt;/owner&gt;
&lt;/c-----&gt;
</pre>
......
docs/apidocs/xml_ns0_deployRequest.html 0 → 100644
View file @ 5d404579
This diff is collapsed.
docs/apidocs/xml_ns0_deployResponse.html 0 → 100644
View file @ 5d404579
This diff is collapsed.
docs/apidocs/xml_ns0_key.html 0 → 100644
View file @ 5d404579
This diff is collapsed.
docs/apidocs/xml_ns0_keyValueHolder.html
View file @ 5d404579
......@@ -72,7 +72,7 @@
<dt>Schema</dt>
<dd><a href="ns0.xsd">ns0.xsd</a></dd>
<dt>Subtypes</dt>
<dd><a href="xml_ns0_provisionInfo.html">provisionInfo</a>, <a href="xml_ns0_toscaRepresentation.html">toscaRepresentation</a></dd>
<dd><a href="xml_ns0_planResponse.html">planResponse</a>, <a href="xml_ns0_provisionRequest.html">provisionRequest</a>, <a href="xml_ns0_provisionResponse.html">provisionResponse</a>, <a href="xml_ns0_toscaRepresentation.html">toscaRepresentation</a></dd>
</dl>
<table class="table datatype-properties">
......
docs/apidocs/xml_ns0_ownedObject.html
View file @ 5d404579
......@@ -72,7 +72,7 @@
<dt>Schema</dt>
<dd><a href="ns0.xsd">ns0.xsd</a></dd>
<dt>Subtypes</dt>
<dd><a href="xml_ns0_cloudCredentials.html">cloudCredentials</a>, <a href="xml_ns0_clusterCredentials.html">clusterCredentials</a>, <a href="xml_ns0_keyValueHolder.html">keyValueHolder</a>, <a href="xml_ns0_loginKey.html">loginKey</a>, <a href="xml_ns0_provisionInfo.html">provisionInfo</a>, <a href="xml_ns0_script.html">script</a>, <a href="xml_ns0_toscaRepresentation.html">toscaRepresentation</a></dd>
<dd><a href="xml_ns0_cloudCredentials.html">cloudCredentials</a>, <a href="xml_ns0_deployRequest.html">deployRequest</a>, <a href="xml_ns0_deployResponse.html">deployResponse</a>, <a href="xml_ns0_key.html">key</a>, <a href="xml_ns0_keyValueHolder.html">keyValueHolder</a>, <a href="xml_ns0_planResponse.html">planResponse</a>, <a href="xml_ns0_provisionRequest.html">provisionRequest</a>, <a href="xml_ns0_provisionResponse.html">provisionResponse</a>, <a href="xml_ns0_script.html">script</a>, <a href="xml_ns0_toscaRepresentation.html">toscaRepresentation</a></dd>
</dl>
<table class="table datatype-properties">
......
docs/apidocs/xml_ns0_planResponse.html 0 → 100644
View file @ 5d404579
This diff is collapsed.
docs/apidocs/xml_ns0_provisionRequest.html 0 → 100644
View file @ 5d404579
This diff is collapsed.
docs/apidocs/xml_ns0_provisionResponse.html 0 → 100644
View file @ 5d404579
This diff is collapsed.
docs/json_samples/deployer_invocation.json
View file @ 5d404579
......@@ -15,7 +15,14 @@
{
"url": null,
"encoding": "UTF-8",
"value": "swarm",
"value": "fdsvvvvvvvvv",
"name": "playbook",
"attributes": null
},
{
"url": null,
"encoding": "UTF-8",
"value": "ansible",
"name": "cluster",
"attributes": null
}
......
drip-api/src/main/java/nl/uva/sne/drip/api/dao/ClusterCredentialsDao.java → drip-api/src/main/java/nl/uva/sne/drip/api/dao/DeployDao.java
View file @ 5d404579
......@@ -15,13 +15,14 @@
*/
package nl.uva.sne.drip.api.dao;
import nl.uva.sne.drip.commons.v1.types.ClusterCredentials;
import nl.uva.sne.drip.commons.v1.types.DeployResponse;
import nl.uva.sne.drip.commons.v1.types.Key;
import org.springframework.data.mongodb.repository.MongoRepository;
/**
*
* @author S. Koulouzis
*/
public interface ClusterCredentialsDao extends MongoRepository<ClusterCredentials, String> {
public interface DeployDao extends MongoRepository<DeployResponse, String> {
}
drip-api/src/main/java/nl/uva/sne/drip/api/dao/UserKeyDao.java → drip-api/src/main/java/nl/uva/sne/drip/api/dao/KeyDao.java
View file @ 5d404579
......@@ -15,13 +15,13 @@
*/
package nl.uva.sne.drip.api.dao;
import nl.uva.sne.drip.commons.v1.types.LoginKey;
import nl.uva.sne.drip.commons.v1.types.Key;
import org.springframework.data.mongodb.repository.MongoRepository;
/**
*
* @author S. Koulouzis
*/
public interface UserKeyDao extends MongoRepository<LoginKey, String> {
public interface KeyDao extends MongoRepository<Key, String> {
}
drip-api/src/main/java/nl/uva/sne/drip/api/dao/PlanDao.java
View file @ 5d404579
......@@ -15,13 +15,13 @@
*/
package nl.uva.sne.drip.api.dao;
import nl.uva.sne.drip.commons.v1.types.Plan;
import nl.uva.sne.drip.commons.v1.types.PlanResponse;
import org.springframework.data.mongodb.repository.MongoRepository;
/**
*
* @author S. Koulouzis
*/
public interface PlanDao extends MongoRepository<Plan, String> {
public interface PlanDao extends MongoRepository<PlanResponse, String> {
}
drip-api/src/main/java/nl/uva/sne/drip/api/dao/ProvisionInfoDao.java → drip-api/src/main/java/nl/uva/sne/drip/api/dao/ProvisionResponseDao.java
View file @ 5d404579
......@@ -15,13 +15,13 @@
*/
package nl.uva.sne.drip.api.dao;
import nl.uva.sne.drip.commons.v1.types.ProvisionInfo;
import nl.uva.sne.drip.commons.v1.types.ProvisionResponse;
import org.springframework.data.mongodb.repository.MongoRepository;
/**
*
* @author S. Koulouzis
*/
public interface ProvisionInfoDao extends MongoRepository<ProvisionInfo, String> {
public interface ProvisionResponseDao extends MongoRepository<ProvisionResponse, String> {
}
drip-api/src/main/java/nl/uva/sne/drip/api/rpc/PlannerCaller.java
View file @ 5d404579
......@@ -15,12 +15,9 @@
*/
package nl.uva.sne.drip.api.rpc;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.util.concurrent.TimeoutException;
import nl.uva.sne.drip.commons.v1.types.Message;
/**
*
......@@ -34,33 +31,4 @@ public class PlannerCaller extends DRIPCaller {
super(messageBrokerHost, REQUEST_QUEUE_NAME);
}
public String generateFakeResponse(Message plannerInvokationMessage) throws IOException {
return "{\n"
+ " \"creationDate\": 1487002029722,\n"
+ " \"parameters\": [\n"
+ " {\n"
+ " \"url\": null,\n"
+ " \"encoding\": \"UTF-8\",\n"
+ " \"value\": \"{\\\"name\\\":\\\"2d13d708e3a9441ab8336ce874e08dd1\\\",\\\"size\\\":\\\"Small\\\",\\\"docker\\\":\\\"mogswitch/InputDistributor\\\"}\",\n"
+ " \"name\": \"component\",\n"
+ " \"attributes\": null\n"
+ " },\n"
+ " {\n"
+ " \"url\": null,\n"
+ " \"encoding\": \"UTF-8\",\n"
+ " \"value\": \"{\\\"name\\\":\\\"8fcc1788d9ee462c826572c79fdb2a6a\\\",\\\"size\\\":\\\"Small\\\",\\\"docker\\\":\\\"mogswitch/InputDistributor\\\"}\",\n"
+ " \"name\": \"component\",\n"
+ " \"attributes\": null\n"
+ " },\n"
+ " {\n"
+ " \"url\": null,\n"
+ " \"encoding\": \"UTF-8\",\n"
+ " \"value\": \"{\\\"name\\\":\\\"5e0add703c8a43938a39301f572e46c0\\\",\\\"size\\\":\\\"Small\\\",\\\"docker\\\":\\\"mogswitch/InputDistributor\\\"}\",\n"
+ " \"name\": \"component\",\n"
+ " \"attributes\": null\n"
+ " }\n"
+ " ]\n"
+ "}";
}
}
drip-api/src/main/java/nl/uva/sne/drip/api/v0/rest/DeployController0.java
View file @ 5d404579
......@@ -28,7 +28,9 @@ import nl.uva.sne.drip.api.service.UserService;
import nl.uva.sne.drip.commons.v0.types.Deploy;
import nl.uva.sne.drip.commons.v0.types.Attribute;
import nl.uva.sne.drip.commons.v0.types.Result;
import nl.uva.sne.drip.commons.v1.types.ClusterCredentials;
import nl.uva.sne.drip.commons.v1.types.DeployRequest;
import nl.uva.sne.drip.commons.v1.types.DeployResponse;
import nl.uva.sne.drip.commons.v1.types.Key;
import org.springframework.http.MediaType;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.stereotype.Component;
......@@ -53,27 +55,32 @@ public class DeployController0 {
@RolesAllowed({UserService.USER, UserService.ADMIN})
public @ResponseBody
Result deployKubernetes(@RequestBody Deploy deploy) {
return deploy(deploy, "kubernetes");
DeployRequest deployReq = new DeployRequest();
deployReq.setClusterType("kubernetes");
deployReq.setProvisionID(deploy.action);
return deploy(deployReq);
}
@RequestMapping(value = "/swarm", method = RequestMethod.POST, consumes = MediaType.TEXT_XML_VALUE, produces = MediaType.TEXT_XML_VALUE)
@RolesAllowed({UserService.USER, UserService.ADMIN})
public @ResponseBody
Result deploySwarm(@RequestBody Deploy deploy) {
return deploy(deploy, "swarm");
DeployRequest deployReq = new DeployRequest();
deployReq.setClusterType("swarm");
deployReq.setProvisionID(deploy.action);
return deploy(deployReq);
}
private Result deploy(Deploy deploy, String clusterType) {
String provisionID = deploy.action;
private Result deploy(DeployRequest deployReq) {
ClusterCredentials clusterCred = deployService.deployCluster(provisionID, clusterType);
DeployResponse key = deployService.deployCluster(deployReq);
Result res = new Result();
res.info = "INFO";
res.status = "Success";
List<Attribute> files = new ArrayList<>();
Attribute e = new Attribute();
e.content = clusterCred.getKey();
e.content = key.getKey().getKey();
files.add(e);
res.file = files;
return res;
......
drip-deployer/ansible_setup.sh
View file @ 5d404579
This diff is collapsed.
drip-deployer/playbook.yml 0 → 100644
View file @ 5d404579
fdsvvvvvvvvv
\ No newline at end of file
drip-deployer/rpc_server.py
View file @ 5d404579
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment