CheatSheet for setting up CloudStack Dev environment on Windows

Step 1) Install Cygwin.

Cygwin will give you a unix like bash shell for your windows.

...

• Cygwin and many utilities do not like spaces in the path.  When asked for the path to install to, use a path such as 'c:\bin\cygwin' or 'c:\cygwin'.
• Please use following mirror for proper download and install

1. http://mirrors.kernel.org
2. http://cygwin.mirrors.hoobly.com

• The install option will download, cache, and install the packages that you have selected.
• The selection of default packages to install is inadequate, because development and common editors are not included.
  • Under 'Devel', select git for 'Install'. Or set the whole 'Develop' category to install. This takes more time, but it is simpler.\
  • Under 'Editors', select vim or emacs depending on which you expect to be available from the Cygwin command line.
  • Under 'Libs', select libsasl2
  • Under 'Net', select ca-certificates and openssh
  • Select Python for 'Install'
  • Under 'Utils', select genisoimage and mkisofs
• Unfortunately, the download can be slow depending on the mirror you select (~30 min or more).

• • Set unnecessary package categories to 'Uninstall', e.g. KDE and Games.
• Once installed, do the following.  This will make sure the maven build can access the two utilities
  • Open a CommandPrompt with admin privileges.
  • cd to the directory where you installed cygwin, i.e. c:\cygwin\bin
  • mklink mkisofs.exe genisoimage.exe
  • mklink python.exe python2.7.exe
  • Run Cygwin
  • Add the following to your /etc/fstab: "none /cyg cygdrive binary,noacl,posix=0,user 0 0".  This line does two things.  Instead of /cygdrive/c to change to a different drive, you type /cyg/c which is much shorter.  It also removes the posix acl semantics which causes problems with the build because the build tries to manipulate file permissions and causes big problems with the Windows file system.
• After completing the install, you can run cygwin setup again to update the packages.  In that case, it will use the packages you last selected as the defaults.

...

• Pick the self-installing executable corresponding to your O/S type (32 or 64bits)
• When asked about the install path, use something that doesn't have space in it.  e.g. c:\bin\Java\jdk1.7.0_25
• Note where you're installing it. Set the Windows System variable JAVA_HOME to this path.
  • I removed the user 'JAVA_HOME' variable to prevent the System variable from being overridden.

Step 3) Install Python 2.7 for Windows

This step can be skipped if you made a symlink to python2.7.exe in the Cygwin installation.  

• Add %JAVA_HOME%\bin to the PATH system variable
  Administrator@cc-svr10 ~

Verify the above by opening a cygwin terminal and using which to discover the location of java and javac. E.g.

$ which java
/cyg/c/bin/Java/jdk1.7.0_25/bin/java

Administrator@cc-svr10 ~
$ which javac
/cyg/c/bin/Java/jdk1.7.0_25/bin/javac

Step 3) Install Python 2.7 for Windows

This step can be skipped if you made a symlink to python2.7.exe in the Cygwin installation.  

CloudStack includes portions of Python code. CloudStack includes portions of Python code. I know you just installed the Cygwin Python but some parts of the maven build process also require a "native" python installation as it won't be able to access the Cygwin installation.

...

For Cygwin, it is easiest to use easy_install or pip (Source)  E.g. .

Administrator@cc-svr10 ~
$ easy_install mysql-connector-python
Searching for mysql-connector-python
Reading http://pypi.python.org/simple/mysql-connector-python/
Best match: mysql-connector-python 1.0.10
Downloading http://cdn.mysql.com/Downloads/Connector-Python/mysql-connector-python-1.0.10.zip
Processing mysql-connector-python-1.0.10.zip
Writing /tmp/easy_install-ZFHHNn/mysql-connector-python-1.0.10/setup.cfg
Running mysql-connector-python-1.0.10/setup.py -q bdist_egg --dist-dir /tmp/easy_install-ZFHHNn/mysql-connector-python-1.0.10/egg-dist-tmp-wICK6D
zip_safe flag not set; analyzing archive contents...
Adding mysql-connector-python 1.0.10 to easy-install.pth file

