Merge lp:~gz/juju-core/docs-reference-constraints into lp:juju-core/docs

[Martin Packman]

First pass reference documentation for constraints.

There may be some style issues that need fixing, as I only eyeballed in lynx
to sanity check the markup.

Included previous, unimplemented constraints as we should get to their
equivalents in juju-core sooner rather than later.

Also corrected a few issues with the current constraints howto by just
deleting some incorrect statements (maas-name is not implemented, and so on).

[Nick Veitch (evilnick)]

I changed a few bits in the nav and fixed the styles, but otherwise thanks very much!

=== modified file 'htmldocs/charms-constraints.html'
--- htmldocs/charms-constraints.html	2013-08-23 15:56:11 +0000
+++ htmldocs/charms-constraints.html	2013-08-30 17:36:09 +0000
@@ -91,20 +91,12 @@
               
               <h1>Provider Constraints</h1>
 
-              <p>The constraints available vary by provider, but should include:</p> 
-              
-              <ul>
-              <li><span class="pre">cpu-cores</span>: The minimum processing power of the machine, measured in <a class="reference external" href="http://en.wikipedia.org/wiki/Amazon_Elastic_Compute_Cloud#Elastic_compute_units">ECU</a>,defaulting to 1; any real number &gt;= 0 is valid.</li> 
-              <li><span class="pre">mem</span>: The minimum memory for the machine, defaulting to 512MB; any real number &gt;= 0, and optionally suffixed with M, G or T is valid.</li>
-              <li><span class="pre">arch</span>: The machine's processor architecture, defaulting to &quot;amd64&quot;. Valid values are &quot;i386&quot;, &quot;amd64&quot;, and &quot;arm&quot;.</li>
-              
-              </ul>
-              
-              <p>The currently available MAAS constraint is:</p>
-              
-              <ul>
-              <li><span class="pre">maas-name</span>: The MAAS name to which each unit must be deployed. This is philosophically problematic, on the basis that teaching users that it's OK to specify single machines will lead them to pain when they attempt to scale out large deployments; but it's justified on the basis that MAAS itself needs to act as a stepping stone between the &quot;metal&quot; and &quot;cloud&quot; mindsets. <span class="pre">maas-name</span> is unset by default, and should correspond to a name known by the MAAS provider.</li>
-              </ul>
+	      <p>See a <a href="reference-constraints.html">complete listing of constraints</a> for details on what each constraint means. Two of the most commonly used are:</p>
+              
+              <ul>
+              <li><span class="pre">cpu-cores</span>: The minimum processing power of the machine, roughly indicated by how many cores are available.</li>
+              <li><span class="pre">mem</span>: The minimum memory for the machine, defaulting to 512MB.</li>
+
               <p class="note"><strong> Note: </strong> The <span class="pre">instance-type</span> constraint is not currently supported by juju-core, but support will be added soon. Some of the following examples make use of this setting merely to illustrate a point. </p>
             
               

=== modified file 'htmldocs/navigation.html'
--- htmldocs/navigation.html	2013-08-22 13:48:21 +0000
+++ htmldocs/navigation.html	2013-08-30 17:36:09 +0000
@@ -37,6 +37,7 @@
             <h1>Reference</h1>
             <ul>
               <li class="sub"><a href="commands.html">Juju commands</a></li>
+              <li class="sub"><a href="reference-constraints.html">Constraints Listing</a></li>
               <li class="sub"><a href="glossary.html">Glossary</a></li>
               <li class="sub"><a href="contributing.html">Contribute to the Docs!</a></li>
             </ul>

