Author: jawi
Date: Tue Nov 25 09:28:08 2014
New Revision: 1641553
URL: http://svn.apache.org/r1641553
Log:
More refinements to the user guide:
- updated screen shots to the latest UI;
- minor textual changes/fixes.
Modified:
ace/site/trunk/content/docs/ace_dnd_artifacts.png
ace/site/trunk/content/docs/ace_dnd_artifacts_fail.png
ace/site/trunk/content/docs/ace_dnd_artifacts_ok.png
ace/site/trunk/content/docs/ace_dynamic_association.png
ace/site/trunk/content/docs/ace_server_ui.png
ace/site/trunk/content/docs/ace_static_association.png
ace/site/trunk/content/docs/user-guide.mdtext
Modified: ace/site/trunk/content/docs/ace_dnd_artifacts.png
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/docs/ace_dnd_artifacts.png?rev=1641553&r1=1641552&r2=1641553&view=diff
==============================================================================
Binary files - no diff available.
Modified: ace/site/trunk/content/docs/ace_dnd_artifacts_fail.png
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/docs/ace_dnd_artifacts_fail.png?rev=1641553&r1=1641552&r2=1641553&view=diff
==============================================================================
Binary files - no diff available.
Modified: ace/site/trunk/content/docs/ace_dnd_artifacts_ok.png
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/docs/ace_dnd_artifacts_ok.png?rev=1641553&r1=1641552&r2=1641553&view=diff
==============================================================================
Binary files - no diff available.
Modified: ace/site/trunk/content/docs/ace_dynamic_association.png
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/docs/ace_dynamic_association.png?rev=1641553&r1=1641552&r2=1641553&view=diff
==============================================================================
Binary files - no diff available.
Modified: ace/site/trunk/content/docs/ace_server_ui.png
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/docs/ace_server_ui.png?rev=1641553&r1=1641552&r2=1641553&view=diff
==============================================================================
Binary files - no diff available.
Modified: ace/site/trunk/content/docs/ace_static_association.png
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/docs/ace_static_association.png?rev=1641553&r1=1641552&r2=1641553&view=diff
==============================================================================
Binary files - no diff available.
Modified: ace/site/trunk/content/docs/user-guide.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/docs/user-guide.mdtext?rev=1641553&r1=1641552&r2=1641553&view=diff
==============================================================================
--- ace/site/trunk/content/docs/user-guide.mdtext (original)
+++ ace/site/trunk/content/docs/user-guide.mdtext Tue Nov 25 09:28:08 2014
@@ -224,19 +224,25 @@ After a feature, distribution or target
clicking it. For features and distributions, this means you can alter their
description,
while for targets, there are more possibilities to view and alter:
-* 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;
-* On the Info tab, you can view the current state of the target, such as the
currently
+* On the **Management** 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
+ *explicitly* 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;
+* On the **Info** tab, you can view the current state of the target, such as
the currently
installed version, or the latest available software version;
-* 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;
-* 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.
+* On the **Log Viewer** tab, you can view the installation log of the target.
This allows
+ you to review the installation of updates on that target;
+* The **Tag Editor** 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;
+* The **Verify/resolve** tab provides a basic facility to verify whether a
particular
+ distribution will actually resolve on the target.
### Creating associations
@@ -269,6 +275,7 @@ Creating dynamic associations is current
types of artifacts, such as configuration files, only static associations can
be
created[^4].
+
### Configuring the server
The ACE server is completely modular and therefore can be configured in many
different
@@ -328,12 +335,14 @@ The agent can be configured by supplying
<tt>agent.identification.agentid</tt>
: 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;
+
<tt>agent.discovery.serverurls</tt>
: 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;
+
<tt>agent.discovery.checking</tt>
: 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
@@ -341,30 +350,38 @@ be used. Server URLs that are not respon
(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;
+
<tt>agent.logging.level</tt>
: defines the log level of the agent, and should be one of the following
values:
+
<tt>DEBUG</tt>, <tt>INFO</tt>, <tt>WARNING</tt> or <tt>ERROR</tt>. The default
log level
is <tt>INFO</tt>;
+
<tt>agent.controller.syncinterval</tt>
: 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;
+
<tt>agent.controller.syncdelay</tt>
: 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;
+
<tt>agent.controller.streaming</tt>
: 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.
+
<tt>agent.controller.fixpackages</tt>
: 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 *always* get *all*
artifacts for
*each* software update;
+
<tt>agent.controller.retries</tt>
: 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;
+
<tt>agent.feedback.channels</tt>
: 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,
@@ -372,24 +389,30 @@ and is by default used to provide basic
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 *must* be configured on the ACE server as well;
+
<tt>agent.logging.events.exclude</tt>
: defines the audit events that should be *excluded* 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, *no* events are
excluded;
+
<tt>agent.connection.authtype</tt>
: 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);
+
<tt>agent.connection.username</tt> and <tt>agent.connection.password</tt>
: provide the username and password used for HTTP-BASIC authentication;
+
<tt>agent.connection.sslProtocol</tt>
: defines what SSL protocol is to be used for creating secure connections to
the ACE
server, defaults to <tt>TLS</tt>;
+
<tt>agent.connection.keyfile</tt> and <tt>agent.connection.keypass</tt>
: provide the keystore file and password that contain the certificate
information for
establishing a secure conncetion between agent and server;
+
<tt>agent.connection.trustfile</tt> and <tt>agent.connection.trustpass</tt>
: provide the truststore file and password that contain the trusted (server)
certificate(s) for establishing a secure connection between agent and server.
