Commit ac02a630 authored by Spiros Koulouzis's avatar Spiros Koulouzis

documentation

parent 0d5485e0
This diff is collapsed.
This diff is collapsed.
This source diff could not be displayed because it is too large. You can view the blob instead.
This diff is collapsed.
......@@ -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-commons: AnsibleOutput</title>
<title>drip-api: AnsibleOutput</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: AnsibleOutput</a>
<a class="navbar-brand" href="index.html">drip-api: AnsibleOutput</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>
......@@ -63,8 +64,7 @@
<h1 class="page-header">AnsibleOutput <small>Data Type</small></h1>
<p>This class represents the the ansible out put for a specific VM. This can be
used as a archive / log of ansible executions</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -142,15 +142,13 @@ used as a archive / log of ansible executions</p>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......@@ -166,14 +164,14 @@ object is saved.</span></td>
<pre class="prettyprint language-js example">{
&quot;host&quot; : &quot;...&quot;,
&quot;result&quot; : {
&quot;end&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;stdout&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;msg&quot; : &quot;...&quot;,
&quot;changed&quot; : true,
&quot;end&quot; : &quot;...&quot;,
&quot;start&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;stdout&quot; : &quot;...&quot;,
&quot;stderr&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ]
&quot;stderr&quot; : &quot;...&quot;
},
&quot;vmType&quot; : &quot;...&quot;,
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
......
......@@ -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-commons: AnsibleResult</title>
<title>drip-api: AnsibleResult</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: AnsibleResult</a>
<a class="navbar-brand" href="index.html">drip-api: AnsibleResult</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>
......@@ -63,8 +64,7 @@
<h1 class="page-header">AnsibleResult <small>Data Type</small></h1>
<p>This class represents an ansible execution result. This can be
used as a archive / log of ansible executions for example how much time it took for execution, errors etc.</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -80,7 +80,7 @@ used as a archive / log of ansible executions for example how much time it took
</thead>
<tbody>
<tr>
<td> <span class="property-name">msg</span>
<td> <span class="property-name">end</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -89,16 +89,16 @@ used as a archive / log of ansible executions for example how much time it took
</td>
</tr>
<tr>
<td> <span class="property-name">changed</span>
<td> <span class="property-name">cmd</span>
</td>
<td> <span class="datatype-reference">boolean
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">end</span>
<td> <span class="property-name">stdout</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -107,7 +107,7 @@ used as a archive / log of ansible executions for example how much time it took
</td>
</tr>
<tr>
<td> <span class="property-name">start</span>
<td> <span class="property-name">delta</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -116,7 +116,7 @@ used as a archive / log of ansible executions for example how much time it took
</td>
</tr>
<tr>
<td> <span class="property-name">delta</span>
<td> <span class="property-name">msg</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -125,16 +125,16 @@ used as a archive / log of ansible executions for example how much time it took
</td>
</tr>
<tr>
<td> <span class="property-name">stdout</span>
<td> <span class="property-name">changed</span>
</td>
<td> <span class="datatype-reference">string
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">stderr</span>
<td> <span class="property-name">start</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -143,9 +143,9 @@ used as a archive / log of ansible executions for example how much time it took
</td>
</tr>
<tr>
<td> <span class="property-name">cmd</span>
<td> <span class="property-name">stderr</span>
</td>
<td> <span class="datatype-reference">array of string
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
......@@ -157,14 +157,14 @@ used as a archive / log of ansible executions for example how much time it took
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;end&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;stdout&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;msg&quot; : &quot;...&quot;,
&quot;changed&quot; : true,
&quot;end&quot; : &quot;...&quot;,
&quot;start&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;stdout&quot; : &quot;...&quot;,
&quot;stderr&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ]
&quot;stderr&quot; : &quot;...&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-commons: BenchmarkResult</title>
<title>drip-api: BenchmarkResult</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: BenchmarkResult</a>
<a class="navbar-brand" href="index.html">drip-api: BenchmarkResult</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>
......@@ -63,11 +64,9 @@
<h1 class="page-header">BenchmarkResult <small>Data Type</small></h1>
<p>This class represents an benchmark result for a specific VM.</p>
<p></p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_SysbenchCPUBenchmark.html">SysbenchCPUBenchmark</a></dd>
</dl>
<table class="table datatype-properties">
......@@ -81,7 +80,7 @@
</thead>
<tbody>
<tr>
<td> <span class="property-name">vmType</span>
<td> <span class="property-name">start</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -90,7 +89,7 @@
</td>
</tr>
<tr>
<td> <span class="property-name">end</span>
<td> <span class="property-name">delta</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -99,7 +98,7 @@
</td>
</tr>
<tr>
<td> <span class="property-name">start</span>
<td> <span class="property-name">end</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -108,7 +107,7 @@
</td>
</tr>
<tr>
<td> <span class="property-name">delta</span>
<td> <span class="property-name">cloudDeploymentDomain</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -126,7 +125,7 @@
</td>
</tr>
<tr>
<td> <span class="property-name">cloudDeploymentDomain</span>
<td> <span class="property-name">vmType</span>
</td>
<td> <span class="datatype-reference">string
</span>
......@@ -143,15 +142,13 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......@@ -165,12 +162,12 @@ object is saved.</span></td>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;vmType&quot; : &quot;...&quot;,
&quot;end&quot; : &quot;...&quot;,
&quot;start&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;host&quot; : &quot;...&quot;,
&quot;end&quot; : &quot;...&quot;,
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
&quot;host&quot; : &quot;...&quot;,
&quot;vmType&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
......
......@@ -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-commons: CloudCredentials</title>
<title>drip-api: CloudCredentials</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: CloudCredentials</a>
<a class="navbar-brand" href="index.html">drip-api: CloudCredentials</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>
......@@ -63,8 +64,7 @@
<h1 class="page-header">CloudCredentials <small>Data Type</small></h1>
<p>This class represents the cloud credentials. They are used by the provisoner
to request for resources.</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -80,21 +80,21 @@ to request for resources.</p>
</thead>
<tbody>
<tr>
<td> <span class="property-name">secretKey</span>
<td> <span class="property-name">attributes</span>
</td>
<td> <span class="datatype-reference">string
<td> <span class="datatype-reference">map of object
</span>
</td>
<td> <span class="property-description">It is the secret key / password for accessing a cloud provider.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">cloudProviderName</span>
<td> <span class="property-name">secretKey</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>
......@@ -103,13 +103,13 @@ to request for resources.</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The access key ID / user name for a cloud provider.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">attributes</span>
<td> <span class="property-name">cloudProviderName</span>
</td>
<td> <span class="datatype-reference">map of object
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
......@@ -124,15 +124,13 @@ 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">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......@@ -146,13 +144,13 @@ object is saved.</span></td>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
......
......@@ -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-commons: DeployParameter</title>
<title>drip-api: DeployParameter</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: DeployParameter</a>
<a class="navbar-brand" href="index.html">drip-api: DeployParameter</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>
......@@ -63,9 +64,7 @@
<h1 class="page-header">DeployParameter <small>Data Type</small></h1>
<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>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -86,7 +85,7 @@ information.</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The public IP of the provisioned VM</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -95,7 +94,7 @@ information.</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The user name of the account created on the provisioned VM</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -104,7 +103,7 @@ information.</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The role of the provisioned VM</span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......
......@@ -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-commons: DeployRequest</title>
<title>drip-api: DeployRequest</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: DeployRequest</a>
<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>
......@@ -63,8 +64,7 @@
<h1 class="page-header">DeployRequest <small>Data Type</small></h1>
<p>This class holds the necessary POJO IDs to request the deployment of a
software</p>
<p></p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
......@@ -82,12 +82,12 @@ software</p>
</thead>
<tbody>
<tr>
<td> <span class="property-name">provisionID</span>
<td> <span class="property-name">configurationID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The ID of the provision resources description <code>ProvisionResponse</code></span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -96,18 +96,16 @@ software</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The type of deployment manager to be used (swarm, ansile, kubernetes)</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">configurationID</span>
<td> <span class="property-name">provisionID</span>
</td>
<td> <span class="datatype-reference">string
</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>PlaybookRepresentation</code></span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......@@ -119,15 +117,13 @@ chosen deployment manager (for now only ansible)
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......@@ -141,9 +137,9 @@ object is saved.</span></td>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;managerType&quot; : &quot;ansible&quot;,
&quot;configurationID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;managerType&quot; : &quot;ansible&quot;,
&quot;provisionID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
......
This diff is collapsed.
<!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: Invocation</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: Invocation</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_Invocation.html">Invocation</a></li>
</ol>
<h1 class="page-header">Invocation <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">module_args</span>
</td>
<td> <span class="datatype-reference"><a href="json_ModuleArgs.html">ModuleArgs</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">module_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">module_args</span>
</td>
<td> <span class="datatype-reference"><a href="json_ModuleArgs.html">ModuleArgs</a>
</span>
</td>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
</table>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;module_args&quot; : {
&quot;dpkg_options&quot; : &quot;...&quot;,
&quot;autoremove&quot; : true,
&quot;force&quot; : true,
&quot;name&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;install_recommends&quot; : { },
&quot;package&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;purge&quot; : true,
&quot;allow_unauthenticated&quot; : true,
&quot;state&quot; : &quot;...&quot;,
&quot;upgrade&quot; : { },
&quot;update_cache&quot; : true,
&quot;deb&quot; : { },
&quot;only_upgrade&quot; : true,
&quot;default_release&quot; : { },
&quot;cache_valid_time&quot; : 12345
},
&quot;module_name&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>
......@@ -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-commons: Key</title>
<title>drip-api: Key</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: Key</a>
<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>
......@@ -63,9 +64,7 @@
<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>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -81,12 +80,12 @@ from the machine the keys correspond to.</p>
</thead>
<tbody>
<tr>
<td> <span class="property-name">name</span>
<td> <span class="property-name">attributes</span>
</td>
<td> <span class="datatype-reference">string
<td> <span class="datatype-reference">map of string
</span>
</td>
<td> <span class="property-description">The name of the key.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -95,26 +94,25 @@ from the machine the keys correspond to.</p>
<td> <span class="datatype-reference"><a href="json_KeyType.html">KeyType</a>
</span>
</td>
<td> <span class="property-description">The type of key</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">attributes</span>
<td> <span class="property-name">key</span>
</td>
<td> <span class="datatype-reference">map of string
<td> <span class="datatype-reference">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> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">key</span>
<td> <span class="property-name">name</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The contents of the key.</span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......@@ -123,13 +121,13 @@ to specify the domain name for ec2</span>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&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;type&quot; : &quot;PRIVATE&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;name&quot; : &quot;id_dsa.pub&quot;
}</pre>
<footer class="footer">
......
This diff is collapsed.
......@@ -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-commons: KeyType</title>
<title>drip-api: KeyType</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: KeyType</a>
<a class="navbar-brand" href="index.html">drip-api: KeyType</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>
......@@ -63,7 +64,7 @@
<h1 class="page-header">KeyType <small>Data Type</small></h1>
<p>This enu specifies if a key is private or public</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -79,11 +80,11 @@
<tbody>
<tr>
<td><span class="value-value">PRIVATE</span></td>
<td><span class="value-description">For private keys</span></td>
<td><span class="value-description"></span></td>
</tr>
<tr>
<td><span class="value-value">PUBLIC</span></td>
<td><span class="value-description">For public keys</span></td>
<td><span class="value-description"></span></td>
</tr>
</tbody>
</table>
......
......@@ -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-commons: KeyValueHolder</title>
<title>drip-api: KeyValueHolder</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: KeyValueHolder</a>
<a class="navbar-brand" href="index.html">drip-api: KeyValueHolder</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>
......@@ -63,12 +64,11 @@
<h1 class="page-header">KeyValueHolder <small>Data Type</small></h1>
<p>This is a generic class that hold key-value pairs. It's main usage is to hold
abstract types such as TOSCA.</p>
<p></p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_PlanResponse.html">PlanResponse</a>, <a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a>, <a href="json_PlaybookRepresentation.html">PlaybookRepresentation</a></dd>
<dd><a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a></dd>
</dl>
<table class="table datatype-properties">
......@@ -87,7 +87,7 @@ abstract types such as TOSCA.</p>
<td> <span class="datatype-reference">map of object
</span>
</td>
<td> <span class="property-description">The key-value map</span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......@@ -99,15 +99,13 @@ abstract types such as TOSCA.</p>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......
This diff is collapsed.
......@@ -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-commons: OwnedObject</title>
<title>drip-api: OwnedObject</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: OwnedObject</a>
<a class="navbar-brand" href="index.html">drip-api: OwnedObject</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>
......@@ -63,12 +64,11 @@
<h1 class="page-header">OwnedObject <small>Data Type</small></h1>
<p>This is the base class for users to own resources. Many classes extend this
class</p>
<p></p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
<dd><a href="json_KeyPair.html">KeyPair</a>, <a href="json_AnsibleOutput.html">AnsibleOutput</a>, <a href="json_BenchmarkResult.html">BenchmarkResult</a>, <a href="json_CloudCredentials.html">CloudCredentials</a>, <a href="json_DeployResponse.html">DeployResponse</a>, <a href="json_PlanResponse.html">PlanResponse</a>, <a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_Script.html">Script</a>, <a href="json_KeyValueHolder.html">KeyValueHolder</a>, <a href="json_DeployRequest.html">DeployRequest</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a>, <a href="json_ToscaRepresentation.html">ToscaRepresentation</a>, <a href="json_SysbenchCPUBenchmark.html">SysbenchCPUBenchmark</a>, <a href="json_PlaybookRepresentation.html">PlaybookRepresentation</a></dd>
<dd><a href="json_KeyPair.html">KeyPair</a>, <a href="json_AnsibleOutput.html">AnsibleOutput</a>, <a href="json_BenchmarkResult.html">BenchmarkResult</a>, <a href="json_CloudCredentials.html">CloudCredentials</a>, <a href="json_DeployResponse.html">DeployResponse</a>, <a href="json_ProvisionRequest.html">ProvisionRequest</a>, <a href="json_Script.html">Script</a>, <a href="json_KeyValueHolder.html">KeyValueHolder</a>, <a href="json_DeployRequest.html">DeployRequest</a>, <a href="json_ProvisionResponse.html">ProvisionResponse</a></dd>
</dl>
<table class="table datatype-properties">
......@@ -87,8 +87,7 @@ class</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -97,8 +96,7 @@ the DAO saves the object based on the principal how made the call</span>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......
......@@ -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-commons: PlanRequest</title>
<title>drip-api: PlanRequest</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: PlanRequest</a>
<a class="navbar-brand" href="index.html">drip-api: PlanRequest</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>
......@@ -63,7 +64,7 @@
<h1 class="page-header">PlanRequest <small>Data Type</small></h1>
<p>This class represents a plan request sent to the planner.</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -79,48 +80,48 @@
</thead>
<tbody>
<tr>
<td> <span class="property-name">toscaID</span>
<td> <span class="property-name">osType</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The ID of the tosca file the generated this plan</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">managerType</span>
<td> <span class="property-name">cloudProvider</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The type of cluster manager</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">vmUserName</span>
<td> <span class="property-name">managerType</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The default username to be set to all VMs</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">cloudProvider</span>
<td> <span class="property-name">toscaID</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The cloud provider</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">osType</span>
<td> <span class="property-name">vmUserName</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The type of OS for the VMs</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -129,7 +130,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The domain to request the VMs</span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......@@ -138,11 +139,11 @@
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;toscaID&quot; : &quot;592d5884e452f1b9b666a657&quot;,
&quot;osType&quot; : &quot;Ubuntu16.04&quot;,
&quot;cloudProvider&quot; : &quot;egi&quot;,
&quot;managerType&quot; : &quot;swarm&quot;,
&quot;toscaID&quot; : &quot;592d5884e452f1b9b666a657&quot;,
&quot;vmUserName&quot; : &quot;vm_user&quot;,
&quot;cloudProvider&quot; : &quot;egi&quot;,
&quot;osType&quot; : &quot;Ubuntu16.04&quot;,
&quot;domain&quot; : &quot;us-east-1&quot;
}</pre>
......
......@@ -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-commons: ProvisionRequest</title>
<title>drip-api: ProvisionRequest</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: ProvisionRequest</a>
<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>
......@@ -63,8 +64,7 @@
<h1 class="page-header">ProvisionRequest <small>Data Type</small></h1>
<p>This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</p>
<p></p>
<dl class="dl-horizontal">
<dt>Subtypes</dt>
......@@ -82,12 +82,12 @@ provisioner to request for cloud resources.</p>
</thead>
<tbody>
<tr>
<td> <span class="property-name">cloudCredentialsIDs</span>
<td> <span class="property-name">deployerKeyPairIDs</span>
</td>
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description">The cloud credentials ids required to provision the cloud resources.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -96,7 +96,7 @@ provisioner to request for cloud resources.</p>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The ID of the plan <code>PlanResponse</code> to provision for.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -105,11 +105,11 @@ provisioner to request for cloud resources.</p>
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description">The key pair id for the keys to use to log in the provisioned VMs.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">deployerKeyPairIDs</span>
<td> <span class="property-name">cloudCredentialsIDs</span>
</td>
<td> <span class="datatype-reference">array of string
</span>
......@@ -126,7 +126,7 @@ provisioner to request for cloud resources.</p>
<td><span class="property-name">keyValue</span></td>
<td><span class="datatype-reference">map of object
</span></td>
<td><span class="property-description">The key-value map</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
<tr>
......@@ -137,15 +137,13 @@ provisioner to request for cloud resources.</p>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......@@ -159,10 +157,10 @@ object is saved.</span></td>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;cloudCredentialsIDs&quot; : [ &quot;58e3946e0fb4f562d84ba1ad&quot;, &quot;...&quot; ],
&quot;deployerKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;planID&quot; : &quot;ASedsfd46b4fDFd83ba1q&quot;,
&quot;userKeyPairIDs&quot; : [ &quot;ASedsfd46b4fFd344a1A&quot;, &quot;...&quot; ],
&quot;deployerKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;cloudCredentialsIDs&quot; : [ &quot;58e3946e0fb4f562d84ba1ad&quot;, &quot;...&quot; ],
&quot;keyValue&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
......
......@@ -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-commons: ProvisionResponse</title>
<title>drip-api: ProvisionResponse</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: ProvisionResponse</a>
<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>
......@@ -63,7 +64,7 @@
<h1 class="page-header">ProvisionResponse <small>Data Type</small></h1>
<p>This class represents a description of provisioned resources</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -79,18 +80,18 @@
</thead>
<tbody>
<tr>
<td> <span class="property-name">deployParameters</span>
<td> <span class="property-name">cloudKeyPairIDs</span>
</td>
<td> <span class="datatype-reference">array of <a href="json_DeployParameter.html">DeployParameter</a>
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description">The deploy parameters.</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">cloudKeyPairIDs</span>
<td> <span class="property-name">deployParameters</span>
</td>
<td> <span class="datatype-reference">array of string
<td> <span class="datatype-reference">array of <a href="json_DeployParameter.html">DeployParameter</a>
</span>
</td>
<td> <span class="property-description"></span>
......@@ -102,25 +103,25 @@
</tr>
<tbody>
<tr>
<td><span class="property-name">cloudCredentialsIDs</span></td>
<td><span class="property-name">deployerKeyPairIDs</span></td>
<td><span class="datatype-reference">array of string
</span></td>
<td><span class="property-description">The cloud credentials ids required to provision the cloud resources.</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">The ID of the plan <code>PlanResponse</code> to provision for.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">userKeyPairIDs</span></td>
<td><span class="datatype-reference">array of string
</span></td>
<td><span class="property-description">The key pair id for the keys to use to log in the provisioned VMs.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">deployerKeyPairIDs</span></td>
<td><span class="property-name">cloudCredentialsIDs</span></td>
<td><span class="datatype-reference">array of string
</span></td>
<td><span class="property-description"></span></td>
......@@ -134,7 +135,7 @@
<td><span class="property-name">keyValue</span></td>
<td><span class="datatype-reference">map of object
</span></td>
<td><span class="property-description">The key-value map</span></td>
<td><span class="property-description"></span></td>
</tr>
</tbody>
<tr>
......@@ -145,15 +146,13 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......@@ -167,6 +166,7 @@ object is saved.</span></td>
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;cloudKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;deployParameters&quot; : [ {
&quot;IP&quot; : &quot;52.73.245.157&quot;,
&quot;user&quot; : &quot;vm_user&quot;,
......@@ -176,11 +176,10 @@ object is saved.</span></td>
&quot;user&quot; : &quot;...&quot;,
&quot;role&quot; : &quot;...&quot;
} ],
&quot;cloudKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;cloudCredentialsIDs&quot; : [ &quot;58e3946e0fb4f562d84ba1ad&quot;, &quot;...&quot; ],
&quot;deployerKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;planID&quot; : &quot;ASedsfd46b4fDFd83ba1q&quot;,
&quot;userKeyPairIDs&quot; : [ &quot;ASedsfd46b4fFd344a1A&quot;, &quot;...&quot; ],
&quot;deployerKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;cloudCredentialsIDs&quot; : [ &quot;58e3946e0fb4f562d84ba1ad&quot;, &quot;...&quot; ],
&quot;keyValue&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
......
......@@ -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-commons: Script</title>
<title>drip-api: Script</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: Script</a>
<a class="navbar-brand" href="index.html">drip-api: Script</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>
......@@ -63,7 +64,7 @@
<h1 class="page-header">Script <small>Data Type</small></h1>
<p>This class represents a simple script that can run on a provisioned VM.</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -84,7 +85,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The name of the script</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
......@@ -93,7 +94,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The contents of the script</span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......@@ -105,15 +106,13 @@
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</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">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
<td><span class="property-description"></span></td>
</tr>
<tr>
<td><span class="property-name">timestamp</span></td>
......
......@@ -84,7 +84,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The sysbench version</span>
</td>
</tr>
<tr>
......
......@@ -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-commons: User</title>
<title>drip-api: User</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,10 +35,11 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-commons: User</a>
<a class="navbar-brand" href="index.html">drip-api: User</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>
......@@ -63,7 +64,7 @@
<h1 class="page-header">User <small>Data Type</small></h1>
<p>This class represents a user.</p>
<p></p>
<dl class="dl-horizontal">
</dl>
......@@ -93,62 +94,61 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">The unique id of this object. This value is auto-generated when the DAO
saves this object</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">username</span>
<td> <span class="property-name">accountNonLocked</span>
</td>
<td> <span class="datatype-reference">string
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-description">The username</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">accountNonExpired</span>
<td> <span class="property-name">enabled</span>
</td>
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-description">If the account is not expired</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">accountNonLocked</span>
<td> <span class="property-name">accountNonExpired</span>
</td>
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-description">If the account is not locked</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">credentialsNonExpired</span>
<td> <span class="property-name">roles</span>
</td>
<td> <span class="datatype-reference">boolean
<td> <span class="datatype-reference">array of string
</span>
</td>
<td> <span class="property-description">If the credentials are not expired</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">enabled</span>
<td> <span class="property-name">username</span>
</td>
<td> <span class="datatype-reference">boolean
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description">If the account is enabled</span>
<td> <span class="property-description"></span>
</td>
</tr>
<tr>
<td> <span class="property-name">roles</span>
<td> <span class="property-name">credentialsNonExpired</span>
</td>
<td> <span class="datatype-reference">array of string
<td> <span class="datatype-reference">boolean
</span>
</td>
<td> <span class="property-description">The roles assigned to this user.</span>
<td> <span class="property-description"></span>
</td>
</tr>
</tbody>
......@@ -159,12 +159,12 @@ saves this object</span>
<pre class="prettyprint language-js example">{
&quot;password&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;username&quot; : &quot;user&quot;,
&quot;accountNonExpired&quot; : true,
&quot;accountNonLocked&quot; : true,
&quot;credentialsNonExpired&quot; : true,
&quot;enabled&quot; : true,
&quot;roles&quot; : [ &quot;[\&quot;ADMIN\&quot;,\&quot;USER\&quot;]&quot;, &quot;...&quot; ]
&quot;accountNonExpired&quot; : true,
&quot;roles&quot; : [ &quot;[\&quot;ADMIN\&quot;,\&quot;USER\&quot;]&quot;, &quot;...&quot; ],
&quot;username&quot; : &quot;user&quot;,
&quot;credentialsNonExpired&quot; : true
}</pre>
<footer class="footer">
......
This diff is collapsed.
......@@ -76,7 +76,7 @@
<div id="resource_AnsibleOutputController_getByCommand_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible <a href="../user/v1.0/deployer/ansible" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Query AnsibleOutput by executing command.</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -110,6 +110,10 @@
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful query</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -160,12 +164,12 @@ Content-Type: application/json
[ {
&quot;host&quot; : &quot;...&quot;,
&quot;result&quot; : {
&quot;end&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;stdout&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;msg&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;end&quot; : &quot;...&quot;,
&quot;changed&quot; : true,
&quot;delta&quot; : &quot;...&quot;,
&quot;start&quot; : &quot;...&quot;,
&quot;stderr&quot; : &quot;...&quot;
},
......@@ -173,9 +177,9 @@ Content-Type: application/json
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
&quot;cloudProvider&quot; : &quot;...&quot;,
&quot;provisionID&quot; : &quot;...&quot;,
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
} ]
</code>
</pre>
......@@ -187,7 +191,7 @@ Content-Type: application/json
<div id="resource_AnsibleOutputController_deleteAll_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/deployer/ansible/all <a href="../user/v1.0/deployer/ansible/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Deletes all entries. Use with caution !</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -203,6 +207,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful delete</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -246,7 +254,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -261,7 +269,7 @@ Content-Type: application/json
<div id="resource_AnsibleOutputController_getCommands_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible/commands <a href="../user/v1.0/deployer/ansible/commands" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Query for used (unique) commands</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -277,6 +285,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful query</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -335,7 +347,7 @@ Content-Type: application/json
<div id="resource_AnsibleOutputController_getIds_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible/ids <a href="../user/v1.0/deployer/ansible/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Returns the ids of stored objects. Empty list if non stored</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -351,6 +363,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful query</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -409,7 +425,7 @@ Content-Type: application/json
<div id="resource_AnsibleOutputController_delete_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/deployer/ansible/{id} <a href="../user/v1.0/deployer/ansible/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Deletes object</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -443,6 +459,14 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful delete</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">Non existing id</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -486,7 +510,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -501,7 +525,7 @@ Content-Type: application/json
<div id="resource_AnsibleOutputController_get_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible/{id} <a href="../user/v1.0/deployer/ansible/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Returns an AnsibleOutput.</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -535,6 +559,14 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">AnsibleOutput not found</span></td>
</tr>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">AnsibleOutput exists</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -585,12 +617,12 @@ Content-Type: application/json
{
&quot;host&quot; : &quot;...&quot;,
&quot;result&quot; : {
&quot;end&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;stdout&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;msg&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;end&quot; : &quot;...&quot;,
&quot;changed&quot; : true,
&quot;delta&quot; : &quot;...&quot;,
&quot;start&quot; : &quot;...&quot;,
&quot;stderr&quot; : &quot;...&quot;
},
......@@ -598,9 +630,9 @@ Content-Type: application/json
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
&quot;cloudProvider&quot; : &quot;...&quot;,
&quot;provisionID&quot; : &quot;...&quot;,
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......
......@@ -70,12 +70,13 @@
<h1 class="page-header">BenchmarkController <small>Resource</small></h1>
<p>This controller is responsible for handling cloud benchmark tests like sysbench</p>
<p>This controller is responsible for handling cloud benchmark tests like
sysbench</p>
<div id="resource_BenchmarkController_getBySysbench_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/benchmark <a href="../user/v1.0/benchmark" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Returns sysbench results only. Not Not supported yet</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -91,6 +92,10 @@
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful query</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -139,15 +144,15 @@ Content-Type: application/json
<code class="prettyprint language-js">
[ {
&quot;start&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;vmType&quot; : &quot;...&quot;,
&quot;host&quot; : &quot;...&quot;,
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
&quot;end&quot; : &quot;...&quot;,
&quot;start&quot; : &quot;...&quot;,
&quot;timestamp&quot; : 12345,
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
&quot;host&quot; : &quot;...&quot;,
&quot;vmType&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
} ]
</code>
</pre>
......@@ -159,7 +164,7 @@ Content-Type: application/json
<div id="resource_BenchmarkController_deleteAll_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/benchmark/all <a href="../user/v1.0/benchmark/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Deletes all entries. Use with caution !</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -175,6 +180,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful delete</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -218,7 +227,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -233,7 +242,7 @@ Content-Type: application/json
<div id="resource_BenchmarkController_getIds_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/benchmark/ids <a href="../user/v1.0/benchmark/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Returns the ids of stored objects. Empty list if non stored</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -249,6 +258,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful query</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -307,7 +320,7 @@ Content-Type: application/json
<div id="resource_BenchmarkController_delete_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/benchmark/{id} <a href="../user/v1.0/benchmark/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Deletes object</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -341,6 +354,14 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful delete</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">Non existing id</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -384,7 +405,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -399,7 +420,7 @@ Content-Type: application/json
<div id="resource_BenchmarkController_get_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/benchmark/{id} <a href="../user/v1.0/benchmark/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Returns a BenchmarkResult</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -433,6 +454,14 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">BenchmarkResult not found</span></td>
</tr>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">BenchmarkResult exists</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -481,15 +510,15 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;start&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;vmType&quot; : &quot;...&quot;,
&quot;host&quot; : &quot;...&quot;,
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
&quot;end&quot; : &quot;...&quot;,
&quot;start&quot; : &quot;...&quot;,
&quot;timestamp&quot; : 12345,
&quot;cloudDeploymentDomain&quot; : &quot;...&quot;,
&quot;host&quot; : &quot;...&quot;,
&quot;vmType&quot; : &quot;...&quot;,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......
......@@ -113,7 +113,7 @@ provisoner to request for resources (VMs)</p>
</thead>
<tbody>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">Access key ID can't be empty</span></td>
</tr>
<tr>
......@@ -163,16 +163,16 @@ Accept: application/json
<code class="prettyprint language-js">
{
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......@@ -195,7 +195,7 @@ Content-Type: application/json
<div id="resource_CloudCredentialsController_deleteAll_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/credentials/cloud/all <a href="../user/v1.0/credentials/cloud/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Deletes all credentials. Use with caution !</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -211,6 +211,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Credentiasl exist</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -254,7 +258,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -285,6 +289,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Credentials exist</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -409,16 +417,16 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......@@ -464,6 +472,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Credential exists</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -509,7 +521,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -558,6 +570,14 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">Credential not found</span></td>
</tr>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Credential exists</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -608,16 +628,16 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
&quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
&quot;cloudProviderName&quot; : &quot;ec2&quot;,
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......@@ -669,6 +689,18 @@ be created</p>
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">Credential not found</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="response-condition">Did not upload file</span></td>
</tr>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Key added to credential</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -714,7 +746,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......
......@@ -77,7 +77,7 @@ used by the planner.</p>
<div id="resource_ConfigurationController_deleteAll_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/deployer/configuration/all <a href="../user/v1.0/deployer/configuration/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p>Gets the IDs of all the stored PlayBook descriptions.</p>
<p>Deletes all entries. Use with caution !</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -93,6 +93,10 @@ used by the planner.</p>
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful delete</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -106,7 +110,6 @@ used by the planner.</p>
<tr>
<th>media type</th>
<th>data type</th>
<th>description</th>
</tr>
</thead>
<tbody>
......@@ -114,7 +117,6 @@ used by the planner.</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">a list of all the IDs</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>
......@@ -138,7 +140,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -169,6 +171,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful query</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -229,7 +235,7 @@ Content-Type: application/json
<div id="resource_ConfigurationController_post_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/user/v1.0/deployer/configuration/post <a href="../user/v1.0/deployer/configuration/post" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
<p></p>
<p>Post a deployment configuration.</p>
<dl class="dl-horizontal">
<dt>Security Roles Allowed</dt>
......@@ -267,6 +273,14 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful post</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="response-condition">contents are not valid (e.g. not a yaml format)</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -314,7 +328,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -363,6 +377,14 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful upload</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="response-condition">Didn't upload (multipart) file or contents are not valid (e.g. not a yaml format)</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -408,7 +430,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 201 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -457,6 +479,10 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Successful delete</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......@@ -502,7 +528,7 @@ Accept: application/json
<div class="col-md-6">
<h5>Response</h5>
<pre>
HTTP/1.1 204 Looks Good
HTTP/1.1 200 Looks Good
Content-Type: application/json
<code class="prettyprint language-txt">
......@@ -556,6 +582,18 @@ Content-Type: application/json
</tr>
</thead>
<tbody>
<tr>
<td><span class="label label-success response-code">200</span></td>
<td><span class="response-condition">Object found</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">400</span></td>
<td><span class="response-condition">contents are not valid (e.g. not a yaml format)</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">404</span></td>
<td><span class="response-condition">Object not found</span></td>
</tr>
<tr>
<td><span class="label label-warning response-code">401</span></td>
<td><span class="response-condition">Bad credentials</span></td>
......
This diff is collapsed.
......@@ -126,9 +126,9 @@ Accept: text/xml
<code class="prettyprint language-xml">
&lt;deploy&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;action&gt;58c2c2f3a8d4b56889878d03&lt;/action&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;/deploy&gt;
</code>
......@@ -142,9 +142,9 @@ Content-Type: text/xml
<code class="prettyprint language-xml">
&lt;result&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;status&gt;Success&lt;/status&gt;
&lt;info&gt;INFO&lt;/info&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;/result&gt;
</code>
......@@ -210,9 +210,9 @@ Accept: text/xml
<code class="prettyprint language-xml">
&lt;deploy&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;action&gt;58c2c2f3a8d4b56889878d03&lt;/action&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;/deploy&gt;
</code>
......@@ -226,9 +226,9 @@ Content-Type: text/xml
<code class="prettyprint language-xml">
&lt;result&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;status&gt;Success&lt;/status&gt;
&lt;info&gt;INFO&lt;/info&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;/result&gt;
</code>
......
......@@ -310,11 +310,11 @@ Accept: application/json
<code class="prettyprint language-js">
{
&quot;vmUserName&quot; : &quot;vm_user&quot;,
&quot;toscaID&quot; : &quot;592d5884e452f1b9b666a657&quot;,
&quot;osType&quot; : &quot;Ubuntu16.04&quot;,
&quot;cloudProvider&quot; : &quot;egi&quot;,
&quot;managerType&quot; : &quot;swarm&quot;,
&quot;toscaID&quot; : &quot;592d5884e452f1b9b666a657&quot;,
&quot;vmUserName&quot; : &quot;vm_user&quot;,
&quot;domain&quot; : &quot;us-east-1&quot;
}
</code>
......
......@@ -125,10 +125,10 @@ Accept: text/xml
<code class="prettyprint language-xml">
&lt;plan&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;file&gt;tosca_definitions_version: tosca_simple_yaml_1_0\n\n\ndescription: example file for infrastructure planner\n\n\nrepositories:\n MOG_docker_hub: \n description: MOG project’s code repository in GitHub\n url: https://github.com/switch-project/mog\n credential:\n protocol: xauth\n token_type: X-Auth-Token\n # token encoded in Base64\n token: 604bbe45ac7143a79e14f3158df67091\n\n\nartifact_types:\n tosca.artifacts.Deployment.Image.Container.Docker:\n derived_from: tosca.artifacts.Deployment.Image\n\n\ndata_types:\n Switch.datatypes.QoS.AppComponent:\n derived_from: tosca.datatypes.Root\n properties:\n response_time:\n type: string\n\n Switch.datatypes.Application.Connection.EndPoint:\n derived_from: tosca.datatypes.Root\n properties:\n address:\n type: string\n component_name:\n type: string\n netmask:\n type: string\n port_name:\n type: string\n\n Switch.datatypes.Application.Connection.Multicast:\n derived_from: tosca.datatypes.Root\n properties:\n multicastAddrIP:\n type: string\n multicastAddrPort:\n type: integer\n\n Switch.datatypes.Network.EndPoint:\n derived_from: tosca.datatypes.Root\n properties:\n address:\n type: string\n host_name:\n type: string\n netmask:\n type: string\n port_name:\n type: string\n\n Switch.datatypes.Network.Multicast:\n derived_from: tosca.datatypes.Root\n properties:\n multicastAddrIP:\n type: string\n multicastAddrPort:\n type: integer\n\n\nnode_types:\n\n Switch.nodes.Application.Container.Docker:\n derived_from: tosca.nodes.Container.Application\n properties:\n QoS:\n type: Switch.datatypes.QoS.AppComponent\n artifacts:\n docker_image:\n type: tosca.artifacts.Deployment.Image.Container.Docker\n interfaces:\n Standard:\n create:\n inputs:\n command:\n type: string\n exported_ports:\n type: list\n entry_schema:\n type: string\n port_bindings:\n type: list\n entry_schema:\n type: string\n\n Switch.nodes.Application.Container.Docker.MOG.InputDistributor:\n derived_from: Switch.nodes.Application.Container.Docker\n artifacts:\n docker_image:\n type: tosca.artifacts.Deployment.Image.Container.Docker\n file: &quot;mogswitch/InputDistributor:1.0&quot;\n repository: MOG_docker_hub\n properties:\n inPort: \n type: integer\n waitingTime:\n type: integer\n multicastAddrIP:\n type: string\n multicastAddrPort:\n type: integer\n videoWidth:\n type: integer\n videoHeight:\n type: integer\n\n Switch.nodes.Application.Container.Docker.MOG.ProxyTranscoder:\n derived_from: Switch.nodes.Application.Container.Docker \n artifacts:\n docker_image:\n type: tosca.artifacts.Deployment.Image.Container.Docker\n file: &quot;mogswitch/ProxyTranscoder:1.0&quot;\n repository: MOG_docker_hub\n properties:\n multicastAddrIP: \n type: string\n multicastAddrPort:\n type: integer\n videoWidth:\n type: integer\n videoHeight:\n type: integer\n\n Switch.nodes.Application.Connection:\n derived_from: tosca.nodes.Root \n properties:\n source:\n type: Switch.datatypes.Application.Connection.EndPoint\n target:\n type: Switch.datatypes.Application.Connection.EndPoint\n bandwidth:\n type: string\n latency: \n type: string\n jitter: \n type: string\n multicast:\n type: Switch.datatypes.Application.Connection.Multicast\n\n Switch.nodes.Compute:\n derived_from: tosca.nodes.Compute\n properties:\n OStype:\n type: string\n nodetype:\n type: string\n domain:\n type: string\n public_address:\n type: string\n
ethernet_port:\n type: list\n entry_schema:\n type: tosca.datatypes.network.NetworkInfo\n script:\n type: string\n installation:\n type: string\n ssh_credential:\n type: tosca.datatypes.Credential\n\n Switch.nodes.Network:\n derived_from: tosca.nodes.network.Network\n properties:\n bandwidth:\n type: string\n latency:\n type: string\n jitter:\n type: string\n source:\n type: Switch.datatypes.Network.EndPoint\n target:\n type: Switch.datatypes.Network.EndPoint\n multicast:\n type: Switch.datatypes.Network.Multicast\n\n\ntopology_template:\n \n node_templates:\n 2d13d708e3a9441ab8336ce874e08dd1:\n type: Switch.nodes.Application.Container.Docker.MOG.InputDistributor\n artifacts:\n docker_image:\n file: &quot;mogswitch/InputDistributor:1.0&quot;\n type: tosca.artifacts.Deployment.Image.Container.Docker\n repository: MOG_docker_hub\n properties:\n QoS:\n response_time: 30ms\n inPort: 2000\n waitingTime: 5\n multicastAddrIP: 255.2.2.0\n multicastAddrPort: 3000\n videoWidth: 176\n videoHeight: 100\n interfaces:\n Standard:\n create:\n implementation: docker_image\n inputs:\n command: InputDistributor\n exported_ports:\n - 2000\n port_bindings:\n - &quot;2000:2000&quot;\n - &quot;3000:3000&quot;\n\n 8fcc1788d9ee462c826572c79fdb2a6a:\n type: Switch.nodes.Application.Container.Docker.MOG.ProxyTranscoder\n artifacts:\n docker_image:\n file: &quot;mogswitch/ProxyTranscoder:1.0&quot;\n type: tosca.artifacts.Deployment.Image.Container.Docker\n repository: MOG_docker_hub\n properties:\n QoS:\n response_time: 30ms\n multicastAddrIP: 255.2.2.0\n multicastAddrPort: 3000\n videoWidth: 176\n videoHeight: 100\n interfaces:\n Standard:\n create:\n implementation: docker_image\n inputs:\n command: ProxyTranscoder\n exported_ports:\n - 80\n port_bindings:\n - &quot;8080:80&quot;\n\n 5e0add703c8a43938a39301f572e46c0:\n type: Switch.nodes.Application.Connection\n properties:\n source:\n address: 192.168.21.11\n component_name: 2d13d708e3a9441ab8336ce874e08dd1\n netmask: 255.255.255.0\n port_name: &quot;inputDistributor_out&quot;\n target:\n address: 192.168.21.12\n component_name: 8fcc1788d9ee462c826572c79fdb2a6a\n netmask: 255.255.255.0\n port_name: &quot;proxyTranscoder_in&quot;\n latency: 30ms\n bandwidth: 130MB/s\n jitter: 500ms\n multicast:\n multicastAddrIP: 255.2.2.0\n multicastAddrPort: 3000\n&lt;/file&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;/plan&gt;
</code>
......@@ -142,9 +142,9 @@ Content-Type: text/xml
<code class="prettyprint language-xml">
&lt;result&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;status&gt;Success&lt;/status&gt;
&lt;info&gt;INFO&lt;/info&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;/result&gt;
</code>
......
......@@ -316,9 +316,9 @@ Accept: application/json
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......@@ -413,9 +413,9 @@ Content-Type: application/json
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......@@ -605,6 +605,7 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
&quot;cloudKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;deployParameters&quot; : [ {
&quot;IP&quot; : &quot;52.73.245.157&quot;,
&quot;user&quot; : &quot;vm_user&quot;,
......@@ -614,7 +615,6 @@ Content-Type: application/json
&quot;user&quot; : &quot;...&quot;,
&quot;role&quot; : &quot;...&quot;
} ],
&quot;cloudKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;deployerKeyPairIDs&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;planID&quot; : &quot;ASedsfd46b4fDFd83ba1q&quot;,
&quot;userKeyPairIDs&quot; : [ &quot;ASedsfd46b4fFd344a1A&quot;, &quot;...&quot; ],
......@@ -623,9 +623,9 @@ Content-Type: application/json
&quot;property1&quot; : { },
&quot;property2&quot; : { }
},
&quot;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......
......@@ -126,9 +126,9 @@ Accept: text/xml
<code class="prettyprint language-xml">
&lt;execute&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;action&gt;58c2c2f3a8d4b56889878d03&lt;/action&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;/execute&gt;
</code>
......@@ -142,9 +142,9 @@ Content-Type: text/xml
<code class="prettyprint language-xml">
&lt;result&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;status&gt;Success&lt;/status&gt;
&lt;info&gt;INFO&lt;/info&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;/result&gt;
</code>
......@@ -216,8 +216,8 @@ Accept: application/json
<code class="prettyprint language-xml">
&lt;upload&gt;
&lt;user&gt;...&lt;/user&gt;
&lt;pwd&gt;...&lt;/pwd&gt;
&lt;file level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/file&gt;
&lt;pwd&gt;...&lt;/pwd&gt;
&lt;/upload&gt;
</code>
......
......@@ -159,9 +159,9 @@ Accept: application/json
{
&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;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......@@ -395,9 +395,9 @@ Content-Type: application/json
{
&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;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......@@ -681,9 +681,9 @@ Content-Type: application/json
{
&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;timestamp&quot; : 12345,
&quot;owner&quot; : &quot;user1&quot;,
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
&quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
&quot;timestamp&quot; : 12345
}
</code>
</pre>
......
This diff is collapsed.
......@@ -129,8 +129,8 @@ Accept: application/json
<code class="prettyprint language-xml">
&lt;register&gt;
&lt;pwd&gt;123abc&lt;/pwd&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;pwd&gt;123abc&lt;/pwd&gt;
&lt;/register&gt;
</code>
......
......@@ -132,9 +132,9 @@ Accept: application/json
<code class="prettyprint language-xml">
&lt;confUserKey&gt;
&lt;userKey level=&quot;0&quot; name=&quot;planner_output_all&quot;&gt;...&lt;/userKey&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;action&gt;58c2c2f3a8d4b56889878d03&lt;/action&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;/confUserKey&gt;
</code>
......
......@@ -131,9 +131,9 @@ Accept: application/json
<code class="prettyprint language-xml">
&lt;confScript&gt;
&lt;script&gt;#!/bin/bash\n\nlogstashScript=/root/runLogstash.sh\nscreen -S logstash -dm /bin/bash &quot;$logstashScript&quot;\n\n\nlogLevelPath=/root/\nlogLevelFile=$logLevelPath/logstash_loglevel.csv\nremotePath=/media/lobcder/skoulouz/\nremoteLogPath=$remotePath/logs\nlocalLogPath=/root/logs\n\nmkdir $localLogPath\n\n\nfor logArchPath in $remoteLogPath/*.gz; do\n echo &quot;File -&amp;gt; $logArchPath&quot;\n if [ ! -f $logArchPath.lock ]; then\n touch $logArchPath.lock\n cp $logArchPath $localLogPath\n logArchName=$(basename $logArchPath)\n tar -xvf $localLogPath/$logArchName -C $localLogPath\n sleep 120\n modTime=-100\n while [ ! -f $logLevelFile ]\n do\n sleep 5\n done\n while [ $modTime -lt 120 ]\n do\n moddate=$(stat -c %Y $logLevelFile)\n moddate=${moddate%% *}\n now=$(date +%s)\n modTime=&quot;$(( $now - $moddate))&quot;\n echo $modTime\n sleep 5\n done\n rm $localLogPath/*.tar.gz\n rm $localLogPath/*.log\n modTime=-100\n fi\ndone\n \n\nscreen -X -S logstash quit\nsleep 5\n\nuid=`ifconfig | grep eth0 | awk &#39;{print $NF}&#39; | sed &#39;s/://g&#39;`\n\nfor csvFiles in $logLevelPath/*.csv; do\n echo $csvFiles $csvFiles$uid.csv\n mv $csvFiles $csvFiles$uid.csv\n cp $csvFiles$uid.csv $remotePath\ndone\n\nkillall java \n&lt;/script&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;user&gt;user&lt;/user&gt;
&lt;action&gt;58c2c2f3a8d4b56889878d03&lt;/action&gt;
&lt;pwd&gt;123&lt;/pwd&gt;
&lt;/confScript&gt;
</code>
......
......@@ -108,7 +108,8 @@
</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></ul></td>
<td> <span class="resource-description">This controller is responsible for handling cloud benchmark tests like sysbench</span>
<td> <span class="resource-description">This controller is responsible for handling cloud benchmark tests like
sysbench</span>
</td>
</tr>
<tr class="clickable-row" data-href="resource_CloudConfigurationController0.html">
......
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.
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.
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.
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.
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.
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