You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@continuum.apache.org by br...@apache.org on 2012/12/28 07:45:14 UTC
svn commit: r1426416 - in /continuum/trunk/continuum-docs/src/site: ./
apt/installation/
Author: brett
Date: Fri Dec 28 06:45:13 2012
New Revision: 1426416
URL: http://svn.apache.org/viewvc?rev=1426416&view=rev
Log:
revise installation guides
Added:
continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt.vm (contents, props changed)
- copied, changed from r1426388, continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt
continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt.vm (contents, props changed)
- copied, changed from r1426388, continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt
Removed:
continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt
continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt
Modified:
continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt
continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt
continuum/trunk/continuum-docs/src/site/pdf.xml
continuum/trunk/continuum-docs/src/site/site.xml
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt?rev=1426416&r1=1426415&r2=1426416&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/build-agent.apt Fri Dec 28 06:45:13 2012
@@ -7,17 +7,19 @@
Installing and Configuring a Build Agent
+ Installing a build agent follows a very similar process to the Continuum master installation.
+
First, {{{http://continuum.apache.org/download.html}download}} the Continuum Build Agent standalone
- distribution or webapp.
+ distribution or web application.
- <<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.
+ <<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
The Build Agent is available as a separate standalone Jetty-bundled
- webapp. Installing it is as simple as extracting it to a preferred
+ application. Installing it is as simple as extracting it to a preferred
directory.
The Build Agent runs on a specific port (defaulting to 8181), so it is possible
@@ -53,26 +55,28 @@ Installing and Configuring a Build Agent
</continuum-buildagent-configuration>
+----------------+
- A minimal configuration will have the following fields:
+ The configuration will have the following fields:
+
+ * <<<continuumServerUrl>>> - the URL pointing to the XML-RPC context of the Continuum Master
- * <<<buildOutputDirectory>>> - similar to the build output directory of Continuum
+ * <<<sharedSecretPassword>>> - the pre-shared key (PSK) between master and agent. Copy the PSK that was configured
+ in the Continuum Master configuration file <<<continuum.xml>>> (or corresponding web interface field).
- * <<<workingDirectory>>> - similar to the working directory of Continuum
+ * <<<buildOutputDirectory>>> - similar to the build output directory of Continuum.
- * <<<continuumServerUrl>>> - the URL pointing to the XML-RPC context of the Continuum Master
+ * <<<workingDirectory>>> - similar to the working directory of Continuum
- * <<<installations>>> - a list of the installations available on the Build Agent, including Maven, Ant, JDK, etc.
+ * <<<installations>>> - an optional list of the installations available on the Build Agent, including Maven, Ant,
+ JDK, etc.
- * <<<localRepositories>>> - a list of the local repositories that will be used by the build agent when building and releasing projects.
- The local repository <<<name>>> must match that of the local repository configured in the Continuum Master. This configuration is
- only available in Continuum 1.4.0+ to fix {{{http://jira.codehaus.org/browse/CONTINUUM-2391}CONTINUUM-2391}}.
-
- * <<<sharedSecretPassword>>> - the pre-shared key (PSK) between master and agent. Copy the PSK configured in the Continuum Master
- configuration file <<<continuum.xml>>>.
-
- 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}}
- the Build Environment from the Master in order to specify which installation to use for the build.
+ * <<<localRepositories>>> - an optional list of the local repositories that will be used by the build agent when
+ building and releasing projects. The local repository <<<name>>> must match that of the local repository
+ configured in the Continuum Master. This configuration is only available in Continuum 1.4.0+.
+
+ 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}} the Build Environment from the Master in order to
+ specify which installation to use for the build.
Now start the Build Agent by executing the startup script available in
<<<$CONTINUUM_BUILDAGENT_HOME/bin/>>>. For example:
@@ -89,30 +93,38 @@ continuum-buildagent.bat console
Next, {{{../administrator_guides/build-agents.html}add the agent}} to the Continuum Master server.
- Note that agent will be automatically disabled if the PSK is not configured properly or if the agent is unreachable by the Continuum Master.
+ Note that agent will be automatically disabled if the PSK is not configured properly or if the agent is unreachable by
+ the Continuum Master.
-~~ TODO: Does the Jetty bundle still want CONTINUUM_BUILDAGENT_HOME set?
+ To conclude the installation, you should set it up as a service, following the same instructions as those shown for
+ Continuum for {{{./standalone.html#Installing_as_a_Windows_Service} Windows}} or
+ {{{./standalone.html#Installing_as_a_Linux_Service} Linux}}.
-* Webapp
+* Web Application
- 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. Unlike Continuum
+ itself, you do not need to configure Mail and Databases, so the deployment is much simpler.
- 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>>>.
+ The Build Agent needs the following in order to function properly:
- First, set the environment variable:
+ [[1]] a <<<appserver.base>>> system property
-+---+
-export CONTINUUM_BUILDAGENT_HOME=/path/to/build/agent/home
-+---+
+ [[2]] a <<<continuum-buildagent.xml>>> configuration file in <<<${appserver.base}/conf>>>
- or
+ [[3]] a working area with <<<logs>>> and <<<temp>>> directories
-+---+
-set CONTINUUM_BUILDAGENT_HOME=c:\path\to\build\agent\home
-+---+
+ Set the system property using the recommended method for your application server. An example for Tomcat is shown in
+ the {{{./tomcat.html#Configure_the_appserver.base_Java_system_property} same instructions as those shown for Continuum}}.
+
+ Next, create the <<<continuum-buildagent.xml>>> file as shown in the Standalone section above, and save it in
+ <<<${appserver.base}/conf>>>. You will need to create these directories, as well as <<<${appserver.base}/logs>>> and
+ <<<${appserver.base}/temp>>>.
+
+ Finally, drop the web application into your container, and start it.
+
+* {Installing with Puppet}
- Next, create the <<<continuum-buildagent.xml>>> file as shown above, and save it in <<<$CONTINUUM_BUILDAGENT_HOME/conf>>>.
- You will need to create these directories.
+ As with Continuum, if you use Puppet to manage your infrastructure, and wish to install the standalone build agent,
+ you can use a third-party Puppet module.
- Finally, drop the webapp into your container, and start it.
+ * {{{https://github.com/maestrodev/puppet-continuum} Puppet module for Apache Continuum and Continuum build agents}}
Modified: continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt?rev=1426416&r1=1426415&r2=1426416&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/standalone.apt Fri Dec 28 06:45:13 2012
@@ -10,7 +10,7 @@ Installing Continuum Standalone
~~%{toc|section=0}
-* {Basics & Fundamentals}
+* {Download and Configuration}
* Download the standalone version from the {{{http://continuum.apache.org/download.html} Download page}}
@@ -22,17 +22,37 @@ Installing Continuum Standalone
*** {Mail server configuration}
- Before you start Continuum, you must configure your SMTP configuration for mail notification. The configuration is in <<<$CONTINUUM_HOME/contexts/continuum.xml>>>:
+ Before you start Continuum, you must configure your SMTP configuration for mail notification. In many servers, the
+ default of delivering to localhost with no authentication will be properly relayed. However, if you need to
+ configure a different SMTP server, the configuration is in <<<$CONTINUUM_HOME/contexts/continuum.xml>>>:
%{snippet|id=mail|url=http://svn.apache.org/repos/asf/continuum/trunk/continuum-jetty/src/main/contexts/continuum.xml}
-*** {Databases configuration}
+*** {Database configuration}
- By default, Continuum use an embedded {{{http://db.apache.org/derby}Derby}} database. If you want to use an other database, you can modify the JNDI
- configuration in <<<$CONTINUUM_HOME/contexts/continuum.xml>>>:
+ By default, Continuum use an embedded {{{http://db.apache.org/derby}Derby}} database. If you want to use a different
+ database, you can modify the JNDI configuration in <<<$CONTINUUM_HOME/contexts/continuum.xml>>>:
%{snippet|id=datasources|url=http://svn.apache.org/repos/asf/continuum/trunk/continuum-jetty/src/main/contexts/continuum.xml}
+ Please refer to the documentation for your JDBC driver for the correct settings to use. You may need to alter the
+ <<<validationQuery>>> to one that can successfully execute on your database (or remove the setting if you do not
+ want to validate connections before using them).
+
+ Refer to the {{{http://commons.apache.org/dbcp/} Commons DBCP}} documentation for more advanced configuration of the
+ connection pool.
+
+** Testing the Configuration
+
+ Start Continuum from the console in the <<<$CONTINUUM_HOME/bin/>>> directory:
+
+----
+continuum console
+----
+
+ If it appears to be working correctly, it is a good idea to set it up as a service so that it will run in the
+ background under a suitable role account, and can be set to start whenever the server has started.
+
* {Installing as a Windows Service}
* Go to <<<$CONTINUUM_HOME/bin/>>> and run the following command:
@@ -43,7 +63,7 @@ continuum.bat install
* Edit the <<Apache Continuum>> service
- * To see the services that are on your computer go to Start|Run and enter <<<services.msc>>>.
+ * To see the services that are on your computer go to <Start>|<Run> and enter <<<services.msc>>>.
* Select the <<Startup Type>>
@@ -56,28 +76,21 @@ continuum.bat install
Since the Continuum Linux script <<<bin/continuum>>> understands the same arguments as Linux boot scripts, there is no need to write a particular
startup script to add Continuum to the Linux boot process. All you need to do, as root, is:
-** {Basic script in /etc/init.d}
-
- * Create a <<<continuum>>> file under <<</etc/init.d/>>> with the following content. Replace <<<continuum_user>>> with the name of an account you have already created.
-
------------------
-#!/bin/sh
-
-CONTINUUM_HOME=/opt/continuum-1.3
-su - continuum_user -c "$CONTINUUM_HOME/bin/continuum console $@ &"
+ln -s /usr/local/continuum-[VERSION]/bin/continuum /etc/init.d/continuum
------------------
-** {On a Debian-based system}
+ This will allow you to run <<<service continuum start>>> and other commands.
-------------------
-ln -s /usr/local/continuum-[VERSION]/bin/continuum /etc/init.d/continuum
-------------------
+ To have the service start on boot, follow the instructions below for your particular family of operating system.
+
+** {On a Debian-based system}
- At this point you have Continuum ready to be symlinked from different runlevels. This might sound a bit esoteric, but it is not. You will find these words
- very fast as soon as you start reading about the init process. Fortunately, Debian GNU/Linux comes with a very handy utility to create these links, just run as root:
+ At this point you have Continuum ready to be symlinked from different runlevels. Debian GNU/Linux comes with a very
+ handy utility to create these links, just run as root:
------------------
-update-rc.d -n continuum defaults 80
+update-rc.d continuum defaults 80
------------------
If you run this command, you will see something like this:
@@ -93,66 +106,21 @@ update-rc.d -n continuum defaults 80
/etc/rc5.d/S80continuum -> ../init.d/continuum
------------------
- What you see is the symlinks that would be created. The above command didn't actually create anything because of the -n switch. Remove that switch and run the command again to have the real links created.
+ What you see is the symlinks that would be created.
** {On a RedHat-based system}
- Configuring Continuum on a RedHat-based system (like Fedora Core) is slightly different. Instead of running <<<update-rc.d>>>, you need to add a new
- service using the <<<chkconfig>>> command. In order to add Continuum using <<<chkconfig>>>, it is necessary to add some comments to the <<</etc/rc.d/init.d/continuum>>> script
- and run a couple of commands. These tasks are executed by running the <<<chkconfig_install.sh>>> script below. Note that <<<_continuum_user_>>> needs to be
- replaced by the name of an account you have already created.
-
-------------------
-#! /bin/sh
-#
-# chkconfig_install.sh - install Continuum on a chkconfig-based system
-#
-# Author: Felipe Leme <felipeal at apache.org>
-#
-
-# figure out what's Continuum's directory
-CONTINUUM_HOME=`dirname $0`
-cd ${CONTINUUM_HOME}
-CONTINUUM_HOME=`pwd`
-
-INITD_SCRIPT=/etc/rc.d/init.d/continuum
-
-if [ -f ${INITD_SCRIPT} ]
-then
- echo "File ${INITD_SCRIPT} already exists. Please remove it and try again."
- exit 1
-fi
-
-echo "Creating file ${INITD_SCRIPT}"
-cat >> ${INITD_SCRIPT} <<EOF
-#! /bin/sh
-# chkconfig: 345 90 10
-# description: Apache Continuum server
-
-# uncoment to set JAVA_HOME as the value present when Continuum installed
-#export JAVA_HOME=${JAVA_HOME}
-
-if [ -z "\${JAVA_HOME}" ]
-then
- echo "Cannot manage Continuum without variable JAVA_HOME set"
- echo " (try to set it on file ${INITD_SCRIPT})"
- exit 1
-fi
-# run Continuum as root
-cd ${CONTINUUM_HOME}
-./bin/continuum \$*
-# run Continuum as user _continuum_user_
-#su - _continuum_user_ -c "cd ${CONTINUUM_HOME}; ./bin/continuum \$*"
-EOF
-chmod +x ${INITD_SCRIPT}
+ Configuring Continuum on a RedHat-based system (like Fedora Core) is slightly different. Instead of running
+ <<<update-rc.d>>>, you need to add a new service using the <<<chkconfig>>> command.
-echo "Adding Continuum to chkconfig"
+------------------
chkconfig --add continuum
-
-echo "Enabling Continuum on chkconfig"
chkconfig continuum on
-echo "Continuum set to start on run levels 3, 4 and 5."
-echo "To start Continuum now, run 'service continuum start'"
-
------------------
+* {Installing with Puppet}
+
+ If you use Puppet to manage your infrastructure, you can use a third-party Puppet module to install Continuum. This
+ will take care of adding the required users, databases and configuration based on official release tarballs.
+
+ * {{{https://github.com/maestrodev/puppet-continuum} Puppet module for Apache Continuum and Continuum build agents}}
Copied: continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt.vm (from r1426388, continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt)
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt.vm?p2=continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt.vm&p1=continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt&r1=1426388&r2=1426416&rev=1426416&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt.vm Fri Dec 28 06:45:13 2012
@@ -11,66 +11,65 @@ Guide to Install Continuum on Tomcat
Instructions for installing, deploying, configuring Continuum for the Apache Tomcat web container.
- Sections:
-
~~%{toc|section=0}
-* {Basics & Fundamentals}
+* {Server Configuration}
With every Tomcat version you will need a few things before you can deploy Continuum.
[[1]] Use at least Java JDK 1.5.0_11 to run Tomcat with Continuum.
- [[1]] A defined \<Context\> xml section to define the JNDI resources.
-
- [[1]] The JavaMail / Activation JAR files.
-
- [[1]] The Apache Derby JAR files.
+ [[2]] A defined <<<\<Context\>>>> xml section to define the JNDI resources.
- [[1]] Configure $\{appserver.base\} java property.
+ [[3]] The JavaMail / Activation JAR files.
-** {Defining JNDI Resources}.
+ [[4]] The Apache Derby JAR files.
- Continuum will, on startup, ask the web container for a few JNDI configured resources, two JDBC DataSources, and one JavaMail session.
+ [[5]] Configure <<<$\{appserver.base\}>>> Java system property.
- To configure these JNDI resources in the Tomcat Web Container, you will need to specify a \<Context\> section that Tomcat can utilize for those requests coming from Continuum.
+** {Defining JNDI Resources}
- Tomcat has 3 main ways to accomplish this (ordered by most recommended to least recommended)
+ Continuum will, on startup, ask the web container for a few JNDI configured resources, two JDBC DataSources, and one
+ JavaMail session.
- [[1]] Creating a $CATALINA_HOME/webapps/continuum/META-INF/context.xml containing a \<Context\> element.
+ To configure these JNDI resources in the Tomcat Web Container, you will need to specify a <<<\<Context\>>>> section
+ that Tomcat can utilize for those requests coming from Continuum.
- [[1]] Creating a $CATALINA_HOME/conf/Catalina/localhost/continuum.xml containing a \<Context\> element.
-
- [[1]] Adding a \<Context\> Section into the $CATALINA_HOME/conf/server.xml
+ Tomcat has several ways to accomplish this, with the most practical being to create a
+ <<<$CATALINA_HOME/conf/Catalina/localhost/continuum.xml>>> file containing a <<<\<Context\>>>> element.
The following are the JNDI names you will need to provide:
- * <<<mail/Session>>>
+ * <<<mail/Session>>>
- * <<<jdbc/continuum>>>
+ * <<<jdbc/continuum>>>
- * <<<jdbc/users>>>
+ * <<<jdbc/users>>>
- The individual techniques for describing these resources, and the parameters associated with them are specific to the Tomcat version, resource type, and even JDBC implementation type.
+ The individual techniques for describing these resources, and the parameters associated with them are specific to
+ the Tomcat version, resource type, and even JDBC implementation type.
For the purposes of this document, the following assumptions are made.
- [[1]] You are an Apache Tomcat administrator.
+ [[1]] You are an Apache Tomcat administrator.
- [[1]] You have an SMTP Server on localhost, port 25, with no login / password.
+ [[2]] You have an SMTP Server on localhost, port 25, with no login / password.
- [[1]] You will be using the embedded Apache Derby database. (not an external database, that's another show)
+ [[3]] You will be using the embedded Apache Derby database, rather than an external database.
- [[1]] Details specific to Apache Tomcat, JavaMail, or Apache Derby are left for the reader to research on those projects websites.
+ [[4]] Details specific to Apache Tomcat, JavaMail, or Apache Derby are left for the reader to research on those
+ projects websites.
** {The JavaMail / Activation JAR files}
<<Note:>> Continuum requires JavaMail 1.4 (or later)
Apache Tomcat does not typically ship with a copy of the JavaMail or Activation JAR files.
- In your role as the Apache Tomcat administrator of your installation, you will need to obtain these JAR files and place it into your preferred <<<lib>>> directory.
+ In your role as the Apache Tomcat administrator of your installation, you will need to obtain these JAR files and
+ place it into your preferred <<<lib>>> directory.
- The appropriate lib directory to choose is a personal preference, and we do not encourage or enforce a specific location for it, as all installations of Apache Tomcat are different.
+ The appropriate <<<lib>>> directory to choose is a personal preference, and we do not encourage or enforce a
+ specific location for it, as all installations of Apache Tomcat are different.
For the record, we personally put them in the <<<$CATALINA_HOME/common/lib/>>> directory.
@@ -82,29 +81,27 @@ Guide to Install Continuum on Tomcat
** {The Apache Derby JAR files}
- <<Note:>>Continuum 1.2 has been tested with Apache Derby 10.1.3.1
-
-~~TODO What version of Derby should be used with Continuum 1.3?
+ <<Note:>>Continuum has been tested with Apache Derby 10.1.3.1
- The default installation of Continuum uses the Apache Derby 100% Java database to maintain Continuum-specific information, and also the Users / Security Database.
+ The default installation of Continuum uses the Apache Derby 100% Java database to maintain Continuum-specific
+ information, and also the Users / Security Database.
- You will need to obtain the <<<derby.jar>>> and <<<derbytools.jar>>> and place them into your preferred lib directory.
+ You will need to obtain <<<derby.jar>>> and place it into your preferred <<<lib>>> directory.
We put them into the <<<$CATALINA_HOME/common/lib/>>> directory.
- Direct download links for these JAR files:
-
- * {{{http://repo1.maven.org/maven2/org/apache/derby/derby/10.1.3.1/derby-10.1.3.1.jar}derby-10.1.3.1.jar}}
+ Direct download links for this JAR file:
- * {{{http://repo1.maven.org/maven2/org/apache/derby/derbytools/10.1.3.1/derbytools-10.1.3.1.jar}derbytools-10.1.3.1.jar}}
+ * Derby 10.1.3.1 - {{{http://repo1.maven.org/maven2/org/apache/derby/derby/10.1.3.1/derby-10.1.3.1.jar}derby-10.1.3.1.jar}}
-** {Configure the appserver.base java property}
+** {Configure the appserver.base Java system property}
- The <<<$\{appserver.base\}>>> java property is used by the Continuum internal logging configuration to determine where to output its logs to.
- It is important to define this property either in the <<<$CATALINA_OPTS>>> system environment variable (if Tomcat is being launched via
- the command line) or the service properties (if being launched as a service or daemon).
+ The <<<$\{appserver.base\}>>> system property is used by the Continuum internal logging configuration to determine
+ where to output its logs to. It is important to define this property either in the <<<$CATALINA_OPTS>>> system
+ environment variable (if Tomcat is being launched via the command line) or the service properties (if being launched
+ as a service or daemon).
- The format typically expected is <<<\-Dappserver.base=\<SOMEWHERE\>>>>
+ The format typically expected is <<<\-Dappserver.base=/path/to/continuum-base>>>
You can utilize the <<<$CATALINA_HOME/bin/setenv.sh>>> script to set this value in a Tomcat specific way.
@@ -115,127 +112,12 @@ Guide to Install Continuum on Tomcat
export CATALINA_OPTS="-Dappserver.home=$CATALINA_HOME -Dappserver.base=$CATALINA_HOME"
------------------------------------------
-* {Tomcat 5.0.x Specifics}
-
- Tested on Tomcat v5.0.28.
-
- These instructions explain how to deploy the Continuum 1.2 web application in an existing installation of Tomcat 5.0.x.
-
-~~TODO What about for Continuum 1.3?
-
- <<Extra Jars:>>
-
- * You will need the {{{http://repo1.maven.org/maven2/xalan/xalan/2.7.0/xalan-2.7.0.jar}xalan-2.7.0.jar}} copied into your <<<$CATALINA_HOME/common/lib/>>> directory.
-
- * The Xerces XML Implementation provided in Tomcat 5.0.x is old and will cause problems with Continuum and
- the internal JAXP implementation in JDK 1.5, we recommend that you remove the files in <<<$CATALINA_HOME/common/endorsed/>>>.
-
-------------------------------------------
-<Context path="/continuum" docBase="/path/to/continuum-webapp-1.2.war" debug="0">
-
- <!-- JNDI Datasource for User/Security Database (REQUIRED) -->
- <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource"/>
- <ResourceParams name="jdbc/users">
- <parameter>
- <name>driverClassName</name>
- <value>org.apache.derby.jdbc.EmbeddedDriver</value>
- </parameter>
- <parameter>
- <name>factory</name>
- <value>org.apache.commons.dbcp.BasicDataSourceFactory</value> <!-- Sets up Database Connection Pooling -->
- </parameter>
- <parameter>
- <name>url</name>
- <value>jdbc:derby:database/users;create=true</value> <!-- Adjust path to suit -->
- </parameter>
- <parameter>
- <name>username</name>
- <value>sa</value>
- </parameter>
- <parameter>
- <name>password</name>
- <value></value>
- </parameter>
- </ResourceParams>
-
- <!-- JNDI Datasource for Continuum Database (REQUIRED) -->
- <Resource name="jdbc/continuum" auth="Container" type="javax.sql.DataSource"/>
- <ResourceParams name="jdbc/continuum">
- <parameter>
- <name>driverClassName</name>
- <value>org.apache.derby.jdbc.EmbeddedDriver</value>
- </parameter>
- <parameter>
- <name>factory</name>
- <value>org.apache.commons.dbcp.BasicDataSourceFactory</value> <!-- Sets up Database Connection Pooling -->
- </parameter>
- <parameter>
- <name>url</name>
- <value>jdbc:derby:database/continuum;create=true</value> <!-- Adjust path to suit -->
- </parameter>
- <parameter>
- <name>username</name>
- <value>sa</value>
- </parameter>
- <parameter>
- <name>password</name>
- <value></value>
- </parameter>
- </ResourceParams>
-
- <Resource name="mail/Session" auth="Container" type="javax.mail.Session"/>
- <ResourceParams name="mail/Session">
- <parameter>
- <name>mail.smtp.host</name>
- <value>localhost</value>
- </parameter>
- </ResourceParams>
-</Context>
-------------------------------------------
-
-* {Tomcat 5.5.x Specifics}
-
- Tested on Tomcat v5.5.17 and v5.5.25.
-
- This example \<Context\> assumes technique #2 in the {{{Defining_JNDI_Resources}Define JNDI Resource}} list. (This example lists out the <<<docBase>>> to the WAR file itself.)
-
-------------------------------------------
-<Context path="/continuum"
- docBase="/path/to/continuum-webapp-1.2.war">
-
- <Resource name="jdbc/users"
- auth="Container"
- type="javax.sql.DataSource"
- username="sa"
- password=""
- driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
- url="jdbc:derby:database/users;create=true" />
-
- <Resource name="jdbc/continuum"
- auth="Container"
- type="javax.sql.DataSource"
- username="sa"
- password=""
- driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
- url="jdbc:derby:database/continuum;create=true" />
-
- <Resource name="mail/Session"
- auth="Container"
- type="javax.mail.Session"
- mail.smtp.host="localhost"/>
-</Context>
-------------------------------------------
-
- <<Warning:>> The Tomcat 5.5.20 and 5.5.23 releases are missing MailSessionFactory and a few other classes.
- JNDI mail sessions will <<not>> work. Use Tomcat 5.5.17 or see the workaround on {{{http://issues.apache.org/bugzilla/show_bug.cgi?id=40668}Bug 40668}}.
-
-* {Tomcat 6.0.x Specifics}
+** {Context XML Example}
- Tested on Tomcat v6.0.14.
+ The following context.xml has been tested on Tomcat v5.5.25 and Tomcat v6.0.14.
------------------------------------------
-<Context path="/continuum"
- docBase="/path/to/continuum-webapp-1.2.war">
+<Context path="/continuum" docBase="/path/to/continuum-webapp-${project.version}.war">
<Resource name="jdbc/users"
auth="Container"
Propchange: continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: continuum/trunk/continuum-docs/src/site/apt/installation/tomcat.apt.vm
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Copied: continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt.vm (from r1426388, continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt)
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt.vm?p2=continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt.vm&p1=continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt&r1=1426388&r2=1426416&rev=1426416&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt (original)
+++ continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt.vm Fri Dec 28 06:45:13 2012
@@ -11,106 +11,132 @@ Upgrading Continuum
This document will help you upgrade Continuum from 1.2.x to 1.3.3 and above.
- When upgrading Continuum, it could have some database model changes. Usually these changes will be migrated for you, but in some cases
- you may need to use a backup from the previous version and restore that data into the new version. The Data Management tool exports data from the
- old database model and imports the data into the new database model.
+ When upgrading Continuum, it could have some database model changes. Usually these changes will be migrated for you,
+ but in some cases you may need to use a backup from the previous version and restore that data into the new version.
+ The Data Management tool exports data from the old database model and imports the data into the new database model.
- If you had used the <<<APP_BASE>>> environment variable in Continuum 1.2 to differentiate your configuration from the
- installation, you should rename it to <<<CONTINUUM_BASE>>> in Continuum 1.3.
+ If you had used the <<<APP_BASE>>> environment variable in Continuum 1.2 to differentiate your configuration from
+ the installation, you should rename it to <<<CONTINUUM_BASE>>> in Continuum 1.3.
* Changes to Take Note of in Continuum 1.4.x
- The Jetty version in Continuum 1.4.1 and above has been upgraded to 8.1.7. When upgrading to Continuum 1.4.1 or higher, there is a need to update
- the contents of <<<$CONTINUUM_BASE/conf/wrapper.conf>>> to match the one included in the new distribution if any copies or modifications have been made.
- The <<<jetty.xml>>> format has also changed, and should be re-added from the distribution with any modifications previously made.
- It is no longer read from <<<$CONTINUUM_BASE>>>, and JNDI connections can now be managed via the files in the <<<contexts>>> directory.
+ The Jetty version in Continuum 1.4.1 and above has been upgraded to 8.1.7. When upgrading to Continuum 1.4.1 or
+ higher, there is a need to update the contents of <<<$CONTINUUM_BASE/conf/wrapper.conf>>> to match the one included
+ in the new distribution if any copies or modifications have been made. The <<<jetty.xml>>> format has also changed,
+ and should be re-added from the distribution with any modifications previously made. It is no longer read from
+ <<<$CONTINUUM_BASE>>>, and JNDI connections can now be managed via the files in the <<<contexts>>> directory.
* Changes to Take Note of in Continuum 1.3.x
- The Jetty version in Continuum 1.3.4 and above has been upgraded to 6.1.19. When upgrading to Continuum 1.3.4 or higher, there is a need to update
- the library contents listed in <<<$CONTINUUM_BASE/conf/wrapper.conf>>> with the ones included in the new distribution especially if the
- <<<$CONTINUUM_BASE>>> directory is separate from the installation.
-
- In Continuum 1.3.6, configuration for local repositories in build agents were added. This is used to match the local repository in the build
- agent to that of the local repository (used by the project to be built) set in the master. So if you are upgrading from a lower version,
- you might need to add the <<<localRepositories>>> configuration in your build agent's configuration file. For more details,
- read {{{./build-agent.html}Installing and Configuring a Build Agent}}.
+ The Jetty version in Continuum 1.3.4 and above has been upgraded to 6.1.19. When upgrading to Continuum 1.3.4 or
+ higher, there is a need to update the library contents listed in <<<$CONTINUUM_BASE/conf/wrapper.conf>>> with the
+ ones included in the new distribution especially if the <<<$CONTINUUM_BASE>>> directory is separate from the
+ installation.
+
+ In Continuum 1.3.6, configuration for local repositories in build agents were added. This is used to match the local
+ repository in the build agent to that of the local repository (used by the project to be built) set in the master.
+ So if you are upgrading from a lower version, you might need to add the <<<localRepositories>>> configuration in
+ your build agent's configuration file. For more details, read {{{./build-agent.html}Installing and Configuring a
+ Build Agent}}.
* Using Backup and Restore to upgrade
- There are 2 databases that need to be considered: one for the builds and one for the users.
+ There are 2 databases that need to be considered: one for the builds and one for the users.
- There were no changes in the users database from 1.2.x to 1.3.2, so you can simply point Continuum 1.3.2 at your
- existing user database.
+ While the databases typically auto-upgrade across releases, you may wish to perform an export and import to have
+ full control of the upgrade, make modifications to the data, or retain a backup in case a downgrade is needed.
- The builds database has had model changes, and will need to be exported and imported.
+ First, download the Data Management tools you will need. The tool is a standalone JAR that you can download from
+ the central repo.
- First, download the Data Management tools you will need. The tool is a standalone JAR that you can download from the central repo.
-
- You will need to download two versions of the tool, one for the export out of the old version and one for the import into the new version:
+ You will need to download two versions of the tool, one for the export out of the old version and one for the import
+ into the new version:
<<Note:>> The 1.2, 1.2.2 and 1.2.3 released versions of this tool have a bug.
To export databases from 1.2.2 or 1.2.3, you will need to use version 1.2.3.1 of the tool.
To export databases from 1.2, you may use the 1.1 version of the tool.
- * {{http://repo1.maven.org/maven2/org/apache/continuum/data-management-cli/1.3.2/data-management-cli-1.3.2-app.jar}}
+ * {{{http://repo1.maven.org/maven2/org/apache/continuum/data-management-cli/${project.version}/data-management-cli-${project.version}-app.jar} Data Management CLI for Continuum ${project.version}}}
+
+ * {{{http://repo1.maven.org/maven2/org/apache/continuum/data-management-cli/1.3.8/data-management-cli-1.3.8-app.jar} Data Management CLI for Continuum 1.3.8}}
- * {{http://repo1.maven.org/maven2/org/apache/continuum/data-management-cli/1.2.3.1/data-management-cli-1.2.3.1-app.jar}}
+ * {{{http://repo1.maven.org/maven2/org/apache/continuum/data-management-cli/1.2.3.1/data-management-cli-1.2.3.1-app.jar} Data Management CLI for Continuum 1.2.x}}
- * {{http://repo1.maven.org/maven2/org/apache/maven/continuum/data-management-cli/1.1/data-management-cli-1.1-app.jar}}
+ * {{{http://repo1.maven.org/maven2/org/apache/maven/continuum/data-management-cli/1.1/data-management-cli-1.1-app.jar} Data Management CLI for Continuum 1.1}}
Next, follow these steps to export data from the old version
* Stop the old version of Continuum
- * Execute this command to create the builds.xml export file
+ * Execute this command to create the <<<builds.xml>>> export file
+------------------------------------------+
-java -Xmx512m -jar data-management-cli-1.2.x-app.jar -buildsJdbcUrl jdbc:derby:${old.continuum.home}/data/databases/continuum -mode EXPORT -directory backups
+java -Xmx512m -jar data-management-cli-1.2.3.1-app.jar \
+ -buildsJdbcUrl jdbc:derby:${old.continuum.home}/data/databases/continuum \
+ -mode EXPORT \
+ -directory backups
+------------------------------------------+
Then, follow these steps to import the data to the new version
-
* Start the new version of Continuum to create the new data model, but do not configure it.
* Stop Continuum
- * Execute this command to import the builds data from the xml file you created earlier:
+ * Execute this command to import the builds data from the XML file you created earlier:
+------------------------------------------+
-java -Xmx512m -jar data-management-cli-1.3.2-app.jar -buildsJdbcUrl jdbc:derby:${new.continuum.home}/data/databases/continuum -mode IMPORT -directory backups -strict
+java -Xmx512m -jar data-management-cli-${project.version}-app.jar \
+ -buildsJdbcUrl jdbc:derby:${new.continuum.home}/data/databases/continuum \
+ -mode IMPORT \
+ -directory backups -strict
+------------------------------------------+
- <<Note:>> Remove <<<-strict>>> when importing data from 1.3.1 to 1.3.x to ignore unrecognized tags due to model changes.
+ <<Note:>> Remove <<<-strict>>> when importing data from 1.3.1 to 1.3.x to ignore unrecognized tags due to model
+ changes.
- []
+ Finally, be aware that sometimes the <<<NEXT_VAL>>> values in the <<<SEQUENCE_TABLE>>> need to be adjusted. Before
+ starting Continuum for the first time after the import, connect to the database with a client like
+ {{{http://squirrel-sql.sourceforge.net/}Squirrel SQL}} and check the values in the <<<NEXT_VAL>>> column of the
+ <<<SEQUENCE_TABLE>>>.
- Finally, be aware that sometimes the NEXT_VAL values in the SEQUENCE_TABLE need to be adjusted.
+ Values must be greater than the max ID value in each table. For example, the next value of
+ <<<org.apache.maven.continuum.model.Project>>> must be greater than the greatest ID in <<<Project>>> table.
- * Before starting Continuum for the first time after the import, connect to the db with a client like {{{http://squirrel-sql.sourceforge.net/}Squirrel SQL}} and check the values in the <<NEXT_VAL>> column of the SEQUENCE_TABLE.
+ Here are some example SQL statements. You may need to add or remove lines depending on the contents of your database.
- * Values must be greater than the max id value in each table.
++-----------------------------------------+
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(systemconfiguration_id)+1 from SYSTEMCONFIGURATION)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.system.SystemConfiguration';
- * For example, the next value of "org.apache.maven.continuum.model.Project" must be greater than the greatest id in Project table.
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from BUILDQUEUE)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.BuildQueue';
- * Here are some example SQL statements. You may need to add or remove lines depending on the contents of your database.
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from SCHEDULE)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.Schedule';
-+-----------------------------------------+
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(systemconfiguration_id)+1 from SYSTEMCONFIGURATION) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.system.SystemConfiguration';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from BUILDQUEUE) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.BuildQueue';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from SCHEDULE) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.Schedule';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from BUILDDEFINITION) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.BuildDefinition';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from LOCALREPOSITORY) WHERE SEQUENCE_NAME='org.apache.continuum.model.repository.LocalRepository';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from PROJECTGROUP) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.ProjectGroup';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(scmresult_id)+1 from SCMRESULT) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.scm.ScmResult';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(projectdependency_id)+1 from PROJECTDEPENDENCY) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.ProjectDependency';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from BUILDDEFINITIONTEMPLATE) WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.BuildDefinitionTemplate';
-UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from ABSTRACTPURGECONFIGURATION) WHERE SEQUENCE_NAME='org.apache.continuum.model.repository.AbstractPurgeConfiguration';
-+-----------------------------------------+
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from BUILDDEFINITION)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.BuildDefinition';
- []
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from LOCALREPOSITORY)
+ WHERE SEQUENCE_NAME='org.apache.continuum.model.repository.LocalRepository';
+
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from PROJECTGROUP)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.ProjectGroup';
+
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(scmresult_id)+1 from SCMRESULT)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.scm.ScmResult';
+
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(projectdependency_id)+1 from PROJECTDEPENDENCY)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.ProjectDependency';
+
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from BUILDDEFINITIONTEMPLATE)
+ WHERE SEQUENCE_NAME='org.apache.maven.continuum.model.project.BuildDefinitionTemplate';
+
+UPDATE SEQUENCE_TABLE set NEXT_VAL = (select max(id)+1 from ABSTRACTPURGECONFIGURATION)
+ WHERE SEQUENCE_NAME='org.apache.continuum.model.repository.AbstractPurgeConfiguration';
++-----------------------------------------+
- Now you can start your new version of Continuum.
+ Now you can start your new version of Continuum.
Propchange: continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: continuum/trunk/continuum-docs/src/site/apt/installation/upgrade.apt.vm
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: continuum/trunk/continuum-docs/src/site/pdf.xml
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/pdf.xml?rev=1426416&r1=1426415&r2=1426416&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/pdf.xml (original)
+++ continuum/trunk/continuum-docs/src/site/pdf.xml Fri Dec 28 06:45:13 2012
@@ -33,6 +33,7 @@
<item name="Installing Standalone" ref="installation/standalone.html"/>
<item name="Installing in Tomcat" ref="installation/tomcat.html"/>
<item name="Upgrade" ref="installation/upgrade.html"/>
+ <item name="Installing a Build Agent" ref="installation/build-agent.html"/>
<item name="User's Guides" ref="user_guides/index.html"/>
<item name="Managing Projects" ref="user_guides/managing_project/index.html"/>
Modified: continuum/trunk/continuum-docs/src/site/site.xml
URL: http://svn.apache.org/viewvc/continuum/trunk/continuum-docs/src/site/site.xml?rev=1426416&r1=1426415&r2=1426416&view=diff
==============================================================================
--- continuum/trunk/continuum-docs/src/site/site.xml (original)
+++ continuum/trunk/continuum-docs/src/site/site.xml Fri Dec 28 06:45:13 2012
@@ -33,6 +33,7 @@
<item name="Installing in Tomcat" href="installation/tomcat.html"/>
<item name="Release Notes" href="release-notes.html"/>
<item name="Upgrade" href="installation/upgrade.html"/>
+ <item name="Installing a Build Agent" href="installation/build-agent.html"/>
</item>
<item name="User's Guides" collapse="true" href="user_guides/index.html">