Page History

...

Maven uses the notion of a build life-cycle to which plugins can attach. Plugins are similar to Ant tasks. When a Maven build is invoked, we specify a point in the life-cycle up to which the build should proceed. The compile phase comes before test, and test comes before package, and package comes before install. Once we have Maven setup, we can invoke the Struts build, and specify which phase the build should use.

TODOs

1.  Deploydb:
   - see if we can use http://code.google.com/p/flyway/ etc. for database upgrading/migration during development (suggested by John Burwell <jburwell@basho.com>)
2. Compile:
   - fix tomcat webapp compilation issue
3. Unittests:
   - fix unittests so they are more useful during compilation
4. Deploy and Debug:
   - configure tomcat plugin to do tomcat:deploy and tomcat:run, debug
5. Site/doc generation with maven

...

Add following to your .zshrc/.bashrc/.aliasrc:

export M2_HOME=/usr/local/maven
export PATH=${M2_HOME}/bin:${PATH}

*For Windows: *

Right click on my computer and click on Properties
Click on Advanced system settings
Click on Environment Variables
Click on New... under System variables
Add M2_HOME to Variable name and /usr/local/maven to Variable value
Find Path and click Edit...
Add ;%M2_HOME%/bin at the end
Click OK, OK, and close to get out of all the dialogues
Locate a copy of genosimage.exe.  It comes with cygwin and can be copied from %CYGWIN_HOME%\bin
copy %CYGWIN_HOME%\bin\genosimage.exe %SOURCE_HOME%\mkisofs

...

   In Eclipse,

Window -> PreferencesPreferences -> XML -> Editor -> select "Indent using spaces", also set "Indentation size 2 spaces"

...

To debug POMs, read through the effective POM:

$ mvn help:effective-pom

To see how the dependencies are related to the modules:

$ mvn dependency:tree

As with anything, feel free to browse the documentation on maven: This guide is very helpfull.

...

2. Go into the deps directory and run install-non-oss.sh

$ cd deps
$ mv cloud-manageontap.jar manageontap.jar
$ mv vmware-apputils.jar apputils.jar
$ mv vmware-vim.jar vim.jar
$ mv vmware-vim25.jar vim25_51.jar
$ unzip cloud-netscaler-jars.zip
$ ./install-non-oss.sh

...

Running the maven command in the top directory of the CloudStack sources will compile all sources for CloudStack. The resulting jar files will be in the directory target in the subdirectory for a particular module. The default build will have all components that depends on non opensource (non-oss) libraries disabled. If you want to enable this, just add -D noredist to the mvn command line or see the table below for more fine-grained options. The install goal will compile all sources, make war and jar files and add them to your local repository.

The CloudStack build process uses maven profiles. The following table shows the more common profiles that are defined:

...

Note: The following is a WIP feature, use the old Ant command for a complete refresh. This command assumes you have a proper setup in utils/conf/db.properties and the cloud user already exists on your mysql database. If you have a root password, copy db.properties to db.properties.override and put your password there.

$ mvn -P developer -pl developer -Ddeploydb

...

On can use maven to deploy and debug the management server. First export the MAVEN_OPTS variable to open a transport socket on port 8787 (same as before).

$ export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=500m -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n"

...

This will run a jetty server on localhost port 8080 with the management server. Make sure that no other processes are using the port 8080. The default port for tomcat is 8080. You can either shut down tomcat service or switch to another port.

$ mvn -pl :cloud-client-ui jetty:run

...

Note: The following is a WIP tomcat-plugin feature, use the above jetty command for now.

$ mvn org.apache.tomcat.maven:tomcat7-maven-plugin:2.0:run -pl :cloud-client-ui -am -Pclient

...

Use package.sh to build packages for linux systems that use rpms, like RedHat, CentOS and fedora.

$ cd packaging/centos63
$ ./package.sh

Building DEB packages

On Master:

$ mvn install -P deps && dpkg-buildpackage

...

WIP: Package using deb profile (feature under development uses jdeb plugin, in https://github.com/bhaisaab/incubator-cloudstack/tree/debs-maven debs-maven branch):

$ mvn package -P deb

Development with a IDE

...

RAT: ASF License Checking

$ mvn --projects='org.apache.cloudstack:cloudstack' org.apache.rat:apache-rat-plugin:0.10:check

...

Site Generation and Reporting

$ mvn site

Versioning / Releases

Update the version number of the project

mvn release:update-versions -DautoVersionSubmodules=true -Dnoredist -Pdeps,developer -DdevelopmentVersion=<version>-SNAPSHOT

...

Set commandline parameter -o to force maven to only use the local repository. This might trigger build failures if artifacts are not available locally, but might speed up the build process in some cases.

$ mvn -o

• Out of memory error, out of heap space:

// Bash
export MAVEN_OPTS=-Xmx512m
// Windows
set MAVEN_OPTS=-Xmx512m

...

• Create /etc/cloudstack/management/ directory
• Copy your db.properties (or db.properties.override if you have it) to this location
• Run install-sys-tmplt script (if you have a previous systemVM image use -F to force update). You will find the script in your build directory as shown below:

# mkdir -p /etc/cloudstack/management/
# cp ./client/target/cloud-client-ui-4.3.0-SNAPSHOT/WEB-INF/classes/db.properties /etc/cloudstack/management/
# ./client/target/generated-webapp/WEB-INF/classes/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://jenkins.buildacloud.org/view/master/job/build-systemvm-master/lastSuccessfulBuild/artifact/tools/appliance/dist/systemvmtemplate-2013-11-14-master-xen.vhd.bz2 -h xenserver -F