Installed /usr/lib/python2.7/site-packages/mysql_connector_python-1.0.10-py2.7.egg
Processing dependencies for mysql-connector-python
Finished processing dependencies for mysql-connector-python

...

Generate ssh key in your $HOME directory (the CloudStack Management server will be looking for this at run time)

ssh-keygen -t rsa -q

Step 11) DEPRECATED Install "mkisofs"

Ignore this step if you've already created a symlink under step #1. To check use 'which' to see if mkisofs is already available. E.g.

Administrator@cc-svr10 ~
$ which mkisofs
/usr/bin/mkisofs

Cygwin's mkisofs is a soft link. These do not work with the build.

...

Password is assigned to DBROOTPW= in the build/replace.properties file.

E.g.

$ cat build/override/replace.properties
DBUSER=cloud
DBPW=cloud
DBROOTPW=
MSLOG=vmops.log
APISERVERLOG=api.log
DBHOST=localhost
AGENTLOGDIR=logs
AGENTLOG=logs/agent.log
MSMNTDIR=/mnt
COMPONENTS-SPEC=components-premium.xml

...

To compile Apache CloudStack, go to the cloudstack source folder and run:

mvn install -P developer,systemvm

To deploy the database:

mvn -P developer -pl developer -Ddeploydb

...

1) Problem: Log4j not properly configured

E.g.

log4j:WARN No appenders could be found for logger (org.apache.commons.httpclient.params.DefaultHttpParams).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.

Workaround 1
Change name of config file. e.g.

cp client/target/cloud-client-ui-4.2.0-SNAPSHOT/WEB-INF/classes/log4j{,-cloud}.xml

Workaround 2

Set CATALINA_BASE  e.g. 

export CATALINA_BASE=X:/path/to/dir/contains/conf/log4j-cloud.xml

       X: is the windows disk label  ,  PropertiesUtil will find : CATALINA_HOME or  CATALINA_BASE .

2) Problem: Server will not start and throws following exception

...

Workaround:
This problem can arise when launching the server with too small of a heap. If you are launching using Maven, use MAVEN_OPTS to increase the stack size.

E.g.

export MAVEN_OPTS="-XX:MaxPermSize=256m -Xmx1g"
mvn -pl :cloud-client-ui jetty:run

...

Workaround:
Skip key generation and cloudstack works fine.
This is done by setting developer property in the configuration table as follows, by running the following SQL statement in MySQL

use cloud;
update configuration set value='false' where name='developer';

...

By default system.vm.use.local.storage is set to false. If you want to use local storage, set it to true using the GUI. Alternatively, if the management server has started, you can update the database with the command below:

use cloud;
update configuration set value='true' where name='system.vm.use.local.storage';

You will have to restart the management server if it is running.

5) Problem: Server will not start with Exception in thread Timer-2, Exception in thread Timer-1.

export MAVEN_OPTS="-Xmx2048m -XX:MaxPermSize=800m -Xmx2g -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n"

6) Problem: Eclipse becomes unresponsive with high resource utilization:

Go to Eclipse folder and Change following (towards the end) in .ini configuration file.

. Alternatively, if the management server has started, you can update the database with the command below:

use cloud;
update configuration set value='true' where name='system.vm.use.local.storage';

You will have to restart the management server if it is running.

5) Problem: Server will not start with Exception in thread Timer-2, Exception in thread Timer-1.

export MAVEN_OPTS="-Xmx2048m -XX:MaxPermSize=800m -Xmx2g -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n"

6) Problem: Eclipse becomes unresponsive with high resource utilization:

Go to Eclipse folder and Change following (towards the end) in .ini configuration file.

-vmargs
-Dosgi.requiredJavaVersion=1.5
-Xms384m
-Xmx2048m

7)  Problem : can not find sudo command

 Workaround , create a bash file named as  /bin/sudo with script content :

#!/usr/bin/bash
cygstart --action=runas "$@"

    then chmod +x /bin/sudo 

 -vmargs
-Dosgi.requiredJavaVersion=1.5
-Xms384m
-Xmx2048m