=== modified file 'htmldocs/navigation.json'
--- htmldocs/navigation.json	2013-08-16 13:29:42 +0000
+++ htmldocs/navigation.json	2013-08-30 17:36:09 +0000
@@ -51,6 +51,7 @@
   "References": {
     "children": {
       "Juju Commands": "commands.html",
+      "Constraints Listing": "reference-constraints.html",
       "Glossary": "glossary.html",
       "Contribute to the Docs!": "contributing.html"
     }

=== added file 'htmldocs/reference-constraints.html'
--- htmldocs/reference-constraints.html	1970-01-01 00:00:00 +0000
+++ htmldocs/reference-constraints.html	2013-08-30 17:36:09 +0000
@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+<html>
+  <head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>Juju Documentation - Constraints Reference</title>
+  <link href='https://fonts.googleapis.com/css?family=Ubuntu:400,300,300italic,400italic,700,700italic|Ubuntu+Mono' rel='stylesheet' type='text/css' />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/reset.css" />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/960.css" />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/base.css" />
+  <link rel="stylesheet" type="text/css" media="screen" href="//juju.ubuntu.com/wp-content/themes/juju-website/css/home-new.css" />
+  <link rel='stylesheet' id='stacktack-css'  href='//juju.ubuntu.com/wp-content/plugins/stacktack/css/stacktack.min.css?ver=3.4.2' type='text/css' media='all' />
+  <link href="css/main.css?1375975745" rel="stylesheet" type="text/css"/>
+
+  <!--[if lt IE 9]>
+  <script type="text/javascript" src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+  <body class="resources">
+    <header class="global clearfix" role="banner">
+  <div class="header-navigation">
+    <div>
+      <nav role="navigation">
+        <ul>
+          <li class="page_item page-item-6"><a href="https://juju.ubuntu.com/">Home</a></li>
+          <li class="page_item page-item-7"><a href="https://juju.ubuntu.com/get-started/">Get started</a></li>
+          <li class="page_item page-item-9 current_page_item"><a href="https://juju.ubuntu.com/resources/">Resources</a></li>
+          <li class="page_item page-item-13"><a href="https://juju.ubuntu.com/community/">Community</a></li>
+          <li class="page_item page-item-3688"><a href="https://juju.ubuntu.com/charm-store/">Charm Store</a></li>
+          <li class="page_item page-item-3691"><a href="https://juju.ubuntu.com/events/">Events</a></li>
+          <li class="page_item page-item-4474"><a href="https://juju.ubuntu.com/charm-championship/">Charm Championship</a></li>
+          <li class="page_item page-item-4249"><a href="https://juju.ubuntu.com/survey/">Survey</a></li>
+          <li>
+            <form id="form-search" method="get" action="https://juju.ubuntu.com/">
+              <fieldset>
+                <input id="input-search" type="text" name="s" value="Search" />
+              </fieldset>
+            </form>
+          </li>
+        </ul>
+      </nav>
+    </div>
+  </div>
+  <div class="header-content">
+    <div class="clearfix">
+      <img src="https://juju.ubuntu.com/wp-content/themes/juju-website/img/arrow-nav.png" width="9" height="5" style="left:455px; display: block;" class="arrow-nav">
+      <div class="header-navigation-secondary"></div>
+      <div class="header-image"></div>
+      <h1>Resources</h1>
+      <h2>A collection of some of the most important online references for Juju users and developers.</h2>
+    </div>
+  </div>
+</header>
+
+    <section id="content" class="container-12">
+      <div class="grid-12 doc-container">
+                <div id="navlinks" class="grid-3 doc-navigation">LINKS</div>
+        <div class="grid-9 doc-content">
+          <article>
+
+            <section id="constraints">
+              <h1>Constraints</h1>
+
+              <p>Complete listing of constraints supported by juju and what they mean. See <a href="charms-constraints.html">using constraints</a> for how to specify these in a deployment.</p>
+
+              <h2>Generic constraints</h2>
+              <dl>
+                <dt>arch</dt>
+                <dd>Short name of architecture that a service must run on. Can be left blank to indicate any architecture is acceptable, or one of <code>amd64</code>, <code>arm</code>, or <code>i386</code>.</dd>
+                <dt>container</dt>
+                <dd>Name of container type that a service unit must run inside. Can be left blank to indicate no preference, or one of <code>none</code> for uncontainerised, <code>lxc</code>, or <code>kvm</code>.</dd>
+                <dt>cpu-cores</dt>
+                <dd>Minimum number of effective CPU cores that must be available to a service unit.</dd>
+                <dt>cpu-power</dt>
+                <dd>Minimum amount of abstract CPU power that must be available to a service unit, where 100 units is roughly equivalent to "a single 2007-era Xeon" as reflected by 1 Amazon ECU. <strong>Warning: Not all providers support this constraint, use <code>cpu-cores</code> for portability.</strong></dd>
+                <dt>mem</dt>
+                <dd>Minimum number of megabytes of RAM that must be available to a service unit. An optional suffix of M/G/T/P indicates the value is mega-/giga-/tera-/peta- bytes.</dd>
+                <dt>root-disk</dt>
+                <dd>Minimum amount of of disk space on the root drive on each service unit. Additional storage that may be attached separately does not count towards this value.</dd>
+              </dl>
+
+              <!--TODO(gz): When provider-specific constraints are implemented,
+                            document that here.
+              -->
+
+              <h2>Legacy constraints</h2>
+              <p>In pre-1.0 juju some additional or differently named constraints were also supported, these need to be migrated when upgrading.</p>
+              <dl>
+                <dt>cpu</dt>
+                <dd>Number of CPU cores for most providers, but equivalent to an Amazon ECU on AWS. Use <code>cpu-cores</code> instead.</dd>
+                <dt>instance-type</dt>
+                <dd>Cloud-specific instance-type name that a service used must be deployed on. Valid values vary by provider, and individual deployment in some cases. Use appropriate values for <code>cpu-count</code>, <code>mem</code>, and <code>root-disk</code> instead where possible for portability.</dd>
+                <dt>ec2-zone</dt>
+                <dd>EC2 availability zone that a service unit must be deployed into. No equivalent implemented as of juju 1.12, follow <a href="https://bugs.launchpad.net/juju-core/+bug/1183831">bug 1183831</a>.</dd>
+                <dt>maas-name</dt>
+                <dd>Specific MAAS machine name that a service unit must be deployed on. Use <code>maas-tags</code> instead by preference.</dd>
+                <dt>maas-tags</dt>
+                <dd>List of tags a MAAS machine must have for a service unit to be deployed on. No equivalent implemented as of juju 1.12, follow <a href="https://bugs.launchpad.net/juju-core/+bug/1170337">bug 1170337</a>.</dd>
+                <dt>os-scheduler-hints</dt>
+                <dd>Experimental constraint exposing Openstack-specific scheduler hints features. Do not use.</dd>
+              </dl>
+
+            </section>
+
+          </article>
+        </div>
+      </div>
+    </section>
+    <div class="shadow"></div>
+    <footer class="global clearfix" role="contentinfo">
+  <div class="row">
+    <div class="inner-wrapper">
+      <nav role="navigation" class="clearfix">
+        <ul class="footer-a">
+          <li class="grid-3 first-col">
+            <h4><a href="/get-started">Get started</a></h4>
+            <ul>
+              <li class="page_item page-item-20"><a href="https://juju.ubuntu.com/get-started/local/">Local</a></li>
+              <li class="page_item page-item-22"><a href="https://juju.ubuntu.com/get-started/amazon/">Amazon Web Services</a></li>
+              <li class="page_item page-item-18"><a href="https://juju.ubuntu.com/get-started/hp-cloud/">HP Cloud</a></li>
+              <li class="page_item page-item-16"><a href="https://juju.ubuntu.com/get-started/rackspace/">Rackspace</a></li>
+              <li class="page_item page-item-3596"><a href="https://juju.ubuntu.com/get-started/openstack/">Openstack</a></li>
+              <li class="page_item page-item-3600"><a href="https://juju.ubuntu.com/get-started/maas/">MAAS</a></li>
+            </ul>
+          </li>
+          <li class="grid-3">
+            <h4><a href="/resources">Resources</a></h4>
+            <ul>
+              <li><a href="http://juju.ubuntu.com/docs">Documentation</a></li>
+              <li><a href="/resources/videos/">Videos</a></li>
+              <li><a href="http://uistage.jujucharms.com:8080/">Juju GUI demo site</a></li>
+            </ul>
+          </li>
+          <li class="grid-3">
+            <h4><a href="/community">Community</a></h4>
+            <ul>
+              <li class="page_item page-item-28"><a href="https://juju.ubuntu.com/community/juju-blog/">Juju Blog</a></li>
+              <li class="page_item page-item-4262"><a href="https://juju.ubuntu.com/community/weekly-charm-meeting/">Weekly Charm Meeting</a></li>
+              <li class="page_item page-item-4036"><a href="https://juju.ubuntu.com/community/charmers/">Charmers</a></li>
+              <li><a href="https://lists.ubuntu.com/mailman/listinfo/juju">Mailing List</a></li>
+              <li><a href="http://webchat.freenode.net/?channels=juju">Chat</a></li>
+              <li><a href="http://askubuntu.com/questions/tagged/juju?sort=faq&pagesize=50">FAQ</a></li>
+            </ul>
+          </li>
+          <li class="grid-3 last-col">
+            <h4><a href="https://launchpad.net/juju">Code</a></h4>
+            <ul>
+              <li><a href="https://launchpad.net/juju-core">Juju Core</a></li>
+              <li><a href="https://launchpad.net/charms">Charms</a></li>
+            </ul>
+          </li>
+        </ul>
+      </nav>
+    </div>
+  </div>
+  <div class="row no-border">
+    <div class="legal inner-wrapper">
+      <p>&copy; 2013 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.</p>
+      <p><a href="https://bugs.launchpad.net/juju-website/+filebug">Report a bug on this site</a></p>
+    </div>
+  </div>
+</footer>
+
+    <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
+    <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jqueryui/1.8.14/jquery-ui.min.js"></script>
+    <script src="//d38yea5fb4e2oh.cloudfront.net/jquery.stacktack.min.js"></script>
+    <script type="text/javascript" src="js/main.js"></script>
+    <script type="text/javascript" src="http://code.jquery.com/jquery-1.9.1.js"></script>
+  </body>
+</html>