You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

As part of switching to Apache Maven for building CloudStack, the .classpath and .project files used by Eclipse were removed. This page describes how to get CloudStack loaded into an Eclipse workspace. For more details on the actual build process with maven see Building with Maven

Use a Recent Eclipse Build

These steps have been tested with Eclipse Indigo and Eclipse Juno- it's suggested you use that or a newer build.

Start with a clean workspace

To minimize confusion, start with a clean workspace with no other projects.

Install M2E

This wiki page shows how to install the Maven integration for Eclipse plugin. (For those using Yoxos, just search for M2E and add it to your Eclipse build)

After installing the plugin, restart Eclipse.

Import CloudStack

Now you can import CloudStack using the M2E plugin:

  • Go to File->Import...
  • Under Maven select "Existing Maven Projects" and click Next
  • Browse to and select the root directory of the CloudStack source tree. Once selected, Eclipse will scan the source for pom.xml files. Make sure all are selected, then click the Finish button.

Eclipse will import the projects and build the code. At this point you should be able to develop and debug code as usual within Eclipse.

Bonus Track: Running CloudStack Through Eclipse

The Maven integration makes it reasonably easy to run and debug CloudStack through Eclipse. Basically, you can add the 'mvn' command-line calls to your Eclipse Workspace be defining corresponding Run Configurations.

The Maven commands we want to add as Run Configurations are discussed in detail on the Building with Maven page. The steps we want to add can be summarised as

  1. Clean (remove previous versions of source).
  2. Install (build new version of source)
  3. Database Setup (deploy a database with default settings, e.g. default password)
  4. Jetty-based server launch (Jetty is an alternative to Tomcat suited to development)

Now, we could have combined steps 1 & 2 above, but splitting them allows incremental compilation. In contrast, combining them will make for a very slow build.  Also, you only need to setup the database once after doing a Clean.

WRT to debugging: Each time you create a Run Configuration, a duplicate Debug Configuration is created. To debug the server, use the Jetty-based server lauch. You will have to tweak this Debug Configuration for source-level debugging: Use Run -> Debug Configurations, and check the Resolve Workspace Artifacts flag.

Creating a Run Configuration

For each Run Configuration to be added:

  1. From menu bar, select Run -> Run Configurations...
  2. Double click on Maven Build.  This will create a Maven run configuration with the name New_configuration
  3. Update the Name to something corresponding to what happens in the step, and set Base Directory to $project_loc:cloudstack (This tells Eclipse that the base directory for execution is the folder with a _pom.xml_ that has an <artifactId> with the value cloudstack)
  4. From each mvn command, place the -P argument in the Profiles: textbox, Add... any parameters expressed as key=value , and place the remainder of the command in the Goals: textbox.

Maven will download everything needed to run CloudStack with Jetty, build the code, and run the UI. You can connect to it via http://localhost:8080/client.

The following commands were correct at the time of writing.  If they don't work, double check the Building with Maven page, and if you have any compassion update this section of the wiki.

Clean:
 mvn clean

Base directory: $project_loc:cloudstack
Goals: clean install
Profiles: <empty>

Install (i.e. build):
 mvn install

Base directory: $project_loc:cloudstack
Goals: clean install
Profiles: <empty>

Deploy Database (do once after a 'Clean'): mvn install:
 mvn -P developer -pl developer -Ddeploydb=true

Base directory: $project_loc:cloudstack
Goals: -pl developer
Profiles: developer
Parameter Name: deploydb=true

Jetty-based launch (of management server)
 mvn -pl client jetty:run

Base directory: $project_loc:cloudstack
Goals: -pl client jetty:run
Profiles: <empty>

(Optional) launch the jetty based awsapi server:
 mvn -pl awsapi jetty:run

Base directory: $project_loc:cloudstack
Goals: -pl awsapi jetty:run
Profiles: <empty>

  • No labels