Commit f02552da authored by Spiros Koulouzis's avatar Spiros Koulouzis

Update documentation

Change package name for data types 
parent 4d751d96
......@@ -86,13 +86,16 @@ to request for resources.</span>
<tr class="clickable-row" data-href="json_DeployParameter.html">
<td> <span class="datatype-name">DeployParameter</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_DeployRequest.html">
<td> <span class="datatype-name">DeployRequest</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_DeployResponse.html">
......@@ -107,6 +110,13 @@ to request for resources.</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_KeyPair.html">
<td> <span class="datatype-name">KeyPair</span>
</td>
<td> <span class="datatype-description">This class hold the pair of public private keys. The kyes may be used for
logging in VMs.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_KeyValueHolder.html">
......@@ -118,7 +128,8 @@ from the machine the keys correspond to.</span>
<tr class="clickable-row" data-href="json_OwnedObject.html">
<td> <span class="datatype-name">OwnedObject</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_PlanResponse.html">
......@@ -142,7 +153,7 @@ from the machine the keys correspond to.</span>
<tr class="clickable-row" data-href="json_ProvisionResponse.html">
<td> <span class="datatype-name">ProvisionResponse</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class represents a description of provisioned resources</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Script.html">
......@@ -259,13 +270,16 @@ to request for resources.</span>
<tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
<td> <span class="datatype-name">deployParameter</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
</td>
</tr>
<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> <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
......@@ -286,6 +300,13 @@ from the machine the keys correspond to.</span>
<td> <span class="datatype-name">type</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyPair.html">
<td> <span class="datatype-name">keyPair</span>
</td>
<td> <span class="datatype-description">This class hold the pair of public private keys. The kyes may be used for
logging in VMs.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
......@@ -297,7 +318,8 @@ from the machine the keys correspond to.</span>
<tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
<td> <span class="datatype-name">ownedObject</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_planResponse.html">
......@@ -321,7 +343,7 @@ from the machine the keys correspond to.</span>
<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> <span class="datatype-description">This class represents a description of provisioned resources</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_script.html">
......
......@@ -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 April 6, 2017</p>
<p class="lead">Created April 7, 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">9.50K</span></td>
<td><span class="downloadfile-size">10.34K</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 April 6, 2017</p>
<p class="lead">Created April 7, 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">12.44K</span></td>
<td><span class="downloadfile-size">13.28K</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">9.84K</span></td>
<td><span class="downloadfile-size">10.72K</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 April 6, 2017</p>
<p class="lead">Created April 7, 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">20.41K</span></td>
<td><span class="downloadfile-size">21.38K</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">18.40K</span></td>
<td><span class="downloadfile-size">19.56K</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 April 6, 2017</p>
<p class="lead">Created April 7, 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.56K</span></td>
<td><span class="downloadfile-size">3.75K</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 April 6, 2017</p>
<p class="lead">Created April 7, 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.74K</span></td>
<td><span class="downloadfile-size">3.99K</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 April 6, 2017</p>
<p class="lead">Created April 7, 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">7.60K</span></td>
<td><span class="downloadfile-size">7.72K</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 April 6, 2017</p>
<p class="lead">Created April 7, 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">47.76K</span></td>
<td><span class="downloadfile-size">51.14K</span></td>
<td><span class="downloadfile-description">&nbsp;</span></td>
</tr>
</tbody>
......
This diff is collapsed.
......@@ -171,21 +171,19 @@ resources.</span>
resources.</span>
</td>
</tr>
<tr class="clickable-row" data-href="resource_KeysController.html">
<td> <span class="resource-name">KeysController</span>
<tr class="clickable-row" data-href="resource_KeyPairController.html">
<td> <span class="resource-name">KeyPairController</span>
</td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/user/v1.0/keys</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/all</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/ids</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/sample</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/upload</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/{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
......@@ -371,13 +369,16 @@ to request for resources.</span>
<tr class="clickable-row" data-href="json_DeployParameter.html">
<td> <span class="datatype-name">DeployParameter</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_DeployRequest.html">
<td> <span class="datatype-name">DeployRequest</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_DeployResponse.html">
......@@ -392,6 +393,13 @@ to request for resources.</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_KeyPair.html">
<td> <span class="datatype-name">KeyPair</span>
</td>
<td> <span class="datatype-description">This class hold the pair of public private keys. The kyes may be used for
logging in VMs.</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_KeyValueHolder.html">
......@@ -403,7 +411,8 @@ from the machine the keys correspond to.</span>
<tr class="clickable-row" data-href="json_OwnedObject.html">
<td> <span class="datatype-name">OwnedObject</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_PlanResponse.html">
......@@ -427,7 +436,7 @@ from the machine the keys correspond to.</span>
<tr class="clickable-row" data-href="json_ProvisionResponse.html">
<td> <span class="datatype-name">ProvisionResponse</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class represents a description of provisioned resources</span>
</td>
</tr>
<tr class="clickable-row" data-href="json_Script.html">
......@@ -544,13 +553,16 @@ to request for resources.</span>
<tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
<td> <span class="datatype-name">deployParameter</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
</td>
</tr>
<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> <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
......@@ -571,6 +583,13 @@ from the machine the keys correspond to.</span>
<td> <span class="datatype-name">type</span>
</td>
<td> <span class="datatype-description"></span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyPair.html">
<td> <span class="datatype-name">keyPair</span>
</td>
<td> <span class="datatype-description">This class hold the pair of public private keys. The kyes may be used for
logging in VMs.</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
......@@ -582,7 +601,8 @@ from the machine the keys correspond to.</span>
<tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
<td> <span class="datatype-name">ownedObject</span>
</td>
<td> <span class="datatype-description"></span>
<td> <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_planResponse.html">
......@@ -606,7 +626,7 @@ from the machine the keys correspond to.</span>
<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> <span class="datatype-description">This class represents a description of provisioned resources</span>
</td>
</tr>
<tr class="clickable-row" data-href="xml_ns0_script.html">
......
......@@ -95,7 +95,7 @@ to request for resources.</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The UID of this object.</span>
</td>
</tr>
<tr>
......@@ -113,16 +113,17 @@ to request for resources.</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The access key ID for a cloud provider. Some providers may not use this
field</span>
</td>
</tr>
<tr>
<td> <span class="property-name">keyIDs</span>
<td> <span class="property-name">keyPairIDs</span>
</td>
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The IDs of of the key pairs for accessing the VMs of that cloud provider.</span>
</td>
</tr>
</tbody>
......@@ -134,7 +135,7 @@ to request for resources.</p>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -143,11 +144,11 @@ to request for resources.</p>
<pre class="prettyprint language-js example">{
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;accessKeyId&quot; : &quot;...&quot;,
&quot;keyIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;...&quot;
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;keyPairIDs&quot; : [ &quot;AKIKIQY9K1ZUQ6M7YBSQ, LKJ2KIQY9K1F236M7YASD&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
<!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: ClusterCredentials</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: ClusterCredentials</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_ClusterCredentials.html">ClusterCredentials</a></li>
</ol>
<h1 class="page-header">ClusterCredentials <small>Data Type</small></h1>
<p>This class represents the cluster credentials for a cloud. They can used to
login to the cluster created by the deployer</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">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">key</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The key of the login 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;id&quot; : &quot;...&quot;,
&quot;key&quot; : &quot;BEGINRSAPRIVATEKEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3fVJ4+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/Qpm3SQWLz0RBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mPJxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48howjUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----ENDRSAPRIVATEKEY-----\\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>
......@@ -64,7 +64,9 @@
<h1 class="page-header">DeployParameter <small>Data Type</small></h1>
<p></p>
<p>This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</p>
<dl class="dl-horizontal">
</dl>
......@@ -85,7 +87,8 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The file name of the certificate used to log in as root to the
provisioned VM.</span>
</td>
</tr>
<tr>
......@@ -94,7 +97,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The public IP of the provisioned VM</span>
</td>
</tr>
<tr>
......@@ -103,7 +106,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The user name of the account created on the provisioned VM</span>
</td>
</tr>
<tr>
......@@ -112,7 +115,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The role of the provisioned VM</span>
</td>
</tr>
</tbody>
......@@ -121,10 +124,10 @@
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;cloudCertificateName&quot; : &quot;...&quot;,
&quot;IP&quot; : &quot;...&quot;,
&quot;user&quot; : &quot;...&quot;,
&quot;role&quot; : &quot;...&quot;
&quot;cloudCertificateName&quot; : &quot;Virginia&quot;,
&quot;IP&quot; : &quot;52.73.245.157&quot;,
&quot;user&quot; : &quot;vm_user&quot;,
&quot;role&quot; : &quot;slave&quot;
}</pre>
<footer class="footer">
......
......@@ -64,7 +64,8 @@
<h1 class="page-header">DeployRequest <small>Data Type</small></h1>
<p></p>
<p>This class holds the necessary POJO IDs to request the deployment of a
software</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
......@@ -87,7 +88,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The ID of the provision resources description <code>nl.uva.sne.drip.data.v1.external.ProvisionResponse</code></span>
</td>
</tr>
<tr>
......@@ -96,7 +97,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The type of deployment manager to be used (swarm, ansile, kubernetes)</span>
</td>
</tr>
<tr>
......@@ -105,7 +106,9 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The ID of the configuration POJO that contains information used the
chosen deployment manager (for now only ansible)
<code>nl.uva.sne.drip.data.v1.external.PlaybookRepresentation</code></span>
</td>
</tr>
</tbody>
......@@ -117,7 +120,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -125,10 +128,10 @@
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;provisionID&quot; : &quot;...&quot;,
&quot;managerType&quot; : &quot;...&quot;,
&quot;configurationID&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;managerType&quot; : &quot;ansible&quot;,
&quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -106,19 +106,21 @@
<td><span class="property-name">provisionID</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The ID of the provision resources description <code>nl.uva.sne.drip.data.v1.external.ProvisionResponse</code></span></td>
</tr>
<tr>
<td><span class="property-name">managerType</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The type of deployment manager to be used (swarm, ansile, kubernetes)</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>
<td><span class="property-description">The ID of the configuration POJO that contains information used the
chosen deployment manager (for now only ansible)
<code>nl.uva.sne.drip.data.v1.external.PlaybookRepresentation</code></span></td>
</tr>
</tbody>
<tr>
......@@ -129,7 +131,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -144,14 +146,13 @@
&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;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;id&quot; : &quot;...&quot;,
&quot;provisionID&quot; : &quot;...&quot;,
&quot;managerType&quot; : &quot;...&quot;,
&quot;configurationID&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;managerType&quot; : &quot;ansible&quot;,
&quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -119,17 +119,6 @@ to specify the domain name for ec2</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>
......@@ -141,8 +130,7 @@ to specify the domain name for ec2</span>
&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;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;
}</pre>
<footer class="footer">
......
......@@ -6,7 +6,7 @@
<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: Plan</title>
<title>drip-api: KeyPair</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,7 +35,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: Plan</a>
<a class="navbar-brand" href="index.html">drip-api: KeyPair</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
......@@ -59,12 +59,13 @@
<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_Plan.html">Plan</a></li>
<li class="dropdown"><a href="json_KeyPair.html">KeyPair</a></li>
</ol>
<h1 class="page-header">Plan <small>Data Type</small></h1>
<h1 class="page-header">KeyPair <small>Data Type</small></h1>
<p>This class represents a plan generated by the planner.</p>
<p>This class hold the pair of public private keys. The kyes may be used for
logging in VMs.</p>
<dl class="dl-horizontal">
</dl>
......@@ -80,59 +81,33 @@
</thead>
<tbody>
<tr>
<td> <span class="property-name">name</span>
<td> <span class="property-name">privateKey</span>
</td>
<td> <span class="datatype-reference">string
<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">toscaID</span>
<td> <span class="property-name">publicKey</span>
</td>
<td> <span class="datatype-reference">string
<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">level</span>
</td>
<td> <span class="datatype-reference">number
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-name">id</span>
</td>
</tr>
<tr>
<td> <span class="property-name">loweLevelPlanIDs</span>
</td>
<td> <span class="datatype-reference">array of string
<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>
......@@ -141,7 +116,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -149,16 +124,26 @@
<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;privateKey&quot; : {
&quot;name&quot; : &quot;id_dsa.pub&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;publicKey&quot; : {
&quot;name&quot; : &quot;id_dsa.pub&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;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -68,7 +68,7 @@
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_PlaybookRepresentation.html">PlaybookRepresentation</a>, <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>
<dd><a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_PlanResponse.html">PlanResponse</a>, <a href="json_PlaybookRepresentation.html">PlaybookRepresentation</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a></dd>
</dl>
<table class="table datatype-properties">
......@@ -108,7 +108,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -121,7 +121,7 @@
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
<!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: LoginKey</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: LoginKey</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_LoginKey.html">LoginKey</a></li>
</ol>
<h1 class="page-header">LoginKey <small>Data Type</small></h1>
<p>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.</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>
......@@ -64,11 +64,12 @@
<h1 class="page-header">OwnedObject <small>Data Type</small></h1>
<p></p>
<p>This is the base class for users to own resources. Many classes extend this
class</p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_Script.html">Script</a>, <a href="json_PlaybookRepresentation.html">PlaybookRepresentation</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>
<dd><a href="json_DeployRequest.html">DeployRequest</a>, <a href="json_KeyPair.html">KeyPair</a>, <a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_KeyValueHolder.html">KeyValueHolder</a>, <a href="json_PlanResponse.html">PlanResponse</a>, <a href="json_PlaybookRepresentation.html">PlaybookRepresentation</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a>, <a href="json_Script.html">Script</a>, <a href="json_DeployResponse.html">DeployResponse</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a>, <a href="json_CloudCredentials.html">CloudCredentials</a></dd>
</dl>
<table class="table datatype-properties">
......@@ -87,7 +88,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The owner (username) for the particular object.</span>
</td>
</tr>
</tbody>
......@@ -96,7 +97,7 @@
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -141,7 +141,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -158,7 +158,7 @@
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
<!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: PlayBookRepresentation</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: PlayBookRepresentation</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_PlayBookRepresentation.html">PlayBookRepresentation</a></li>
</ol>
<h1 class="page-header">PlayBookRepresentation <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">name</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;name&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>
......@@ -114,7 +114,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -128,7 +128,7 @@
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
<!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: ProvisionInfo</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: ProvisionInfo</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_ProvisionInfo.html">ProvisionInfo</a></li>
</ol>
<h1 class="page-header">ProvisionInfo <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">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>
<tr>
<td> <span class="property-name">deployParameters</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_DeployParameter.html">DeployParameter</a>
</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;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; : { }
},
&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>
......@@ -134,7 +134,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -150,7 +150,7 @@
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -64,7 +64,7 @@
<h1 class="page-header">ProvisionResponse <small>Data Type</small></h1>
<p></p>
<p>This class represents a description of provisioned resources</p>
<dl class="dl-horizontal">
</dl>
......@@ -85,7 +85,7 @@
<td> <span class="datatype-reference">array of <a href="json_DeployParameter.html">DeployParameter</a>
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The deploy parameters.</span>
</td>
</tr>
</tbody>
......@@ -137,7 +137,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -146,10 +146,10 @@
<pre class="prettyprint language-js example">{
&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;Virginia&quot;,
&quot;IP&quot; : &quot;52.73.245.157&quot;,
&quot;user&quot; : &quot;vm_user&quot;,
&quot;role&quot; : &quot;slave&quot;
}, {
&quot;cloudCertificateName&quot; : &quot;...&quot;,
&quot;IP&quot; : &quot;...&quot;,
......@@ -164,7 +164,7 @@
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -115,7 +115,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -126,7 +126,7 @@
&quot;id&quot; : &quot;...&quot;,
&quot;name&quot; : &quot;config.sh&quot;,
&quot;contents&quot; : &quot; #!/bin/bash\necho \&quot;Reading system-wide config....\&quot; &gt;&amp;2\\n. /etc/cool.cfg\nif [ -r ~/.coolrc ]; then\n echo \&quot;Reading user config....\&quot; &gt;&amp;2\\n . ~/.coolrc\\nfi&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -114,7 +114,7 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object.</span></td>
</tr>
</tbody>
</table>
......@@ -128,7 +128,7 @@
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}</pre>
<footer class="footer">
......
......@@ -262,8 +262,6 @@ to request for resources.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="id" type="xs:string" minOccurs="0">
</xs:element>
<xs:element name="cloudProviderName" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
......@@ -272,8 +270,12 @@ to request for resources.]]>
</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:annotation>
<xs:documentation>
<![CDATA[The access key ID for a cloud provider. Some providers may not use this
field]]>
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
......@@ -281,27 +283,78 @@ to request for resources.]]>
</xs:complexType>
<xs:complexType name="deployParameter">
<xs:annotation>
<xs:documentation>
<![CDATA[This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.]]>
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="cloudCertificateName" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The file name of the certificate used to log in as root to the
provisioned VM.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="IP" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The public IP of the provisioned VM]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="user" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The user name of the account created on the provisioned VM]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The role of the provisioned VM]]>
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="deployRequest">
<xs:annotation>
<xs:documentation>
<![CDATA[This class holds the necessary POJO IDs to request the deployment of a
software]]>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="ownedObject">
<xs:sequence>
<xs:element name="provisionID" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The ID of the provision resources description <code>nl.uva.sne.drip.data.v1.external.ProvisionResponse</code>]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="managerType" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The type of deployment manager to be used (swarm, ansile, kubernetes)]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="configurationID" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The ID of the configuration POJO that contains information used the
chosen deployment manager (for now only ansible)
<code>nl.uva.sne.drip.data.v1.external.PlaybookRepresentation</code>]]>
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
......@@ -329,9 +382,7 @@ 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>
<xs:extension base="ownedObject">
<xs:sequence>
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
......@@ -374,8 +425,6 @@ to specify the domain name for ec2]]>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="type">
......@@ -387,6 +436,25 @@ to specify the domain name for ec2]]>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="keyPair">
<xs:annotation>
<xs:documentation>
<![CDATA[This class hold the pair of public private keys. The kyes may be used for
logging in VMs.]]>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="ownedObject">
<xs:sequence>
<xs:element name="privateKey" type="key" minOccurs="0">
</xs:element>
<xs:element name="publicKey" type="key" minOccurs="0">
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="keyValueHolder">
<xs:complexContent>
<xs:extension base="ownedObject">
......@@ -399,8 +467,19 @@ to specify the domain name for ec2]]>
</xs:complexType>
<xs:complexType name="ownedObject">
<xs:annotation>
<xs:documentation>
<![CDATA[This is the base class for users to own resources. Many classes extend this
class]]>
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="owner" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The owner (username) for the particular object.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
......@@ -452,10 +531,20 @@ to specify the domain name for ec2]]>
</xs:complexType>
<xs:complexType name="provisionResponse">
<xs:annotation>
<xs:documentation>
<![CDATA[This class represents a description of provisioned resources]]>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="provisionRequest">
<xs:sequence>
<xs:element name="deployParameters" type="deployParameter" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
<![CDATA[The deploy parameters.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
......
......@@ -161,11 +161,11 @@ Accept: application/json
<code class="prettyprint language-js">
{
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;accessKeyId&quot; : &quot;...&quot;,
&quot;keyIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;...&quot;
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;keyPairIDs&quot; : [ &quot;AKIKIQY9K1ZUQ6M7YBSQ, LKJ2KIQY9K1F236M7YASD&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......@@ -355,11 +355,11 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;accessKeyId&quot; : &quot;...&quot;,
&quot;keyIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;...&quot;
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;keyPairIDs&quot; : [ &quot;AKIKIQY9K1ZUQ6M7YBSQ, LKJ2KIQY9K1F236M7YASD&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......@@ -518,11 +518,11 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;accessKeyId&quot; : &quot;...&quot;,
&quot;keyIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;...&quot;
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;keyPairIDs&quot; : [ &quot;AKIKIQY9K1ZUQ6M7YBSQ, LKJ2KIQY9K1F236M7YASD&quot;, &quot;...&quot; ],
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......
......@@ -198,10 +198,10 @@ Accept: application/json
<code class="prettyprint language-js">
{
&quot;provisionID&quot; : &quot;...&quot;,
&quot;managerType&quot; : &quot;...&quot;,
&quot;configurationID&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;managerType&quot; : &quot;ansible&quot;,
&quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......@@ -330,10 +330,10 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;provisionID&quot; : &quot;...&quot;,
&quot;managerType&quot; : &quot;...&quot;,
&quot;configurationID&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;managerType&quot; : &quot;ansible&quot;,
&quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......@@ -494,14 +494,13 @@ Content-Type: application/json
&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;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;id&quot; : &quot;...&quot;,
&quot;provisionID&quot; : &quot;...&quot;,
&quot;managerType&quot; : &quot;...&quot;,
&quot;configurationID&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;managerType&quot; : &quot;ansible&quot;,
&quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......
This diff is collapsed.
This diff is collapsed.
......@@ -268,7 +268,7 @@ Accept: application/json
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......@@ -347,7 +347,7 @@ Content-Type: application/json
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......@@ -506,10 +506,10 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&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;Virginia&quot;,
&quot;IP&quot; : &quot;52.73.245.157&quot;,
&quot;user&quot; : &quot;vm_user&quot;,
&quot;role&quot; : &quot;slave&quot;
}, {
&quot;cloudCertificateName&quot; : &quot;...&quot;,
&quot;IP&quot; : &quot;...&quot;,
......@@ -524,7 +524,7 @@ Content-Type: application/json
&quot;property2&quot; : { }
},
&quot;id&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;...&quot;
&quot;owner&quot; : &quot;user1&quot;
}
</code>
</pre>
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
......@@ -163,21 +163,19 @@ resources.</span>
resources.</span>
</td>
</tr>
<tr class="clickable-row" data-href="resource_KeysController.html">
<td> <span class="resource-name">KeysController</span>
<tr class="clickable-row" data-href="resource_KeyPairController.html">
<td> <span class="resource-name">KeyPairController</span>
</td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/user/v1.0/keys</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/all</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/ids</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/sample</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/upload</span>
</samp></li><li><samp> <span class="resource-path">/user/v1.0/keys/{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
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
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