Author: jawi
Date: Thu Oct 31 14:52:29 2013
New Revision: 1537514
URL: http://svn.apache.org/r1537514
Log:
CMS commit to ace by jawi
Modified:
ace/site/trunk/content/dev-doc/configuring-relay-servers.mdtext
Modified: ace/site/trunk/content/dev-doc/configuring-relay-servers.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/dev-doc/configuring-relay-servers.mdtext?rev=1537514&r1=1537513&r2=1537514&view=diff
==============================================================================
--- ace/site/trunk/content/dev-doc/configuring-relay-servers.mdtext (original)
+++ ace/site/trunk/content/dev-doc/configuring-relay-servers.mdtext Thu Oct 31
14:52:29 2013
@@ -29,6 +29,7 @@ Like in a single-server scenario, the re
To configure the storage of logs from targets on the relay server, we need to
instantiate a log store by supplying the following configuration to the
<tt>org.apache.ace.log.server.store.factory</tt> managed service factory:
+ :::properties
# a symbolic name used to reference to this store from other services
name=auditlog
@@ -36,6 +37,7 @@ This will instantiate a new log store se
To allow targets to upload their logs to the relay server, a log-servlet needs
to be instantiated. This is done by supplying the following configuration to
the <tt>org.apache.ace.log.server.servlet.factory</tt> managed service factory:
+ :::properties
# the symbolic name of the actual log store to store the uploaded logs in
name=auditlog
# the alias/endpoint at which the servlet is registered
@@ -49,6 +51,7 @@ This will instantiate a servlet that lis
With the log store and servlet configured and in place, a target is now able
to synchronise its logs with the relay server. However, once uploaded to the
relay server, the logs will not propagate automatically to the main ACE server.
A separate log-synchronisation task is responsible for this. To enable this
task, we need to supply the following configuration to the
<tt>org.apache.ace.log.server.task.factory</tt> managed service factory:
+ :::properties
# the symbolic name of the actual log store to synchronise
name=auditlog
# how to synchronise logs, can be 'pull', 'push' or 'pushpull'
@@ -62,6 +65,7 @@ This will create a "task" service that w
In addition, the log synchronisation task (and other tasks as well, see below)
needs to know what upstream server it should synchronise with. For this
information, it uses the ACE discovery service, which is configured by
supplying, for example, the following configuration to the
<tt>org.apache.discovery.property</tt>[^3] managed service:
+ :::properties
# what is the URL to the *main* ACE server
serverURL = http://my.main.server:8080
@@ -71,6 +75,7 @@ The relay needs to have at least a deplo
To create a "slave" deployment repository[^5] store, the following
configuration needs to be supplied to the
<tt>org.apache.ace.server.repository.factory</tt> managed service factory:
+ :::properties
# the symbolic name of the repository, should be "deployment"
name=deployment
# the customer name, should be equal to the customer name used on the
master server
@@ -80,6 +85,7 @@ To create a "slave" deployment repositor
To make the repository store accessible through a servlet, we need to supply
the following configuration to the
<tt>org.apache.ace.repository.servlet.RepositoryServlet</tt> managed service:
+ :::properties
# the endpoint on which the deployment repository store is accessible
org.apache.ace.server.servlet.endpoint=/repository
# whether or not to enable authentication for this endpoint
@@ -89,6 +95,7 @@ This will instantiate a servlet that lis
With the repository store and servlet configured, we can configure the
deployment repository provider, which is used to collect information about
deployment artefacts that should be deployed on a target. The deployment
repository provider is configured by supplying the following configuration to
the <tt>org.apache.ace.deployment.provider.repositorybased</tt> managed service:
+ :::properties
# the URL on which the deployment repository store can be accessed
url = http://my.relay.server:8080/repository
# the symbolic name of the repository, should be "deployment"
@@ -102,6 +109,7 @@ The target is only interested in downloa
To configure the servlet responsible for providing deployment packages of the
target software, we need to supply the following configuration to the
<tt>org.apache.ace.deployment.servlet</tt> managed service:
+ :::properties
# the endpoint on which the deployment servlet for software-updates is
accessible
org.apache.ace.server.servlet.endpoint=/deployment
# whether or not to enable authentication for this endpoint
@@ -109,6 +117,7 @@ To configure the servlet responsible for
To configure the servlet responsible for providing agent updates, we need to
supply the following configuration to the
<tt>org.apache.ace.deployment.servlet.agent</tt> managed service:
+ :::properties
# the endpoint on which the deployment servlet for agent-updates is
accessible
org.apache.ace.server.servlet.endpoint=/agent
# whether or not to enable authentication for this endpoint
@@ -120,6 +129,7 @@ To configure the servlet responsible for
With the synchronisation and repository replication tasks in place, we need to
tell the ACE scheduler to periodically execute these tasks. This is done by
supplying the following configuration to the
<tt>org.apache.ace.scheduler.cfg</tt> managed service:
+ :::properties
# execute all LogSyncTasks once every 2 seconds...
org.apache.ace.log.server.task.LogSyncTask=2000
# Synchronise with the master repository every 5 seconds...
@@ -133,6 +143,7 @@ A complete runnable example can be found
To only thing that a target needs to know about the relay server is its (base)
URL. This can be supplied when starting the management agent on the target by
adding the following argument to its command line:
+ :::sh
-Dagent.discovery.serverurls=http://my.relay.server:8080/
In fact, the <tt>agent.discovery.serverurls</tt> can take multiple server URLs
(separated by commas) to support a simple form of fail-over, like
<tt>http://first.relay.server:8080/,http://second.relay.server:8080</tt>.
