You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@continuum.apache.org by de...@apache.org on 2010/02/22 16:01:10 UTC
svn commit: r912600 - in /continuum/branches/continuum-1.3.x/continuum-docs:
./ src/site/apt/administrator_guides/appearance.apt
src/site/apt/administrator_guides/distributed-builds.apt
src/site/apt/installation/build-agent.apt
Author: dennisl
Date: Mon Feb 22 15:01:10 2010
New Revision: 912600
URL: http://svn.apache.org/viewvc?rev=912600&view=rev
Log:
Fix typos and improve formating.
Merge from trunk.
Modified:
continuum/branches/continuum-1.3.x/continuum-docs/ (props changed)
continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/appearance.apt
continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt
continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt
Propchange: continuum/branches/continuum-1.3.x/continuum-docs/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Feb 22 15:01:10 2010
@@ -1,4 +1,4 @@
/continuum/branches/continuum-1.2.x/continuum-docs:690684,690689-690799,698449-698533,698817-698819,699529,700250,700273,700936,705894,705910,708339,722279,722624,723119,723487,724016,724024,725845,726103,726239,726462
/continuum/branches/continuum-distributed-builds/continuum-docs:713270-734307
/continuum/tags/continuum-1.2.3/continuum-docs:733253
-/continuum/trunk/continuum-docs:769703,902978,904800,905173,911599,911626,911649,911652,911763
+/continuum/trunk/continuum-docs:769703,902978,904800,905173,911599,911626,911649,911652,911763,912599
Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/appearance.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/appearance.apt?rev=912600&r1=912599&r2=912600&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/appearance.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/appearance.apt Mon Feb 22 15:01:10 2010
@@ -3,18 +3,18 @@
------
Olivier Lamy
------
- Nov 13 2007
+ 2010-02-22
------
-
+
Configure Appearance
-
+
~~%{toc|section=0}
-
+
* {Banner}
You can configure the right logo of the banner including title and link on the image.
- You have to add some information in a pom (like a company pom) (coming from org.apache:apache in this example) :
-
+ You have to add some information in a POM (like a company POM) (coming from org.apache:apache in this example):
+
+----------------------------+
<organization>
<name>The Apache Software Foundation</name>
@@ -23,31 +23,31 @@
<properties>
<organization.logo>http://www.apache.org/images/asf_logo_wide.gif</organization.logo>
</properties>
-+----------------------------+
++----------------------------+
+
+ From the menu, choose the <<Appearance>> entry :
- From the menu, choose the 'Appearance' entry :
-
[../images/configure-appearance.png] Appearance
- Use the 'Select a Company POM' link :
-
-[../images/select-company-pom.png] 'Select a Company POM'
-
- The result will be displayed (using org.apache:apache in this example) :
-
-[../images/selected-company-pom.png] 'Selected a Company POM'
+ Use the <<Select a Company POM>> link :
+
+[../images/select-company-pom.png] 'Select a Company POM'
+
+ The result will be displayed (using org.apache:apache in this example):
+
+[../images/selected-company-pom.png] 'Selected a Company POM'
+
+ <<Note:>> the POM is searched for in the central repository and in the repositories available for the active profiles from your <<<${user.home}/.m2/settings.xml>>>.
- Note : the pom is searched in central repository and the repositories available for the active profiles from your <<<${user.home}/.m2/settings.xml>>>
-
* {Footer}
-
- You can configure the footer by putting your own html content in the 'Appearance' entry of the menu.
-
+
+ You can configure the footer by putting your own html content in the <<Appearance>> entry of the menu.
+
[../images/configuration-footer.png] 'Configure footer'
The default value is :
-
+
++----------------------------+
+<div class="xright">Copyright © 2005-${currentYear} The Apache Software Foundation</div> <div class="clear"><hr/></div>
+----------------------------+
-<div class="xright">Copyright © 2005-${currentYear} The Apache Software Foundation</div> <div class="clear"><hr/></div>
-+----------------------------+
-
+
Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt?rev=912600&r1=912599&r2=912600&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt Mon Feb 22 15:01:10 2010
@@ -2,7 +2,7 @@
Distributed Builds
------------------
------------------
- 2010-02-19
+ 2010-02-22
------------------
Understanding Distributed Builds
@@ -28,17 +28,17 @@
listens for any build requests from the Master it is
assigned to.
- There is a one-to-many relationship between the Master and the Slaves.
+ There is a one-to-many relationship between the Master and the Build Agents.
A Master may have many Build Agents, but each Build Agent can only have one Master.
- TODO: insert image here
+~~TODO: insert image here
* Behavior
Distributed Builds happen at the project group level of Continuum.
When the entire project group is built in the Master, independent projects
(single project or multi-module project) are distributed to a single
- registered Slave.
+ registered Build Agent.
In a project group containing a mix of projects, the distribution of work
goes through the following steps:
@@ -48,16 +48,16 @@
[[2]] Every independent project within the project group is identified,
whether as a single project or a multi-module project. Projects with
inter-dependencies cannot be distributed separately, so multi-module
- projects are delegated to a Slave as one build.
+ projects are delegated to a Build Agent as one build.
[[3]] For each independent project, the Master iterates over the list of
- registered Slaves and queries each if available. The query is an XML-RPC
+ registered Build Agents and queries each if available. The query is an XML-RPC
<<<ping()>>> followed by a <<<getBuildSizeOfAgent()>>> invocation.
[[4]] If there is a Build Agent available, the Master collects the information
- necessary for the build (SCM url, project id, etc.) and passes it when
+ necessary for the build (SCM URL, project id, etc.) and passes it when
invoking <<<buildProjects()>>> to the Build Agent with the smallest number of
- tasks in it's queue.
+ tasks in its queue.
[[5]] In the Build Agent, the build request is processed: the build is queued and
executed. Upon execution, the Build Agent first performs an SCM checkout or an SCM
@@ -69,56 +69,58 @@
[[7]] After the build, the Build Agent returns the complete build result to the
Master by invoking the callback method <<<returnBuildResult()>>>, which the
- Master aggregates to provide a unified view of projects
+ Master aggregates to provide a unified view of projects.
- TODO: insert sequence diagram here
+~~TODO: insert sequence diagram here
* Setup
- * {{{../installation/build-agent.html}Install and Configure}} one or more Build Agents, then
+ * {{{../installation/build-agent.html}Install and Configure}} one or more Build Agents.
- * {{{./configuration.html}Enable}} the Distributed Builds option in the General Configuration, and
+ * {{{./configuration.html}Enable}} the Distributed Builds option in the General Configuration.
* {{{./build-agents.html}Add}} your Build Agents to the Continuum Master.
* {{{./build-agent-groups.html}Add}} your Build Agents to a Build Agent Group.
- * {{{./buildEnvironment.html} Add}} your Build Agent Group to Build Environment.
+ * {{{./buildEnvironment.html} Add}} your Build Agent Group to a Build Environment.
+
+ * Configure a project to use that Build Environment.
* Make sure that the {{{./localRepository.html} local repository}} of the {{{./projectgroup.html} project group}} is properly configured.
- In this case, it should point to the path of the repository where the build agent is installed/running.
+ In this case, it should point to the path of the repository where the Build Agent is installed/running.
[]
- <<WARNING>> Need to have a central remote repository to store the artifacts created from the build agent so that other agents will be able to use the new artifacts.
+ <<Warning:>> You need to have a central remote repository to store the artifacts created from the Build Agent so that other agents will be able to use the new artifacts.
* Limitations
- * only system administrator can enable/disable distributed builds
+ * Only system administrator can enable/disable distributed builds
- * credentials (s.a. svn credentials) are passed along if specified, but if server cache is used it will need to be done individually on the slaves
+ * Credentials (i.e. svn credentials) are passed along if specified, but if server cache is used it will need to be done individually on the Build Agents
- * there is no tracking of scm changes
+ * There is no tracking of SCM changes
- * the Build Agent needs a configuration web interface
+ * The Build Agent needs a configuration web interface
- * all projects in a project group will be distributed to the same build agent
+ * All projects in a project group will be distributed to the same Build Agent
* Future Enhancements
* Remote builders
- * Builders can be installed on remote machines, a Continuum manager will send actions to run to builders. An action can be something to run on all builders, on some of them or eventually only to an available builder if we don't want to run more than one build. Actions can be sent with JMS and builders can apply some filters if they don't want to receive all actions. With that, we can do some parallel builds but the dependency tree must be respected for the build order. To work correctly with dependencies, each builders must use a central local repository. Maybe we can use an internal Archiva.
+ * Builders can be installed on remote machines, a Continuum manager will send actions to run to builders. An action can be something to run on all builders, on some of them or eventually only to an available builder if we don't want to run more than one build. Actions can be sent with JMS and builders can apply some filters if they don't want to receive all actions. With that, we can do some parallel builds but the dependency tree must be respected for the build order. To work correctly with dependencies, each builder must use a central local repository. Maybe we can use an internal Archiva.
- * With Continuum builders configured to receive all commands, users can run multi-platform build for each build definition execution
+ * With Continuum builders configured to receive all commands, users can run multi-platform build for each build definition execution.
- * With Continuum builders configured to receive only some project types, users can use a different builder by project group. In this case, the build of all projects will be done quickly because commands are balanced on few servers
+ * With Continuum builders configured to receive only some project types, users can use a different builder by project group. In this case, the build of all projects will be done quickly because commands are balanced on several servers.
- * With Continuum builders configured to build something when it is available, users can install few builders on several machine to balance the charge. In this case, it will be possible to run some parallel builds.
+ * With Continuum builders configured to build something when it is available, users can install builders on several machine to balance the charge. In this case, it will be possible to run some parallel builds.
- * When the builder work will be done, a message will be sent to the manager to notify the end of the process.
+ * When the builders work is done, a message will be sent to the manager to notify the end of the process.
- * With JMS used for the communication, we can add some listeners to create reports/statistics, log some informations
+ * With JMS used for the communication, we can add some listeners to create reports/statistics, log some information.
* Policy-based distribution
Modified: continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt?rev=912600&r1=912599&r2=912600&view=diff
==============================================================================
--- continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt (original)
+++ continuum/branches/continuum-1.3.x/continuum-docs/src/site/apt/installation/build-agent.apt Mon Feb 22 15:01:10 2010
@@ -2,16 +2,16 @@
Installing and Configuring a Build Agent
------
------
- 2010-01-13
+ 2010-02-22
------
Installing and Configuring a Build Agent
First, {{{http://continuum.apache.org/download.html}download}} the Continuum Build Agent standalone
distribution or webapp.
-
- <<Note>>: It is recommended to use build agents that come with the release of Continuum (Continuum Master) to be used.
- While 1.3.x build agents can be used with 1.4.x Continuum (Continuum Master), using a later version of build agent than the
+
+ <<Note>>: It is recommended to use Build Agents that come with the release of Continuum (Continuum Master) to be used.
+ While 1.3.x Build Agents can be used with 1.4.x Continuum (Continuum Master), using a later version of Build Agent than the
Continuum (Continuum Master) will not work.
* Standalone
@@ -22,7 +22,7 @@
The Build Agent runs on a specific port (defaulting to 8181), so it is possible
to install multiple Build Agents in one machine. It is also possible to
- install Agents in the same machine as the Master. To configure the Build Agent
+ install Build Agents in the same machine as the Master. To configure the Build Agent
to run using a different port, edit the
<<<$CONTINUUM_BUILDAGENT_HOME/conf/jetty.xml>>> file.
@@ -51,9 +51,9 @@
* <<<workingDirectory>>> - similar to the working directory of Continuum
- * <<<continuumServerUrl>>> - the URL pointing to the XML-RPC context of the Master Build Agent
+ * <<<continuumServerUrl>>> - the URL pointing to the XML-RPC context of the Continuum Master
- * <<<installations>>> - a list of the installations available on the build agent, including Maven, Ant, JDK, etc.
+ * <<<installations>>> - a list of the installations available on the Build Agent, including Maven, Ant, JDK, etc.
Note that all of your agents need not be identical, as there is a way to control which agent Continuum chooses by using a
{{{../administrator_guides/build-agent-groups.html}Build Agent Group}}. In addition, you need to {{{../administrator_guides/buildEnvironment.html} configure}}
@@ -69,19 +69,19 @@
or if you are on Windows
+---+
-continuum-buildagent console
+continuum-buildagent.bat console
+---+
Next, enable the <<Distributed Builds>> option in the {{{../administrator_guides/configuration.html}General Configuration}},
- and {{{../administrator_guides/build-agents.html}add the agent}} to the Continuum master server.
+ and {{{../administrator_guides/build-agents.html}add the agent}} to the Continuum Master server.
~~ TODO: Does the Jetty bundle still want CONTINUUM_BUILDAGENT_HOME set?
* Webapp
- The build agent is also available as a web application which you can install into your own container.
+ The Build Agent is also available as a web application which you can install into your own container.
- The build agent needs two things in order to function properly: A <<<CONTINUUM_BUILDAGENT_HOME>>> environment variable,
+ The Build Agent needs two things in order to function properly: A <<<CONTINUUM_BUILDAGENT_HOME>>> environment variable,
and a <<<continuum-buildagent.xml>>> configuration file in <<<$CONTINUUM_BUILDAGENT_HOME/conf>>>.
First, set the environment variable: