Skip to content

C
CONF
Switch branch/tag
Find file
Normal viewHistoryPermalink
json_DeployParameter.html 5.41 KB
Newer Older
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 
<!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: DeployParameter</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: 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>
      </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_DeployParameter.html">DeployParameter</a></li>
        </ol>

      <h1 class="page-header">DeployParameter <small>Data Type</small></h1>
Spiros Koulouzis's avatar
Update documentation
f02552da
 
Spiros Koulouzis committed
67 68 69 
      <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>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 

      <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">cloudCertificateName</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Update documentation
f02552da
 
Spiros Koulouzis committed
90 91 
          <td>  <span class="property-description">The file name of the certificate used to log in as root to the
provisioned VM.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
92 93 94 95 96 97 98 99 
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">IP</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Update documentation
f02552da
 
Spiros Koulouzis committed
100 
          <td>  <span class="property-description">The public IP of the provisioned VM</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
101 102 103 104 105 106 107 108 
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">user</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Update documentation
f02552da
 
Spiros Koulouzis committed
109 
          <td>  <span class="property-description">The user name of the account created on the provisioned VM</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
110 111 112 113 114 115 116 117 
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">role</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Update documentation
f02552da
 
Spiros Koulouzis committed
118 
          <td>  <span class="property-description">The role of the provisioned VM</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
119 120 121 122 123 124 125 126 
</td>
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Update documentation
f02552da
 
Spiros Koulouzis committed
127 128 129 130 
  &quot;cloudCertificateName&quot; : &quot;Virginia&quot;,
  &quot;IP&quot; : &quot;52.73.245.157&quot;,
  &quot;user&quot; : &quot;vm_user&quot;,
  &quot;role&quot; : &quot;slave&quot;
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 
}</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>