Author: buildbot
Date: Tue Apr 29 10:52:52 2014
New Revision: 907288
Log:
Staging update by buildbot for ace
Modified:
websites/staging/ace/trunk/content/ (props changed)
websites/staging/ace/trunk/content/user-doc/user-guide.html
Propchange: websites/staging/ace/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Apr 29 10:52:52 2014
@@ -1 +1 @@
-1590940
+1590946
Modified: websites/staging/ace/trunk/content/user-doc/user-guide.html
==============================================================================
--- websites/staging/ace/trunk/content/user-doc/user-guide.html (original)
+++ websites/staging/ace/trunk/content/user-doc/user-guide.html Tue Apr 29
10:52:52 2014
@@ -174,9 +174,11 @@
<li><a href="#uploading-artifacts">Uploading artifacts</a></li>
<li><a href="#creating-a-new-feature-distribution-andor-target">Creating a new
feature, distribution and/or target</a></li>
<li><a href="#creating-associations">Creating associations</a></li>
+<li><a href="#configuring-the-server">Configuring the server</a></li>
</ul>
</li>
<li><a href="#running-a-target">Running a target</a><ul>
+<li><a href="#target-configuration">Target configuration</a></li>
<li><a href="#using-the-template-engine-for-targets">Using the template engine
for targets</a></li>
</ul>
</li>
@@ -245,6 +247,10 @@ To delete an association once is created
<p><img src="ace_static_association.png" width="522px" title="Figure 6:
Creating a static association by dragging a particular version of a bundle onto
a feature." /><br />
<strong>Figure 6</strong>: Creating a static association by dragging a
particular version of a bundle onto a feature.</p>
<p>Creating dynamic associations is currently only supported for bundle
artifacts. For other types of artifacts, such as configuration files, only
static associations can be created<sup id="fnref:2"><a class="footnote-ref"
href="#fn:2" rel="footnote">2</a></sup>. </p>
+<h3 id="configuring-the-server">Configuring the server</h3>
+<p>The ACE server is completely modular and therefore can be configured in
many different ways. As such, the configuration of the server is done by using
the Configuration Admin service which is provisioned by means of configuration
files that reside in the <tt>conf</tt> directory. The filename of each
configuration file equals the service PID of the managed service and
<strong>must</strong> end with <tt>.cfg</tt>. Directories are considered as
managed service factories of which the directory name equals the service
PID.</p>
+<p>Configuration files itself are simple Java property files containing
key-value pairs separated by newlines. Configuration values are allowed to
contain "placeholders" or "variables". Everything between <tt>${</tt> and
<tt>}</tt> is considered a variable and replaced by the value represented by
that variable. For example, consider a variable <tt>var</tt> that is defined as
"<tt>value</tt>", then <tt>${var}</tt> will be replaced with "<tt>value</tt>".
Variables can refer to another value in the <em>same</em> configuration file,
or to a property that is defined in the OSGi-framework or globally in your
system as environment setting.</p>
+<p>The configuration files are watched continuously, allowing you to adjust
the configuration of the ACE server without having to restart it.</p>
<h2 id="running-a-target">Running a target</h2>
<p>As mentioned, a target represents a client on which software can be
deployed by ACE. Actually, a target consists of an OSGi runtime that runs
<em>at least</em> the ACE management agent. This management agent periodically
checks with the ACE server whether or not new software is available. In case
new software is available for a target, it can automatically download and
install it.</p>
<p>ACE provides a runnable eclipse project, <tt>run-target</tt> that starts an
OSGi runtime, the ACE management agent, and a Gogo shell for easy debugging and
demo purposes. The management agent, or agent for short, itself can be found in
the <tt>org.apache.ace.agent</tt> project. This agent simply does the
following:</p>
@@ -252,7 +258,7 @@ To delete an association once is created
<li>it uploads the audit log of the target to the ACE server. The audit log
contains all changes in bundle and framework state, such as the starting and
stopping of the framework and (de)installation of bundles;</li>
<li>it check whether or not software updates are available. If so, it will
download it and install this update automatically.</li>
</ol>
-<p>Since ACE 2.0.1, the binary distribution also contains a single-jar version
of a target, called <tt>target.jar</tt>, that can be used to bootstrap the ACE
management agent on a target host as shown in the following example (the
backslash denote line continuations):</p>
+<p>Since version 1.0, the binary distribution of ACE also contains a
single-jar version of a target, called <tt>target.jar</tt>, that includes all
necessary software and bundles to start the ACE management agent. It can be
used to quickly bootstrap an ACE management agent on a target host as shown in
the following example (the backslash denote line continuations):</p>
<div class="codehilite"><pre><span class="nv">$ </span>java <span
class="se">\</span>
-Dagent.identification.agentid<span class="o">=</span>target-1 <span
class="se">\</span>
-Dagent.discovery.serverurls<span
class="o">=</span>http://my.ace.server:8080 <span class="se">\</span>
@@ -263,6 +269,7 @@ Welcome to Apache Felix Gogo
</pre></div>
+<h3 id="target-configuration">Target configuration</h3>
<p>The agent can be configured by supplying its options as commandline
parameters (e.g. <tt>-Dname=value</tt>). A list of most used options are<sup
id="fnref:7"><a class="footnote-ref" href="#fn:7"
rel="footnote">7</a></sup>:</p>
<dl>
<dt><tt>agent.identification.agentid</tt></dt>
