Author: jawi
Date: Tue Apr 29 10:52:47 2014
New Revision: 1590946
URL: http://svn.apache.org/r1590946
Log:
Added section on how to configure the server.
Modified:
ace/site/trunk/content/user-doc/user-guide.mdtext
Modified: ace/site/trunk/content/user-doc/user-guide.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/user-doc/user-guide.mdtext?rev=1590946&r1=1590945&r2=1590946&view=diff
==============================================================================
--- ace/site/trunk/content/user-doc/user-guide.mdtext (original)
+++ ace/site/trunk/content/user-doc/user-guide.mdtext Tue Apr 29 10:52:47 2014
@@ -98,6 +98,14 @@ There is a subtle, but very important, d
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[^2].
+### Configuring the server
+
+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 **must**
end with <tt>.cfg</tt>. Directories are considered as managed service factories
of which the directory name equals the service PID.
+
+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 *same* configuration file, or to a
property that is defined in the OSGi-framework or globally in your system as
environment setting.
+
+The configuration files are watched continuously, allowing you to adjust the
configuration of the ACE server without having to restart it.
+
## Running a target
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 *at least* 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.
@@ -107,7 +115,7 @@ ACE provides a runnable eclipse project,
1. 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;
2. it check whether or not software updates are available. If so, it will
download it and install this update automatically.
-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):
+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):
:::sh
$ java \
@@ -118,6 +126,8 @@ Since ACE 2.0.1, the binary distribution
Welcome to Apache Felix Gogo
...
+### Target configuration
+
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[^7]:
<tt>agent.identification.agentid</tt>
