Skip to content

C
CONF
Switch branch/tag
Find file
Normal viewHistoryPermalink
syntax_xml.html 10.9 KB
Newer Older
Spiros Koulouzis's avatar
buid doc
7c82c236
 
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 
<!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 -->
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
9 
  <title>drip-api: XML</title>
Spiros Koulouzis's avatar
buid doc
7c82c236
 
Spiros Koulouzis committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 

  <!-- 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>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
38 
        <a class="navbar-brand" href="index.html">drip-api: XML</a>
Spiros Koulouzis's avatar
buid doc
7c82c236
 
Spiros Koulouzis committed
39 40 41 
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
42 
          <li><a href="resources.html">Resources</a></li>
Spiros Koulouzis's avatar
buid doc
7c82c236
 
Spiros Koulouzis committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 
          <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="dropdown"><a href="syntax_xml.html">XML</a></li>
        </ol>

  <h1 class="page-header">XML</h1>

  <table class="table table-hover datatypes">
  <caption>Default Namespace  (<a href="ns0.xsd">schema</a>)</caption>
  <thead>
    <tr>
      <th align="center">type</th>
      <th align="center">description</th>
    </tr>
  </thead>
  <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="xml_ns0_attribute.html">
      <td>  <span class="datatype-name">attribute</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_confScript.html">
      <td>  <span class="datatype-name">confScript</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_confUserKey.html">
      <td>  <span class="datatype-name">confUserKey</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_configure.html">
      <td>  <span class="datatype-name">configure</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deploy.html">
      <td>  <span class="datatype-name">deploy</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_execute.html">
      <td>  <span class="datatype-name">execute</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_loginKey0.html">
      <td>  <span class="datatype-name">loginKey0</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_plan.html">
      <td>  <span class="datatype-name">plan</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
120 
      <td>  <span class="datatype-description">This class represents a plan to be provided to the planner.</span>
Spiros Koulouzis's avatar
buid doc
7c82c236
 
Spiros Koulouzis committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_register.html">
      <td>  <span class="datatype-name">register</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_result.html">
      <td>  <span class="datatype-name">result</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_upload.html">
      <td>  <span class="datatype-name">upload</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
139 140 141 142 143 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_cloudCredentials.html">
      <td>  <span class="datatype-name">cloudCredentials</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
144 145 
      <td>  <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
146 147 148 149 150 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
      <td>  <span class="datatype-name">deployParameter</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
151 152 153 
      <td>  <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
154 155 156 157 158 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployRequest.html">
      <td>  <span class="datatype-name">deployRequest</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
159 160 
      <td>  <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
161 162 163 164 165 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
      <td>  <span class="datatype-name">deployResponse</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
166 167 168 
      <td>  <span class="datatype-description">This class represents the response of a deploy request. It may hold a key
pair used for logging in and managing a docker cluster. Currently they key
pair is only used by kubernetes</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
169 170 171 172 173 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_key.html">
      <td>  <span class="datatype-name">key</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
174 175 176 
      <td>  <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
177 178 179 180 181 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyType.html">
      <td>  <span class="datatype-name">keyType</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
182 
      <td>  <span class="datatype-description">This enu specifies if a key is private or public</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
183 184 185 186 187 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyPair.html">
      <td>  <span class="datatype-name">keyPair</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
188 189 
      <td>  <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for
logging in VMs.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
190 191 192 193 194 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
      <td>  <span class="datatype-name">keyValueHolder</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
195 196 
      <td>  <span class="datatype-description">This is a generic class that hold key-value pairs. It's main usage is to hold
abstract types such as TOSCA.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
197 198 199 200 201 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
      <td>  <span class="datatype-name">ownedObject</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
202 203 
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
204 205 206 207 208 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_planRequest.html">
      <td>  <span class="datatype-name">planRequest</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
209 
      <td>  <span class="datatype-description">This class represents a plan request sent to the planner.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
210 211 212 213 214 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionRequest.html">
      <td>  <span class="datatype-name">provisionRequest</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
215 216 
      <td>  <span class="datatype-description">This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
217 218 219 220 221 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionResponse.html">
      <td>  <span class="datatype-name">provisionResponse</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
222 
      <td>  <span class="datatype-description">This class represents a description of provisioned resources</span>
Spiros Koulouzis's avatar
added scale for swarm
82555249
 
Spiros Koulouzis committed
223 224 
</td>
    </tr>
Spiros Koulouzis's avatar
implementing vm scaling. We hit null pointer exception at EGISEngine line 654
5f3f8698
 
Spiros Koulouzis committed
225 226 
    <tr class="clickable-row" data-href="xml_ns0_scaleRequest.html">
      <td>  <span class="datatype-name">scaleRequest</span>
Spiros Koulouzis's avatar
added scale for swarm
82555249
 
Spiros Koulouzis committed
227 228 229 
</td>
      <td>  <span class="datatype-description">This class represents a scale request for a deployment. At the moment we only
support swarm.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
230 231 232 233 234 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_script.html">
      <td>  <span class="datatype-name">script</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
235 
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
236 237 238 239 240 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_user.html">
      <td>  <span class="datatype-name">user</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
241 
      <td>  <span class="datatype-description">This class represents a user.</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
242 243 244 245 246 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_ansibleOutput.html">
      <td>  <span class="datatype-name">ansibleOutput</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
247 248 
      <td>  <span class="datatype-description">This class represents the the ansible out put for a specific VM. This can be
used as a archive / log of ansible executions</span>
Spiros Koulouzis's avatar
documentation
ac02a630
 
Spiros Koulouzis committed
249 250 251 252 253 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_benchmarkResult.html">
      <td>  <span class="datatype-name">benchmarkResult</span>
</td>
Spiros Koulouzis's avatar
post provision
fbef3be4
 
Spiros Koulouzis committed
254 255 
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
buid doc
7c82c236
 
Spiros Koulouzis committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 
</td>
    </tr>
  </tbody>
  </table>

        <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>