You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ace.apache.org by bu...@apache.org on 2014/11/25 10:28:15 UTC
svn commit: r930413 - in /websites/staging/ace/trunk/content: ./ docs/
Author: buildbot
Date: Tue Nov 25 09:28:14 2014
New Revision: 930413
Log:
Staging update by buildbot for ace
Modified:
websites/staging/ace/trunk/content/ (props changed)
websites/staging/ace/trunk/content/docs/ace_dnd_artifacts.png
websites/staging/ace/trunk/content/docs/ace_dnd_artifacts_fail.png
websites/staging/ace/trunk/content/docs/ace_dnd_artifacts_ok.png
websites/staging/ace/trunk/content/docs/ace_dynamic_association.png
websites/staging/ace/trunk/content/docs/ace_server_ui.png
websites/staging/ace/trunk/content/docs/ace_static_association.png
websites/staging/ace/trunk/content/docs/user-guide.html
Propchange: websites/staging/ace/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Nov 25 09:28:14 2014
@@ -1 +1 @@
-1641536
+1641553
Modified: websites/staging/ace/trunk/content/docs/ace_dnd_artifacts.png
==============================================================================
Binary files - no diff available.
Modified: websites/staging/ace/trunk/content/docs/ace_dnd_artifacts_fail.png
==============================================================================
Binary files - no diff available.
Modified: websites/staging/ace/trunk/content/docs/ace_dnd_artifacts_ok.png
==============================================================================
Binary files - no diff available.
Modified: websites/staging/ace/trunk/content/docs/ace_dynamic_association.png
==============================================================================
Binary files - no diff available.
Modified: websites/staging/ace/trunk/content/docs/ace_server_ui.png
==============================================================================
Binary files - no diff available.
Modified: websites/staging/ace/trunk/content/docs/ace_static_association.png
==============================================================================
Binary files - no diff available.
Modified: websites/staging/ace/trunk/content/docs/user-guide.html
==============================================================================
--- websites/staging/ace/trunk/content/docs/user-guide.html (original)
+++ websites/staging/ace/trunk/content/docs/user-guide.html Tue Nov 25 09:28:14 2014
@@ -313,19 +313,25 @@ name of the feature or distribution and
clicking it. For features and distributions, this means you can alter their description,
while for targets, there are more possibilities to view and alter:</p>
<ul>
-<li>On the Management tab, you can change whether or not the target should be automatically
- updated to the latest software. If selected, all updates will automatically be approved
- and distributed to that target. If not, any update must be explicitly approved prior to
- being distributed to the target;</li>
-<li>On the Info tab, you can view the current state of the target, such as the currently
+<li>On the <strong>Management</strong> tab, you can register a target, and change whether or not changes
+ to any distribution associated to that target should be automatically approved to make
+ the target obtain the latest software. If auto-approve is enabled, all updates will
+ automatically be approved and distributed to that target. If not, all updates must be
+ <em>explicitly</em> approved prior to being distributed to the target. For convenience, the "A"
+ button above the targets column in the main UI allows you to approve the changes for one
+ or more (selected) targets. The "R" button allows you to register one or more selected
+ targets in a single go;</li>
+<li>On the <strong>Info</strong> tab, you can view the current state of the target, such as the currently
installed version, or the latest available software version;</li>
-<li>On the LogViewer tab, you can view the installation log of the target. This allows you
- to review the installation of updates on that target;</li>
-<li>The Tag Editor tab allows you to define tags and their values. Tags can be used for many
- things, but one of their more interesting use cases is that they can be used to replace
- variables in template artifacts that contain those tags. This is useful, for example, to
- have a single configuration file that can be used for multiple targets, because it is
- largely the same for all of them.</li>
+<li>On the <strong>Log Viewer</strong> tab, you can view the installation log of the target. This allows
+ you to review the installation of updates on that target;</li>
+<li>The <strong>Tag Editor</strong> tab allows you to define tags and their values (see also figure 8).
+ Tags can be used for many things, but one of their more interesting use cases is that
+ they can be used to replace variables in template artifacts that contain those tags.
+ This is useful, for example, to have a single configuration file that can be used for
+ multiple targets, because it is largely the same for all of them;</li>
+<li>The <strong>Verify/resolve</strong> tab provides a basic facility to verify whether a particular
+ distribution will actually resolve on the target.</li>
</ul>
<h3 id="creating-associations">Creating associations</h3>
<p>To link artifacts to features, you simply select the artifact and drag it on top of the
@@ -402,134 +408,76 @@ Welcome to Apache Felix Gogo
<tt>-Dname=value</tt>). A list of most used options are<sup id="fnref:8"><a class="footnote-ref" href="#fn:8" rel="footnote">8</a></sup>:</p>
<dl>
<dt><tt>agent.identification.agentid</tt></dt>
-<dd>
-<dl>
-<dt>defines the name to uniquely identify a target on the ACE server. In case this option is</dt>
-<dt>not supplied, a default value of <tt>defaultTargetID</tt> is used;</dt>
+<dd>defines the name to uniquely identify a target on the ACE server. In case this option is
+not supplied, a default value of <tt>defaultTargetID</tt> is used;</dd>
<dt><tt>agent.discovery.serverurls</tt></dt>
-<dd>
-<dl>
-<dt>defines the ACE server URLs to connect to. Multiple URLs can be given to get a form of</dt>
-<dt>fail-over: in case a connection to the first URL cannot be established, the second URL</dt>
-<dt>will be used, and so on. If this option is given, at least one URL should be supplied, and</dt>
-<dt>multiple URLs can be supplied by separating them with a comma. If this option is omitted,</dt>
-<dt>a default value of <tt>http://localhost:8080</tt> is used;</dt>
+<dd>defines the ACE server URLs to connect to. Multiple URLs can be given to get a form of
+fail-over: in case a connection to the first URL cannot be established, the second URL
+will be used, and so on. If this option is given, at least one URL should be supplied, and
+multiple URLs can be supplied by separating them with a comma. If this option is omitted,
+a default value of <tt>http://localhost:8080</tt> is used;</dd>
<dt><tt>agent.discovery.checking</tt></dt>
-<dd>
-<dl>
-<dt>defines whether or not server URLs should be checked whether they are alive prior to</dt>
-<dt>being used. This implies that a "ping" request is sent to the server URL that is going to</dt>
-<dt>be used. Server URLs that are not responding will not be used and will cause another URL</dt>
-<dt>(defined by <tt>agent.discovery.serverurls</tt>) to be picked instead. The default value</dt>
-<dt>is <tt>true</tt>, which means that all server URLs are checked. Use <tt>false</tt> if your</dt>
-<dt>ACE server(s) are not always available or when running the target on a flacky network;</dt>
+<dd>defines whether or not server URLs should be checked whether they are alive prior to
+being used. This implies that a "ping" request is sent to the server URL that is going to
+be used. Server URLs that are not responding will not be used and will cause another URL
+(defined by <tt>agent.discovery.serverurls</tt>) to be picked instead. The default value
+is <tt>true</tt>, which means that all server URLs are checked. Use <tt>false</tt> if your
+ACE server(s) are not always available or when running the target on a flacky network;</dd>
<dt><tt>agent.logging.level</tt></dt>
-<dd>
+<dd>defines the log level of the agent, and should be one of the following values:</dd>
+</dl>
+<p><tt>DEBUG</tt>, <tt>INFO</tt>, <tt>WARNING</tt> or <tt>ERROR</tt>. The default log level
+is <tt>INFO</tt>;</p>
<dl>
-<dt>defines the log level of the agent, and should be one of the following values:</dt>
-<dt><tt>DEBUG</tt>, <tt>INFO</tt>, <tt>WARNING</tt> or <tt>ERROR</tt>. The default log level</dt>
-<dt>is <tt>INFO</tt>;</dt>
<dt><tt>agent.controller.syncinterval</tt></dt>
-<dd>
-<dl>
-<dt>defines the interval (in seconds) in which the agent should synchronize with the ACE</dt>
-<dt>server. A default of <tt>60</tt> seconds is used in case this option is not supplied;</dt>
+<dd>defines the interval (in seconds) in which the agent should synchronize with the ACE
+server. A default of <tt>60</tt> seconds is used in case this option is not supplied;</dd>
<dt><tt>agent.controller.syncdelay</tt></dt>
-<dd>
-<dl>
-<dt>defines how long the agent should wait (in seconds) after startup before it will</dt>
-<dt>synchronize with the ACE server for the first time. A default of <tt>5</tt> seconds is</dt>
-<dt>used in case this option is not supplied;</dt>
+<dd>defines how long the agent should wait (in seconds) after startup before it will
+synchronize with the ACE server for the first time. A default of <tt>5</tt> seconds is
+used in case this option is not supplied;</dd>
<dt><tt>agent.controller.streaming</tt></dt>
-<dd>
-<dl>
-<dt>if given a value of <tt>false</tt>, all software updates will be downloaded completely</dt>
-<dt>first after which it will be installed. Use this value in case you suffer from unreliable</dt>
-<dt>network connections. A value of <tt>true</tt> (the default) causes the agent to download</dt>
-<dt>and install any software update directly.</dt>
+<dd>if given a value of <tt>false</tt>, all software updates will be downloaded completely
+first after which it will be installed. Use this value in case you suffer from unreliable
+network connections. A value of <tt>true</tt> (the default) causes the agent to download
+and install any software update directly.</dd>
<dt><tt>agent.controller.fixpackages</tt></dt>
-<dd>
-<dl>
-<dt>if given a value of <tt>true</tt> (the default), software updates will only contain the</dt>
-<dt>deltas or changed artifacts. For large deployment packages, this can dramatically reduce</dt>
-<dt>the size of an update. Use a value of <tt>false</tt> to <em>always</em> get <em>all</em> artifacts for</dt>
-<dt><em>each</em> software update;</dt>
+<dd>if given a value of <tt>true</tt> (the default), software updates will only contain the
+deltas or changed artifacts. For large deployment packages, this can dramatically reduce
+the size of an update. Use a value of <tt>false</tt> to <em>always</em> get <em>all</em> artifacts for
+<em>each</em> software update;</dd>
<dt><tt>agent.controller.retries</tt></dt>
-<dd>
-<dl>
-<dt>defines the number of times the agent should retry to install a software update in case</dt>
-<dt>its installation fails. If omitted, an installation is retried <tt>3</tt> times;</dt>
+<dd>defines the number of times the agent should retry to install a software update in case
+its installation fails. If omitted, an installation is retried <tt>3</tt> times;</dd>
<dt><tt>agent.feedback.channels</tt></dt>
-<dd>
-<dl>
-<dt>defines what feedback channels exist and should be synchronized with the ACE server.</dt>
-<dt>Feedback channels can be used to report any kind of information back to the ACE server,</dt>
-<dt>and is by default used to provide basic information on the OSGi environment to the ACE</dt>
-<dt>server. If omitted, the default of <tt>auditlog</tt> is used. Multiple feedback channels</dt>
-<dt>can be supplied by separating them with commas, like <tt>auditlog,myOwnLog</tt>. Note that</dt>
-<dt>all mentioned feedback channels <em>must</em> be configured on the ACE server as well;</dt>
+<dd>defines what feedback channels exist and should be synchronized with the ACE server.
+Feedback channels can be used to report any kind of information back to the ACE server,
+and is by default used to provide basic information on the OSGi environment to the ACE
+server. If omitted, the default of <tt>auditlog</tt> is used. Multiple feedback channels
+can be supplied by separating them with commas, like <tt>auditlog,myOwnLog</tt>. Note that
+all mentioned feedback channels <em>must</em> be configured on the ACE server as well;</dd>
<dt><tt>agent.logging.events.exclude</tt></dt>
-<dd>
-<dl>
-<dt>defines the audit events that should be <em>excluded</em> from appearing on the audit feedback</dt>
-<dt>channel. This parameter takes one or more event types represented by integers separated by</dt>
-<dt>commas, for example, <tt>2001,2003,2005,3001</tt>. By default, <em>no</em> events are excluded;</dt>
+<dd>defines the audit events that should be <em>excluded</em> from appearing on the audit feedback
+channel. This parameter takes one or more event types represented by integers separated by
+commas, for example, <tt>2001,2003,2005,3001</tt>. By default, <em>no</em> events are excluded;</dd>
<dt><tt>agent.connection.authtype</tt></dt>
-<dd>
-<dl>
-<dt>defines how to connections to the server are to be authenticated. Valid values are</dt>
-<dt><tt>NONE</tt> for no authentication, <tt>BASIC</tt> for using HTTP-BASIC authentication or</dt>
-<dt><tt>CLIENTCERT</tt> for using client certificates. In case this option is omitted, a value</dt>
-<dt>of <tt>NONE</tt> is assumed and no authentication is used. In case of the values</dt>
-<dt><tt>BASIC</tt> or <tt>CLIENTCERT</tt>, additional options should be supplied (see below);</dt>
+<dd>defines how to connections to the server are to be authenticated. Valid values are
+<tt>NONE</tt> for no authentication, <tt>BASIC</tt> for using HTTP-BASIC authentication or
+<tt>CLIENTCERT</tt> for using client certificates. In case this option is omitted, a value
+of <tt>NONE</tt> is assumed and no authentication is used. In case of the values
+<tt>BASIC</tt> or <tt>CLIENTCERT</tt>, additional options should be supplied (see below);</dd>
<dt><tt>agent.connection.username</tt> and <tt>agent.connection.password</tt></dt>
-<dd>
-<dl>
-<dt>provide the username and password used for HTTP-BASIC authentication;</dt>
+<dd>provide the username and password used for HTTP-BASIC authentication;</dd>
<dt><tt>agent.connection.sslProtocol</tt></dt>
-<dd>
-<dl>
-<dt>defines what SSL protocol is to be used for creating secure connections to the ACE</dt>
-<dt>server, defaults to <tt>TLS</tt>;</dt>
+<dd>defines what SSL protocol is to be used for creating secure connections to the ACE
+server, defaults to <tt>TLS</tt>;</dd>
<dt><tt>agent.connection.keyfile</tt> and <tt>agent.connection.keypass</tt></dt>
-<dd>
-<dl>
-<dt>provide the keystore file and password that contain the certificate information for</dt>
-<dt>establishing a secure conncetion between agent and server;</dt>
+<dd>provide the keystore file and password that contain the certificate information for
+establishing a secure conncetion between agent and server;</dd>
<dt><tt>agent.connection.trustfile</tt> and <tt>agent.connection.trustpass</tt></dt>
<dd>provide the truststore file and password that contain the trusted (server)
certificate(s) for establishing a secure connection between agent and server.</dd>
</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
<p>When the agent is started, a new target should appear in the ACE server after you
"Retrieve" the latest changes in the web UI. Note that this can take a little while since
the agent needs to synchronize with the server first, see