Commit 0d5485e0 authored by Spiros Koulouzis's avatar Spiros Koulouzis

documentation

parent df29599c
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.
......@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>drip-api: AnsibleOutput</title>
<title>drip-commons: AnsibleOutput</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,11 +35,10 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: AnsibleOutput</a>
<a class="navbar-brand" href="index.html">drip-commons: 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>
......@@ -64,7 +63,8 @@
<h1 class="page-header">AnsibleOutput <small>Data Type</small></h1>
<p></p>
<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>
<dl class="dl-horizontal">
</dl>
......@@ -139,20 +139,22 @@
</tr>
<tbody>
<tr>
<td><span class="property-name">timestamp</span></td>
<td><span class="datatype-reference">number
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</span></td>
</tr>
<tr>
<td><span class="property-name">id</span></td>
<td><span class="datatype-reference">string
</span></td>
<td><span class="property-description"></span></td>
<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>
</tr>
<tr>
<td><span class="property-name">owner</span></td>
<td><span class="datatype-reference">string
<td><span class="property-name">timestamp</span></td>
<td><span class="datatype-reference">number
</span></td>
<td><span class="property-description"></span></td>
</tr>
......@@ -164,22 +166,22 @@
<pre class="prettyprint language-js example">{
&quot;host&quot; : &quot;...&quot;,
&quot;result&quot; : {
&quot;stderr&quot; : &quot;...&quot;,
&quot;delta&quot; : &quot;...&quot;,
&quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
&quot;stdout&quot; : &quot;...&quot;,
&quot;msg&quot; : &quot;...&quot;,
&quot;changed&quot; : true,
&quot;start&quot; : &quot;...&quot;,
&quot;end&quot; : &quot;...&quot;,
&quot;msg&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;vmType&quot; : &quot;...&quot;,
&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;owner&quot; : &quot;user1&quot;
&quot;timestamp&quot; : 12345
}</pre>
<footer class="footer">
......
This diff is collapsed.
This diff is collapsed.
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-api: DeployParameter</title>
<title>drip-commons: DeployParameter</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
......@@ -35,11 +35,10 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">drip-api: DeployParameter</a>
<a class="navbar-brand" href="index.html">drip-commons: 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>
......@@ -64,7 +63,9 @@
<h1 class="page-header">DeployParameter <small>Data Type</small></h1>
<p></p>
<p>This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</p>
<dl class="dl-horizontal">
</dl>
......@@ -80,21 +81,21 @@
</thead>
<tbody>
<tr>
<td> <span class="property-name">user</span>
<td> <span class="property-name">IP</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The public IP of the provisioned VM</span>
</td>
</tr>
<tr>
<td> <span class="property-name">IP</span>
<td> <span class="property-name">user</span>
</td>
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The user name of the account created on the provisioned VM</span>
</td>
</tr>
<tr>
......@@ -103,7 +104,7 @@
<td> <span class="datatype-reference">string
</span>
</td>
<td> <span class="property-description"></span>
<td> <span class="property-description">The role of the provisioned VM</span>
</td>
</tr>
</tbody>
......@@ -112,8 +113,8 @@
<p class="lead">Example</p>
<pre class="prettyprint language-js example">{
&quot;user&quot; : &quot;vm_user&quot;,
&quot;IP&quot; : &quot;52.73.245.157&quot;,
&quot;user&quot; : &quot;vm_user&quot;,
&quot;role&quot; : &quot;slave&quot;
}</pre>
......
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