Author: buildbot
Date: Mon May 29 15:22:13 2017
New Revision: 1013104
Log:
Staging update by buildbot for aries
Modified:
websites/staging/aries/trunk/content/ (props changed)
websites/staging/aries/trunk/content/modules/containers.html
Propchange: websites/staging/aries/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon May 29 15:22:13 2017
@@ -1 +1 @@
-1796644
+1796648
Modified: websites/staging/aries/trunk/content/modules/containers.html
==============================================================================
--- websites/staging/aries/trunk/content/modules/containers.html (original)
+++ websites/staging/aries/trunk/content/modules/containers.html Mon May 29
15:22:13 2017
@@ -299,10 +299,13 @@ helps making such changes without too mu
development difficult. Aries Containers also contains a
<code>docker.local</code> binding which makes it possible to run the same code
with a different
binding on a local developer machine, as long as docker is installed
there.</li>
</ul>
-<p>Current implementations:</p>
+<p>Current modules:</p>
<ul>
-<li><code>docker.local</code> - manage services my issuing docker commands on
the local machine. Ideal for testing.</li>
-<li><code>marathon</code> - manage service via marathon.</li>
+<li><code>containers-api</code> - the API implemented by the various
bindings.</li>
+<li><code>containers-docker-local</code> - Binding that uses the local docker
installation.</li>
+<li><code>containers-marathon</code> - Marathon binding.</li>
+<li><code>containers-parent</code> - Parent pom.</li>
+<li><code>containers-examples</code> - Examples.</li>
<li>...</li>
</ul>
<p>This project may be used as input to the design process of the <a
href="https://github.com/osgi/design/blob/master/rfps/rfp-0179-ComputeManagementService.pdf";>OSGi
RFP 179</a>.</p>
@@ -312,7 +315,40 @@ binding on a local developer machine, as
<p><code>mvn install</code></p>
<p>Java 1.8 or higher is required. Maven 3.3.9+ is recommended.</p>
<h1 id="quick-start">Quick Start<a class="headerlink" href="#quick-start"
title="Permanent link">¶</a></h1>
-<p>TODO</p></div>
+<p>TODO</p>
+<h1 id="bindings">Bindings<a class="headerlink" href="#bindings"
title="Permanent link">¶</a></h1>
+<h2 id="docker-local">Docker Local<a class="headerlink" href="#docker-local"
title="Permanent link">¶</a></h2>
+<p>This binding works by issuing <code>docker</code> commands on the local
machine and is very useful for testing. Make sure the environment
+variables normally provided via <code>docker-machine env <myenv></code>
are set.</p>
+<p>OSGi ServiceManager identifier: <code>container.factory.binding =
docker.local</code></p>
+<p>Constructor, for use outside of OSGi:
<code>org.apache.aries.containers.docker.local.impl.LocalDockerServiceManager</code></p>
+<h2 id="marathon">Marathon<a class="headerlink" href="#marathon"
title="Permanent link">¶</a></h2>
+<p>This binding uses Marathon as the underlying container manager. It requires
the following configuration to be set:</p>
+<div class="codehilite"><pre><span class="n">service</span><span
class="p">.</span><span class="n">pid</span><span class="p">:</span> <span
class="n">org</span><span class="p">.</span><span class="n">apache</span><span
class="p">.</span><span class="n">aries</span><span class="p">.</span><span
class="n">containers</span><span class="p">.</span><span
class="n">marathon</span>
+ <span class="n">marathon</span><span class="p">.</span><span
class="n">url</span><span class="p">=</span><span class="o"><</span><span
class="n">the</span> <span class="n">URL</span> <span class="n">where</span>
<span class="n">marathon</span> <span class="n">can</span> <span
class="n">be</span> <span class="n">contacted</span><span class="o">></span>
+</pre></div>
+
+
+<p>Once configured, the Marathon binding will register its OSGi service.
+OSGi ServiceManager identifier: <code>container.factory.binding =
marathon</code></p>
+<p>Constructors, for use outside of OSGi:
<code>org.apache.aries.containers.marathon.impl.MarathonServiceManager</code></p>
+<div class="codehilite"><pre><span class="cm">/**</span>
+<span class="cm"> * Create the Marathon Service Manager.</span>
+<span class="cm"> *</span>
+<span class="cm"> * @param marathonURL The Marathon URL</span>
+<span class="cm"> */</span>
+<span class="n">public</span> <span
class="n">MarathonServiceManager</span><span class="p">(</span><span
class="n">String</span> <span class="n">marathonURL</span><span
class="p">);</span>
+
+<span class="cm">/**</span>
+<span class="cm"> * Create the Marathon Service Manager for use with
DC/OS.</span>
+<span class="cm"> *</span>
+<span class="cm"> * @param marathonURL The Marathon URL.</span>
+<span class="cm"> * @param dcosUser The DCOS user or service-user.</span>
+<span class="cm"> * @param passToken The password or token to use.</span>
+<span class="cm"> * @param serviceAcct `true` if this is a service account
`false` if this is a plain user.</span>
+<span class="cm"> */</span>
+<span class="n">public</span> <span
class="n">MarathonServiceManager</span><span class="p">(</span><span
class="n">String</span> <span class="n">marathonURL</span><span
class="p">,</span> <span class="n">String</span> <span
class="n">dcosUser</span><span class="p">,</span> <span class="n">String</span>
<span class="n">passToken</span><span class="p">,</span> <span
class="n">boolean</span> <span class="n">serviceAcct</span><span
class="p">);</span>
+</pre></div></div>
<!-- Content -->
</td>
</tr>
