You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@continuum.apache.org by ws...@apache.org on 2009/01/09 20:52:13 UTC
svn commit: r733136 - in
/continuum/branches/continuum-distributed-builds/continuum-docs/src/site:
apt/administrator_guides/ apt/installation/ resources/images/
Author: wsmoak
Date: Fri Jan 9 11:52:12 2009
New Revision: 733136
URL: http://svn.apache.org/viewvc?rev=733136&view=rev
Log:
[CONTINUUM-1666] Initial documentation for distributed builds
Added:
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/build-agents.apt
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/installation/build-agent.apt
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agent-edit.png (with props)
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents-menu.png (with props)
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents.png (with props)
Modified:
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/configuration.apt
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/index.apt
continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/configuration.png
Added: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/build-agents.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/build-agents.apt?rev=733136&view=auto
==============================================================================
--- continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/build-agents.apt (added)
+++ continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/build-agents.apt Fri Jan 9 11:52:12 2009
@@ -0,0 +1,29 @@
+ ------
+ Managing Build Agents
+ ------
+
+Managing Build Agents
+
+ Before this, you may want to enable the Distributed Builds option in the {{{configuration.html}General Configuration}}
+ and {{{../installation/build-agent.html}install a Build Agent}}.
+
+ From the menu, choose the 'Build Agents' item
+
+[../images/build-agents-menu.png] Build Agents Menu
+
+ You will see a list of the existing Build Agents, if any.
+
+[../images/build-agents.png] Build Agents List
+
+ To add a new Build Agent, click the 'Add' button
+
+ To edit an existing Build Agent, click the 'edit' link to the right of the entry.
+
+ You will be prompted to enter or edit the Build Agent URL and Description:
+
+[../images/build-agent-edit.png] Add/Edit Build Agent
+
+ Be sure to enable the agent by checking the 'Enabled' checkbox.
+
+ After you save your changes, verify that 'Enabled' is true. If it is false, most likely Continuum was unable to ping
+ the agent. Consult the log file for additional information.
Modified: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/configuration.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/configuration.apt?rev=733136&r1=733135&r2=733136&view=diff
==============================================================================
--- continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/configuration.apt (original)
+++ continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/configuration.apt Fri Jan 9 11:52:12 2009
@@ -21,10 +21,17 @@
*---------------------------------+------------------------------------------------------+
| Base URL | The base Continuum URL. This URL is used in notifications |
*---------------------------------+------------------------------------------------------+
+| Enable Distributed Builds | When checked, this Continuum instance will delegate all builds to configured agents. |
+*---------------------------------+------------------------------------------------------+
You can modify values or keep defaults then save.
- You'll can modify values at a later time with the following steps:
+ Although Continuum defaults to storing its data within the installation, it is a best practice to separate the
+ installation and data directories.
+
+ These values can be pre-configured in continuum.xml. Make sure that Continuum is not running when editing this file.
+
+ You can modify values at a later time with the following steps:
[[1]] Login to Continuum with an Administrator account
Added: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt?rev=733136&view=auto
==============================================================================
--- continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt (added)
+++ continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/distributed-builds.apt Fri Jan 9 11:52:12 2009
@@ -0,0 +1,25 @@
+ ------------------
+ Distributed Builds
+ ------------------
+
+
+Understanding Distributed Builds
+
+ When the 'Distributed Builds' option in General Configuration is enabled, the Continuum instance will become the
+ Master and will delegate all builds to configured Build Agents.
+
+ There is a one to many relationship between the master and the agents. A master may have many agents, but each
+ agent only has one master.
+
+ Communication happens over XML-RPC, first with the Master contacting an agent to supply the necessary info and invoke
+ a build, and then with the agent later contacting the master to return the build results.
+
+ An agent may be installed on the same server as the master, or on a separate server.
+
+ More than one agent may be installed on a server.
+
+ TODO: When a build is enqueued, the choice of which agent to use is defined by ____.
+
+ TODO: How are multi-module projects handled?
+
+ TODO: How are releases handled?
Modified: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/index.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/index.apt?rev=733136&r1=733135&r2=733136&view=diff
==============================================================================
--- continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/index.apt (original)
+++ continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/administrator_guides/index.apt Fri Jan 9 11:52:12 2009
@@ -18,6 +18,8 @@
* {{{profiles.html}Managing Build Environments}}
+ * {{{build-agents.html}Managing Build Agents}}
+
* {{{schedules.html}Managing Schedules}}
* {{{configuration.html}Managing General Configuration}}
@@ -35,3 +37,5 @@
* {{{builddefTemplate.html}Build Definition Templates}}
* {{{shutdown.html}Shutting Down Continuum}}
+
+ * {{{distributed-builds.html}Distributed Builds}}
\ No newline at end of file
Added: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/installation/build-agent.apt
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/installation/build-agent.apt?rev=733136&view=auto
==============================================================================
--- continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/installation/build-agent.apt (added)
+++ continuum/branches/continuum-distributed-builds/continuum-docs/src/site/apt/installation/build-agent.apt Fri Jan 9 11:52:12 2009
@@ -0,0 +1,52 @@
+
+
+
+Installing a Build Agent
+
+
+ The build agent is available as a web application which you will need to install into a container.
+
+ First, {{{../../download.html}download}} the webapp.
+
+ Next, configure the environment.
+
+ The build agent needs two things in order to function properly: A SLAVE_HOME environment variable, and a
+ continuum-buildagent.xml configuration file in a conf/ directory under $SLAVE_HOME.
+
+ Set the environment variable:
+
+ export SLAVE_HOME=/path/to/slave/home
+
+ or
+
+ set SLAVE_HOME=c:\path\to\slave\home
+
+ Create a directory called 'conf' under [SLAVE_HOME].
+
+ In the 'conf' directory, save the continuum-buildagent.xml file:
+
++--------------+
+<continuum-buildagent-configuration>
+<buildOutputDirectory>/path/to/slave/data/build-output-directory</buildOutputDirectory>
+ <workingDirectory>/path/to/slave/data/working-directory</workingDirectory>
+ <continuumServerUrl>http://builds.example.com:8080/continuum/master-xmlrpc</continuumServerUrl>
+ <installations>
+ <installation>
+ <name>Maven 2 Home</name>
+ <type>maven2</type>
+ <varValue>/Applications/apache-maven-2.0.9</varValue>
+ </installation>
+ </installations>
+</continuum-buildagent-configuration>
++----------------+
+
+ List all of the installations available on the slave, including Maven, Ant, JDK, etc.
+
+ Note that all of your agents need to be identical, as there is no way to control which agent Continuum chooses.
+
+ Finally, drop the webapp into your container, and start it.
+
+ 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.
+
+ TODO: Provide a Jetty bundle for the agent webapp.
\ No newline at end of file
Added: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agent-edit.png
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agent-edit.png?rev=733136&view=auto
==============================================================================
Binary file - no diff available.
Propchange: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agent-edit.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents-menu.png
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents-menu.png?rev=733136&view=auto
==============================================================================
Binary file - no diff available.
Propchange: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents-menu.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents.png
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents.png?rev=733136&view=auto
==============================================================================
Binary file - no diff available.
Propchange: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/build-agents.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/configuration.png
URL: http://svn.apache.org/viewvc/continuum/branches/continuum-distributed-builds/continuum-docs/src/site/resources/images/configuration.png?rev=733136&r1=733135&r2=733136&view=diff
==============================================================================
Binary files - no diff available.