THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Page History
...
- 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>) - Compile:
- fix tomcat webapp compilation issue - UnittestsUnit tests:
- fix unittests unit tests so they are more useful during compilation - Deploy and Debug:
- configure tomcat plugin to do tomcat:deploy and tomcat:run, debug - Site/doc generation with maven
...
As with anything, feel free to browse the documentation on maven: This guide is very helpfullhelpful.
What is -SNAPSHOT and why should
...
I care
-SNAPSHOT is a special marker in maven that tell everybody that this particular piece of code is under development and might change at any time. Opposed to a normal versioned release like '4.0.0', a snapshot is never a stable release. Maven will often try to get a more recent version of a SNAPSHOT during compile. A stable release is fixed, once published there is no changing it anymore. Snapshots are normally used to indicate that a build is made of the HEAD or trunk of a project. Later on this page more about releases using maven.
...
- cloud-iControl.jar http://zooi.widodh.nl/cloudstack/build-dep/cloud-iControl.jar
- cloud-manageontap.jar http://zooi.widodh.nl/cloudstack/build-dep/cloud-manageontap.jar
- vmware-vim.jar http://zooi.widodh.nl/cloudstack/build-dep/vmware-vim.jar
- vmware-vim25.jar http://zooi.widodh.nl/cloudstack/build-dep/vmware-vim25.jar
- vmware-apputils.jar http://zooi.widodh.nl/cloudstack/build-dep/vmware-apputils.jar
As of 4.3 you should no longer need to download the following netscaler jars. You may receive an error in the install-non-oss.sh script as it will still look for these files.
- cloud-netscaler.jar, cloud-netscaler-sdx.jar jar http://communityzooi.citrixwidodh.comnl/download/attachments/37847122cloudstack/build-dep/cloud-netscaler-jars.zip
In case of 4.2/master, Min suggests on ML: To build non-oss build, you need to first download Vmware 5.1 SDK fromfrom https://my.vmware.com/group/vmware/get-download?downloadGroup=VSP510-WEBSDK-510 (Version: 5.1, Release-date: 2012-09-10, Build: 774886) to a temp directory. This is a zip file, unzip file and you will see a vim25.jar in <unzip folder>/SDK/vsphere-ws/java/JAXWS/lib. Place this vim25.jar in deps folder and rename it as vim25_51.jar, then run: deps/install-non-oss.sh to install it into your m2 repo.
...
Available profiles | Enabled by property | Requires profiles | Description | ||
|---|---|---|---|---|---|
deps |
|
| Enables a convenience download for all dependencies into the deps directory, usage mvn -P deps -pl deps install | ||
developer |
|
| Enables a convenience pom with developer functions | ||
vmware | noredist | Enables the build of vmware-base and the vmware plugin, requires vmware SDK to be present. See also Hypervisor VMWare. | |||
netapp | noredist | Enables the build of the netapp plugin, requires NetApp manageontap sdk. | |||
f5 | noredist | Enables the build of the f5 plugin, requires f5 iControl library | |||
netscaler | noredist | Enables the build of the netscaler plugin, requires additional libraries. | |||
srx | noredist | Enables the build of the juniper srx plugin, requires additional libraries. | |||
marvin | marvin.config | developer | Allows you to configure cloudstack using a marvin json configuration | ||
Available properties | Required profile | Description | |||
deploydb | developer | Clears and creates the cloud database in the mysql server configured utils/conf/db.properties | |||
noredist |
| Enables all modules that are not part of the standard ASF build | |||
systemvm | systemvm | Enabled the build of the systemvm.iso, requires mkisofs to be available on the commandline | |||
awsapi | awsapi | Enables building of awsapi module along with rest of the CloudStack | |||
simulator | developer | Enables the simulator spring context for running the integration test |
...
Running a server for test/debug purposes.
On One 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).
| Code Block |
|---|
$ export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=500m -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n" |
If you don't export using above configuration, the management server will run with no debugger attached.
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.
| Code Block |
|---|
$ mvn -pl :cloud-client-ui jetty:run
|
To run a noredist management server:
| Code Block |
|---|
$ mvn -pl :cloud-client-ui jetty:run -Dnoredist |
NOTE : In case if BUILD process goes fine but, you are unable to access management server then please make sure that 8080 is opened in iptables.
To run awsapi app
| Code Block |
|---|
$ mvn -Pawsapi -pl :cloud-awsapi jetty:run |
Note: The following is a WIP tomcat-plugin feature, use the above jetty command for now.
For most versions of java on most version of macosx you need to add '-Djava.net.preferIPv4Stack=true' to that so to be on the save side; on macosx
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
$ export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=500m -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n -Djava.net.preferIPv4Stack=true" |
code-Djava.net.preferIPv4Stack=truecode
If you don't export using above configuration, the management server will run with no debugger attached.
On some (macosx) systems you might want to add "-Djava.net.preferIPv4Stack=true". Escpecially when using mixed wired and wireless networks.
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.
| Code Block |
|---|
$ mvn -pl :cloud-client-ui jetty:run
|
To run a noredist management server:
| Code Block |
|---|
$ mvn |
| Code Block |
$ mvn org.apache.tomcat.maven:tomcat7-maven-plugin:2.0:run -pl :cloud-client-ui -amjetty:run -Pclient |
Open the following URL on your browser to access the Management Server UI:
http://localhost:8080/client/
Or,
http://management-server-ip-address:8080/client
The default credentials are; user: admin, password: password and the domain
field should be left blank which is defaulted to the ROOT domain.
Dnoredist |
NOTE : In case if BUILD process goes fine but, you are unable to access management server then please make sure that 8080 is opened in iptables.
To run awsapi app
| Code Block |
|---|
$ mvn -Pawsapi -pl :cloud-awsapi jetty:run |
Note: The following is a WIP tomcat-plugin feature, use the above jetty command for now.
| Code Block |
|---|
$ mvn org.apache.tomcat.maven:tomcat7-maven-plugin:2.0:run -pl :cloud-client-ui -am -Pclient
|
Open the following URL on your browser to access the Management Server UI:
http://localhost:8080/client/
Or,
http://management-server-ip-address:8080/client
The default credentials are; user: admin, password: password and the domain
field should be left blank which is defaulted to the ROOT domain.
| Warning | ||
|---|---|---|
| Warning | ||
| ||
This feature is still being developed and tested, might not work as expected |
...
| Note |
|---|
If you have compiled with additional flags (ex: -Dnoredist), you can get them packaged into the DEB by exporting those flags into the ACS_BUILD_OPTS prior to running dpkg-buildpackage. Example: mvn clean install -P deps -Dnoredist; export ACS_BUILD_OPTS="-Dnoredist"; dpkg-buildpackage or mvn install -P deps -Dnoredist -Dnonoss; export ACS_BUILD_OPTS="-Dnoredist -Dnonoss"; dpkg-buildpackage |
WIPWIP: Package using deb profile (feature under development uses jdeb plugin, in https://github.com/bhaisaab/incubator-cloudstack/tree/debs-maven debs-maven branch):
...
The output file is in ${project.build.directory}/rat.txt, by default in target/rat.txt
...
Code Coverage and Quality checks
| Code Block |
|---|
$ mvn site
|
Versioning / Releases
Update the version number of the project
| Code Block |
|---|
mvn release:update-versions -DautoVersionSubmodules=true -Dnoredist -Pdeps,developer -DdevelopmentVersion=<version>-SNAPSHOT
|
-P developer,systemvm,quality -Dsimulator -Dnoredist clean install clover:aggregate clover:clover
|
The output coverage website is generated at target/site/clover/index.html
Site Generation and Reporting
| Code Block |
|---|
$ mvn site
|
Versioning / Releases
Update the version number of the project
| Code Block |
|---|
mvn release:update-versions -DautoVersionSubmodules=true -Dnoredist -Pdeps,developer -DdevelopmentVersion=<version>-SNAPSHOT
|
Releases can also be done using the release plugin. This plugin will automagically take care of setting the currect version (removing the -SNAPSHOT), making a tag in SCM and deploying the Releases can also be done using the release plugin. This plugin will automagically take care of setting the currect version (removing the -SNAPSHOT), making a tag in SCM and deploying the jars to the maven repository. This should only be executed by the release engineer. Maven assumes that once a version is released it will never change anymore and released binaries will never be updated, so any subsequent releases will have to bump the version number.
...
| Code Block |
|---|
# 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/masterAll/job/build-systemvmsystemvm64-master/lastSuccessfulBuild/artifact/tools/appliance/dist/systemvmtemplate-2013-11-14-master-xen.vhd.bz2 -h xenserver -F systemvm64template-master-4.6.0-xen.vhd.bz2 -h xenserver -F |
Remote debugging
To enable remote debugging on a system go to the cloudstack-management file (for centOS 7 this file can be found under the following path: /etc/default/cloudstack-management).|
Before CS 4.11 (tomcat7)
Add
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5000
To the JAVA_OPTS:
JAVA_OPTS="-Djava.awt.headless=true -Dcom.sun.management.jmxremote=false -Xmx2g -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/var/log/cloudstack/management/ -XX:PermSize=512M -XX:MaxPermSize=800m -Djavax.net.ssl.trustStore=/etc/cloudstack/management/cloud.jks -Djavax.net.ssl.trustStorePassword=vmops.com -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5000 "
Restart your management server (systemctl restart cloudstack-management).
You can now connect your java debugger on port 5000.
From CS 4.11 onwards (jetty):
Add
JAVA_TOOL_OPTIONS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5000"
as a new line.
Restart your management server (systemctl restart cloudstack-management).
You can now connect your java debugger on port 5000.
You can now connect your java debugger on port 5000.
Overview
Content Tools
Apps